eQuipAPI

<back to all web services

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:
NameParameterData TypeRequiredDescription
UserIDqueryGuidYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
transaction_idPathGuidYesThe Id of DlmsTransactionXref.
DlmsTransactionXref Parameters:
NameParameterData TypeRequiredDescription
TransactionXrefRepositorybodyITransactionXrefRepository<DlmsTransactionXref>No
IDbodyGuidNo
SourceTransactionTypebodystringNo
ApplicationAcknowledgmentCodebodystringNo
ApplicationAcknowledgmentCodeNamebodystringNo
ReferenceIdentificationQualifierbodystringNo
ReferenceIdentificationQualifierNamebodystringNo
ReferenceIdentificationbodystringNo
TransactionSetControlNumberbodystringNo
TransactionSetIdentifierCodebodystringNo
TransactionSetPurposeCodebodystringNo
TransactionSetPurposeNamebodystringNo
TransactionTypeCodebodystringNo
TransactionTypeNamebodystringNo
ActionCodebodystringNo
IdentifierTypebodystringNo
SourceTransactionTypeCodebodystringNo
SourceTransactionSetControlNumberbodystringNo
ReferencedTransactionTypebodystringNo
ReferencedTransactionTypeCodebodystringNo
DlmsReferenceIdentificationsbodyList<DlmsReferenceIdentification>No
TechnicalErrorsbodyList<DlmsXrefTechnicalError>No
RejectAdviceCodesbodyList<DlmsXrefRejectAdviceCode>No
ReferencedTransactionsbodyList<DlmsTransactionXref>No
IdentifyingInformationbodystringNo
SourceTransactionIDbodyGuidNo
ReferencedTransactionIDbodyGuid?No
CreatedBybodystringNo
TransactionXmlbodystringNo
TransactionDirectionbodystringNo
ProcessedStatusbodyint?No
ErrorsbodystringNo
ModifiedBybodystringNo
IsErrorsToBigToDisplaybodyboolNo
TransactionDateTimebodyDateTime?No
ReceivedDateTimebodyDateTime?No
SourceTransactionSetIdentifierCodebodystringNo
SourceTransactionSetPurposeCodebodystringNo
SourceTransactionSetPurposeNamebodystringNo
ReferenceTransactionSetIdentifierCodebodystringNo
ReferenceTransactionSetPurposeCodebodystringNo
ReferenceTransactionSetPurposeNamebodystringNo
IdentificationIDbodyGuid?No
HasRegeneratedbodyboolNo
CreatedDatebodyDateTime?No
DlmsReferenceIdentification Parameters:
NameParameterData TypeRequiredDescription
IDbodyGuidNo
RequisitionIDbodyGuidNo
IdentificationIDbodyGuidNo
ReferenceIdentificationQualifierbodystringNo
ReferenceIdentificationQualifierNamebodystringNo
ReferenceIdentificationbodystringNo
FreeFormDescriptionbodystringNo
IdentificationTypebodyintNo
ReferenceIdentificationQualifier1bodystringNo
ReferenceIdentificationQualifier1NamebodystringNo
ReferenceIdentification1bodystringNo
ReferenceIdentificationQualifier2bodystringNo
ReferenceIdentificationQualifier2NamebodystringNo
ReferenceIdentification2bodystringNo
ReferenceIdentificationQualifier3bodystringNo
ReferenceIdentificationQualifier3NamebodystringNo
ReferenceIdentification3bodystringNo
DlmsXrefTechnicalError Parameters:
NameParameterData TypeRequiredDescription
IDbodyGuidNo
DlmsTransactionXrefIDbodyGuidNo
CodebodystringNo
MessagebodystringNo
StatusbodyDlmsXrefTechnicalErrorStatusNo
StatusNamebodystringNo
NotesbodystringNo
CreatedBybodystringNo
ModifiedBybodystringNo
DlmsXrefRejectAdviceCode Parameters:
NameParameterData TypeRequiredDescription
IDbodyGuidNo
DlmsTransactionXrefIDbodyGuidNo
IndustryCodeQualifierbodystringNo
IndustryCodeQualifierNamebodystringNo
IndustryCodebodystringNo
IndustryCodeNamebodystringNo
CreatedBybodystringNo

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

