eQuipAPI

<back to all web services

GenerateDlmsReceiptAcknowledgement

Generates a Dlms 527R Receipt Acknowledgement Transaction set. Requires a valid user to complete the request

The following routes are available for this service:
POST/dlms/transactions/527R/outbound_receipt_acknowledgementsGenerates a Dlms 527R Receipt Acknowledgement Transaction set.
GenerateDlmsReceiptAcknowledgement Parameters:
NameParameterData TypeRequiredDescription
UserIDqueryGuidYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
DocumentNumberbodystringNoDlms conformant Document Number that represents the default transaction identifier to use if the document number is not derivable from other data elements.
TransactionTypeCodebodystringYesTransaction Type Code.
IdentificationIDPathGuidYesThe ID of Dlms Acknowledgement
DoDAACCodeOfAFPMbodystringYesThe DoDAAC Code Of AF PM.
DlmsTransactionIDToRegeneratebodyList<string>NoThe Dlms 824R Transaction ID(s) that contains the lists of parts or assets to regenerate.
SuffixCodebodystringNoDocument Number Suffix Code.
DirectGeneratebodybooleanNoDirect Generate flag for bypass internal site change.
QuantityToAcknowledgebodyintNoQuantity to Acknowledge will be saved.
NotesbodystringNoNotes will be saved.
DlmsOutboundRequest Parameters:
NameParameterData TypeRequiredDescription
DoNotPublishOutboundDocumentqueryboolNoEnable publish later, after all sequences are done.
EventTagqueryGuidNoThe EventTag is used to group related transactions together in a single chain for publishing.

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/oneway/GenerateDlmsReceiptAcknowledgement HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: application/json
Content-Length: length

{"UserID":"String","DocumentNumber":"String","TransactionTypeCode":"String","DoDAACCodeOfAFPM":"String","DlmsTransactionIDToRegenerate":["String"],"SuffixCode":"String","DirectGenerate":false,"QuantityToAcknowledge":0,"Notes":"String","DoNotPublishOutboundDocument":false,"EventTag":"String"}