SupplierConnect Gateway API

<back to all web services

GetGatewayPacketStatus

Retrieve GatewayPacket status

Requires Authentication
The following routes are available for this service:
GET/api/packet/getstatus/{GatewayPacketId}
GetGatewayPacketStatus Parameters:
NameParameterData TypeRequiredDescription
GatewayPacketIdpathGuidNo
GatewayPacketStatus Parameters:
NameParameterData TypeRequiredDescription
GatewayPacketIdformGuidNo
CommunicationStatusIdformGuidNo
CommunicationStatusformstringNo
StatusMessageformstringNo
PayloadFinalisedformbool?No
AlternateKeyformstringNo

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.

GET /api/packet/getstatus/{GatewayPacketId} HTTP/1.1 
Host: production-eros-gateway-api-supplierconnect.azurewebsites.net 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"CommunicationStatus":"String","StatusMessage":"String","PayloadFinalised":false,"AlternateKey":"String"}