HTTP + CSV

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

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

{"UserID":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
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":"\/Date(-62135596800000-0000)\/","ModifiedDate":"\/Date(-62135596800000-0000)\/"}],"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":"\/Date(-62135596800000-0000)\/","ModifiedDate":"\/Date(-62135596800000-0000)\/"}],"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":"\/Date(-62135596800000-0000)\/","ModifiedDate":"\/Date(-62135596800000-0000)\/"}],"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":"\/Date(-62135596800000-0000)\/","ModifiedDate":"\/Date(-62135596800000-0000)\/"}],"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":"\/Date(-62135596800000)\/","ReceivedDateTime":"\/Date(-62135596800000)\/","SourceTransactionSetIdentifierCode":"String","SourceTransactionSetPurposeCode":"String","SourceTransactionSetPurposeName":"String","ReferenceTransactionSetIdentifierCode":"String","ReferenceTransactionSetPurposeCode":"String","ReferenceTransactionSetPurposeName":"String","IdentificationID":"00000000000000000000000000000000","HasRegenerated":false,"CreatedDate":"\/Date(-62135596800000)\/"}],"IdentifyingInformation":"String","ReferencedTransactionID":"00000000000000000000000000000000","CreatedBy":"String","TransactionXml":"String","TransactionDirection":"String","ProcessedStatus":0,"Errors":"String","ModifiedBy":"String","IsErrorsToBigToDisplay":false,"TransactionDateTime":"\/Date(-62135596800000)\/","ReceivedDateTime":"\/Date(-62135596800000)\/","SourceTransactionSetIdentifierCode":"String","SourceTransactionSetPurposeCode":"String","SourceTransactionSetPurposeName":"String","ReferenceTransactionSetIdentifierCode":"String","ReferenceTransactionSetPurposeCode":"String","ReferenceTransactionSetPurposeName":"String","IdentificationID":"00000000000000000000000000000000","HasRegenerated":false,"CreatedDate":"\/Date(-62135596800000)\/"}],"IdentifyingInformation":"String","ReferencedTransactionID":"00000000000000000000000000000000","CreatedBy":"String","TransactionXml":"String","TransactionDirection":"String","ProcessedStatus":0,"Errors":"String","ModifiedBy":"String","IsErrorsToBigToDisplay":false,"TransactionDateTime":"\/Date(-62135596800000)\/","ReceivedDateTime":"\/Date(-62135596800000)\/","SourceTransactionSetIdentifierCode":"String","SourceTransactionSetPurposeCode":"String","SourceTransactionSetPurposeName":"String","ReferenceTransactionSetIdentifierCode":"String","ReferenceTransactionSetPurposeCode":"String","ReferenceTransactionSetPurposeName":"String","IdentificationID":"00000000000000000000000000000000","HasRegenerated":false,"CreatedDate":"\/Date(-62135596800000)\/"}],"IdentifyingInformation":"String","ReferencedTransactionID":"00000000000000000000000000000000","CreatedBy":"String","TransactionXml":"String","TransactionDirection":"String","ProcessedStatus":0,"Errors":"String","ModifiedBy":"String","IsErrorsToBigToDisplay":false,"TransactionDateTime":"\/Date(-62135596800000)\/","ReceivedDateTime":"\/Date(-62135596800000)\/","SourceTransactionSetIdentifierCode":"String","SourceTransactionSetPurposeCode":"String","SourceTransactionSetPurposeName":"String","ReferenceTransactionSetIdentifierCode":"String","ReferenceTransactionSetPurposeCode":"String","ReferenceTransactionSetPurposeName":"String","IdentificationID":"00000000000000000000000000000000","HasRegenerated":false,"CreatedDate":"\/Date(-62135596800000)\/"}