eQuipAPI

<back to all web services

GenerateOrderStatusReport

Generates Order Status Report; Requires a valid user to complete this request.

The following routes are available for this service:
POST/dlms/transactions/870S/order_status_reportsGenerates Order Status Report
GET/dlms/transactions/870S/order_status_reportsGenerates Order Status Report
GenerateOrderStatusReport Parameters:
NameParameterData TypeRequiredDescription
UserIDqueryGuidYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
ListofTransactionsbodyList<Transactions>YesList of Transaction Ids.
StatusReportCodebodystringYesThe Status Report Code of dlms transactions.
TransactionSetPurposeCodebodystringYesThe Transaction Set Purpose Code of dlms transactions.
OrderOrItemCodebodystringYesThe Order/Item Code of dlms transactions.
TransactionRequestIdbodyGuidYesThe TransactionRequestId of dlms Transactions.
DocumentNumberbodystringNoDlms conformant Document Number that represents the default transaction identifier to use if the document number is not derivable from other data elements.
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.
Transactions Parameters:
NameParameterData TypeRequiredDescription
RequisitionIdPathGuidYesThe Id of requisition.

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/oneway/GenerateOrderStatusReport HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: text/csv
Content-Length: length

{"UserID":"String","ListofTransactions":[{}],"StatusReportCode":"String","TransactionSetPurposeCode":"String","OrderOrItemCode":"String","TransactionRequestId":"String","DocumentNumber":"String","DoNotPublishOutboundDocument":false,"EventTag":"String"}