eQuipAPI

Get824RRejectAdvice

Returns an 824R Reject Advice; Requires a valid user to complete this request.

The following routes are available for this service:
GET	/dlms/transactions/824R/{transaction_id}	Returns an 824R Reject Advice

**Get824RRejectAdvice** Parameters:
Name	Parameter	Data Type	Required	Description
UserID	query	Guid	Yes	The UserID that authorizes the caller to complete the request. Contact your eQuip admin.
transaction_id	Path	Guid	Yes	The Id of DlmsTransactionXref.

**DlmsTransactionXref** Parameters:
Name	Parameter	Data Type	Required
TransactionXrefRepository	body	ITransactionXrefRepository<DlmsTransactionXref>	No
ID	body	Guid	No
SourceTransactionType	body	string	No
ApplicationAcknowledgmentCode	body	string	No
ApplicationAcknowledgmentCodeName	body	string	No
ReferenceIdentificationQualifier	body	string	No
ReferenceIdentificationQualifierName	body	string	No
ReferenceIdentification	body	string	No
TransactionSetControlNumber	body	string	No
TransactionSetIdentifierCode	body	string	No
TransactionSetPurposeCode	body	string	No
TransactionSetPurposeName	body	string	No
TransactionTypeCode	body	string	No
TransactionTypeName	body	string	No
ActionCode	body	string	No
IdentifierType	body	string	No
SourceTransactionTypeCode	body	string	No
SourceTransactionSetControlNumber	body	string	No
ReferencedTransactionType	body	string	No
ReferencedTransactionTypeCode	body	string	No
DlmsReferenceIdentifications	body	List<DlmsReferenceIdentification>	No
TechnicalErrors	body	List<DlmsXrefTechnicalError>	No
RejectAdviceCodes	body	List<DlmsXrefRejectAdviceCode>	No
ReferencedTransactions	body	List<DlmsTransactionXref>	No
IdentifyingInformation	body	string	No
SourceTransactionID	body	Guid	No
ReferencedTransactionID	body	Guid?	No
CreatedBy	body	string	No
TransactionXml	body	string	No
TransactionDirection	body	string	No
ProcessedStatus	body	int?	No
Errors	body	string	No
ModifiedBy	body	string	No
IsErrorsToBigToDisplay	body	bool	No
TransactionDateTime	body	DateTime?	No
ReceivedDateTime	body	DateTime?	No
SourceTransactionSetIdentifierCode	body	string	No
SourceTransactionSetPurposeCode	body	string	No
SourceTransactionSetPurposeName	body	string	No
ReferenceTransactionSetIdentifierCode	body	string	No
ReferenceTransactionSetPurposeCode	body	string	No
ReferenceTransactionSetPurposeName	body	string	No
IdentificationID	body	Guid?	No
HasRegenerated	body	bool	No
CreatedDate	body	DateTime?	No

**DlmsReferenceIdentification** Parameters:
Name	Parameter	Data Type	Required
ID	body	Guid	No
RequisitionID	body	Guid	No
IdentificationID	body	Guid	No
ReferenceIdentificationQualifier	body	string	No
ReferenceIdentificationQualifierName	body	string	No
ReferenceIdentification	body	string	No
FreeFormDescription	body	string	No
IdentificationType	body	int	No
ReferenceIdentificationQualifier1	body	string	No
ReferenceIdentificationQualifier1Name	body	string	No
ReferenceIdentification1	body	string	No
ReferenceIdentificationQualifier2	body	string	No
ReferenceIdentificationQualifier2Name	body	string	No
ReferenceIdentification2	body	string	No
ReferenceIdentificationQualifier3	body	string	No
ReferenceIdentificationQualifier3Name	body	string	No
ReferenceIdentification3	body	string	No

**DlmsXrefTechnicalError** Parameters:
Name	Parameter	Data Type	Required
ID	body	Guid	No
DlmsTransactionXrefID	body	Guid	No
Code	body	string	No
Message	body	string	No
Status	body	DlmsXrefTechnicalErrorStatus	No
StatusName	body	string	No
Notes	body	string	No
CreatedBy	body	string	No
ModifiedBy	body	string	No

