eQuipAPI

<back to all web services

ExtractDlmsCatalogData

Handles the 832N Catalog Data New and Update transactions for inventory management. Requires a valid user to complete this request.

The following routes are available for this service:
GET/dlms/transactions/832N/catalog_entriesProcesses 832N Catalog Data New or Update transactions
ExtractDlmsCatalogData Parameters:
NameParameterData TypeRequiredDescription
UserIDqueryGuidYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
CatalogTypebodystringYesThe CatalogType to identify the request for New, Update.
DodaaccodeOfAfpmbodystringNoThe DoDAAC Code Of AF PM.
DocumentNumberbodystringNoDlms conformant Document Number that represents the default transaction identifier to use if the document number is not derivable from other data elements.
DlmsTransactionIDToRegeneratebodyList<string>NoThe Dlms 824R Transaction ID(s) that contains the lists of parts or assets to regenerate.
SuffixCodebodystringNoDocument Number Suffix Code.
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 .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/ExtractDlmsCatalogData HTTP/1.1 
Host: equipstage2.e-isg.com 
Content-Type: text/csv
Content-Length: length

{"UserID":"String","CatalogType":"String","DodaaccodeOfAfpm":"String","DocumentNumber":"String","DlmsTransactionIDToRegenerate":["String"],"SuffixCode":"String","DoNotPublishOutboundDocument":false,"EventTag":"String"}