**DlmsXrefRejectAdviceCode** Parameters:
Name	Parameter	Data Type	Required
ID	body	Guid	No
DlmsTransactionXrefID	body	Guid	No
IndustryCodeQualifier	body	string	No
IndustryCodeQualifierName	body	string	No
IndustryCode	body	string	No
IndustryCodeName	body	string	No
CreatedBy	body	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/Get824RRejectAdvice HTTP/1.1 
Host: equipstage2.e-isg.com 
Content-Type: text/jsv
Content-Length: length

{
	UserID: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	SourceTransactionType: String,
	ApplicationAcknowledgmentCode: String,
	ApplicationAcknowledgmentCodeName: String,
	ReferenceIdentificationQualifier: String,
	ReferenceIdentificationQualifierName: String,
	ReferenceIdentification: String,
	TransactionSetControlNumber: String,
	TransactionSetIdentifierCode: String,
	TransactionSetPurposeCode: String,
	TransactionSetPurposeName: String,
	TransactionTypeCode: String,
	TransactionTypeName: String,
	ActionCode: String,
	IdentifierType: String,
	SourceTransactionTypeCode: String,
	SourceTransactionSetControlNumber: String,
	ReferencedTransactionType: String,
	ReferencedTransactionTypeCode: String,
	DlmsReferenceIdentifications: 
	[
		{
			ReferenceIdentificationQualifier: String,
			ReferenceIdentificationQualifierName: String,
			ReferenceIdentification: String,
			FreeFormDescription: String,
			IdentificationType: 0,
			ReferenceIdentificationQualifier1: String,
			ReferenceIdentificationQualifier1Name: String,
			ReferenceIdentification1: String,
			ReferenceIdentificationQualifier2: String,
			ReferenceIdentificationQualifier2Name: String,
			ReferenceIdentification2: String,
			ReferenceIdentificationQualifier3: String,
			ReferenceIdentificationQualifier3Name: String,
			ReferenceIdentification3: String,
			CreatedBy: String,
			ModifiedBy: String,
			CreatedDate: 0001-01-01,
			ModifiedDate: 0001-01-01
		}
	],
	TechnicalErrors: 
	[
		{
			Code: String,
			Message: String,
			Status: 1,
			StatusName: String,
			Notes: String,
			CreatedBy: String,
			ModifiedBy: String
		}
	],
	RejectAdviceCodes: 
	[
		{
			IndustryCodeQualifier: String,
			IndustryCodeQualifierName: String,
			IndustryCode: String,
			IndustryCodeName: String,
			CreatedBy: String
		}
	],
	ReferencedTransactions: 
	[
		{
			SourceTransactionType: String,
			ApplicationAcknowledgmentCode: String,
			ApplicationAcknowledgmentCodeName: String,
			ReferenceIdentificationQualifier: String,
			ReferenceIdentificationQualifierName: String,
			ReferenceIdentification: String,
			TransactionSetControlNumber: String,
			TransactionSetIdentifierCode: String,
			TransactionSetPurposeCode: String,
			TransactionSetPurposeName: String,
			TransactionTypeCode: String,
			TransactionTypeName: String,
			ActionCode: String,
			IdentifierType: String,
			SourceTransactionTypeCode: String,
			SourceTransactionSetControlNumber: String,
			ReferencedTransactionType: String,
			ReferencedTransactionTypeCode: String,
			DlmsReferenceIdentifications: 
			[
				{
					ReferenceIdentificationQualifier: String,
					ReferenceIdentificationQualifierName: String,
					ReferenceIdentification: String,
					FreeFormDescription: String,
					IdentificationType: 0,
					ReferenceIdentificationQualifier1: String,
					ReferenceIdentificationQualifier1Name: String,
					ReferenceIdentification1: String,
					ReferenceIdentificationQualifier2: String,
					ReferenceIdentificationQualifier2Name: String,
					ReferenceIdentification2: String,
					ReferenceIdentificationQualifier3: String,
					ReferenceIdentificationQualifier3Name: String,
					ReferenceIdentification3: String,
					CreatedBy: String,
					ModifiedBy: String,
					CreatedDate: 0001-01-01,
					ModifiedDate: 0001-01-01
				}
			],
			TechnicalErrors: 
			[
				{
					Code: String,
					Message: String,
					Status: 1,
					StatusName: String,
					Notes: String,
					CreatedBy: String,
					ModifiedBy: String
				}
			],
			RejectAdviceCodes: 
			[
				{
					IndustryCodeQualifier: String,
					IndustryCodeQualifierName: String,
					IndustryCode: String,
					IndustryCodeName: String,
					CreatedBy: String
				}
			],
			ReferencedTransactions: 
			[
				{
					SourceTransactionType: String,
					ApplicationAcknowledgmentCode: String,
					ApplicationAcknowledgmentCodeName: String,
					ReferenceIdentificationQualifier: String,
					ReferenceIdentificationQualifierName: String,
					ReferenceIdentification: String,
					TransactionSetControlNumber: String,
					TransactionSetIdentifierCode: String,
					TransactionSetPurposeCode: String,
					TransactionSetPurposeName: String,
					TransactionTypeCode: String,
					TransactionTypeName: String,
					ActionCode: String,
					IdentifierType: String,
					SourceTransactionTypeCode: String,
					SourceTransactionSetControlNumber: String,
					ReferencedTransactionType: String,
					ReferencedTransactionTypeCode: String,
					DlmsReferenceIdentifications: 
					[
						{
							ReferenceIdentificationQualifier: String,
							ReferenceIdentificationQualifierName: String,
							ReferenceIdentification: String,
							FreeFormDescription: String,
							IdentificationType: 0,
							ReferenceIdentificationQualifier1: String,
							ReferenceIdentificationQualifier1Name: String,
							ReferenceIdentification1: String,
							ReferenceIdentificationQualifier2: String,
							ReferenceIdentificationQualifier2Name: String,
							ReferenceIdentification2: String,
							ReferenceIdentificationQualifier3: String,
							ReferenceIdentificationQualifier3Name: String,
							ReferenceIdentification3: String,
							CreatedBy: String,
							ModifiedBy: String,
							CreatedDate: 0001-01-01,
							ModifiedDate: 0001-01-01
						}
					],
					TechnicalErrors: 
					[
						{
							Code: String,
							Message: String,
							Status: 1,
							StatusName: String,
							Notes: String,
							CreatedBy: String,
							ModifiedBy: String
						}
					],
					RejectAdviceCodes: 
					[
						{
							IndustryCodeQualifier: String,
							IndustryCodeQualifierName: String,
							IndustryCode: String,
							IndustryCodeName: String,
							CreatedBy: String
						}
					],
					ReferencedTransactions: 
					[
						{
							SourceTransactionType: String,
							ApplicationAcknowledgmentCode: String,
							ApplicationAcknowledgmentCodeName: String,
							ReferenceIdentificationQualifier: String,
							ReferenceIdentificationQualifierName: String,
							ReferenceIdentification: String,
							TransactionSetControlNumber: String,
							TransactionSetIdentifierCode: String,
							TransactionSetPurposeCode: String,
							TransactionSetPurposeName: String,
							TransactionTypeCode: String,
							TransactionTypeName: String,
							ActionCode: String,
							IdentifierType: String,
							SourceTransactionTypeCode: String,
							SourceTransactionSetControlNumber: String,
							ReferencedTransactionType: String,
							ReferencedTransactionTypeCode: String,
							DlmsReferenceIdentifications: 
							[
								{
									ReferenceIdentificationQualifier: String,
									ReferenceIdentificationQualifierName: String,
									ReferenceIdentification: String,
									FreeFormDescription: String,
									IdentificationType: 0,
									ReferenceIdentificationQualifier1: String,
									ReferenceIdentificationQualifier1Name: String,
									ReferenceIdentification1: String,
									ReferenceIdentificationQualifier2: String,
									ReferenceIdentificationQualifier2Name: String,
									ReferenceIdentification2: String,
									ReferenceIdentificationQualifier3: String,
									ReferenceIdentificationQualifier3Name: String,
									ReferenceIdentification3: String,
									CreatedBy: String,
									ModifiedBy: String,
									CreatedDate: 0001-01-01,
									ModifiedDate: 0001-01-01
								}
							],
							TechnicalErrors: 
							[
								{
									Code: String,
									Message: String,
									Status: 1,
									StatusName: String,
									Notes: String,
									CreatedBy: String,
									ModifiedBy: String
								}
							],
							RejectAdviceCodes: 
							[
								{
									IndustryCodeQualifier: String,
									IndustryCodeQualifierName: String,
									IndustryCode: String,
									IndustryCodeName: String,
									CreatedBy: String
								}
							],
							IdentifyingInformation: String,
							ReferencedTransactionID: 00000000000000000000000000000000,
							CreatedBy: String,
							TransactionXml: String,
							TransactionDirection: String,
							ProcessedStatus: 0,
							Errors: String,
							ModifiedBy: String,
							IsErrorsToBigToDisplay: False,
							TransactionDateTime: 0001-01-01,
							ReceivedDateTime: 0001-01-01,
							SourceTransactionSetIdentifierCode: String,
							SourceTransactionSetPurposeCode: String,
							SourceTransactionSetPurposeName: String,
							ReferenceTransactionSetIdentifierCode: String,
							ReferenceTransactionSetPurposeCode: String,
							ReferenceTransactionSetPurposeName: String,
							IdentificationID: 00000000000000000000000000000000,
							HasRegenerated: False,
							CreatedDate: 0001-01-01
						}
					],
					IdentifyingInformation: String,
					ReferencedTransactionID: 00000000000000000000000000000000,
					CreatedBy: String,
					TransactionXml: String,
					TransactionDirection: String,
					ProcessedStatus: 0,
					Errors: String,
					ModifiedBy: String,
					IsErrorsToBigToDisplay: False,
					TransactionDateTime: 0001-01-01,
					ReceivedDateTime: 0001-01-01,
					SourceTransactionSetIdentifierCode: String,
					SourceTransactionSetPurposeCode: String,
					SourceTransactionSetPurposeName: String,
					ReferenceTransactionSetIdentifierCode: String,
					ReferenceTransactionSetPurposeCode: String,
					ReferenceTransactionSetPurposeName: String,
					IdentificationID: 00000000000000000000000000000000,
					HasRegenerated: False,
					CreatedDate: 0001-01-01
				}
			],
			IdentifyingInformation: String,
			ReferencedTransactionID: 00000000000000000000000000000000,
			CreatedBy: String,
			TransactionXml: String,
			TransactionDirection: String,
			ProcessedStatus: 0,
			Errors: String,
			ModifiedBy: String,
			IsErrorsToBigToDisplay: False,
			TransactionDateTime: 0001-01-01,
			ReceivedDateTime: 0001-01-01,
			SourceTransactionSetIdentifierCode: String,
			SourceTransactionSetPurposeCode: String,
			SourceTransactionSetPurposeName: String,
			ReferenceTransactionSetIdentifierCode: String,
			ReferenceTransactionSetPurposeCode: String,
			ReferenceTransactionSetPurposeName: String,
			IdentificationID: 00000000000000000000000000000000,
			HasRegenerated: False,
			CreatedDate: 0001-01-01
		}
	],
	IdentifyingInformation: String,
	ReferencedTransactionID: 00000000000000000000000000000000,
	CreatedBy: String,
	TransactionXml: String,
	TransactionDirection: String,
	ProcessedStatus: 0,
	Errors: String,
	ModifiedBy: String,
	IsErrorsToBigToDisplay: False,
	TransactionDateTime: 0001-01-01,
	ReceivedDateTime: 0001-01-01,
	SourceTransactionSetIdentifierCode: String,
	SourceTransactionSetPurposeCode: String,
	SourceTransactionSetPurposeName: String,
	ReferenceTransactionSetIdentifierCode: String,
	ReferenceTransactionSetPurposeCode: String,
	ReferenceTransactionSetPurposeName: String,
	IdentificationID: 00000000000000000000000000000000,
	HasRegenerated: False,
	CreatedDate: 0001-01-01
}