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}
"use strict";
export class GatewayPacketStatus {
    /** @param {{GatewayPacketId?:string,CommunicationStatusId?:string,CommunicationStatus?:string,StatusMessage?:string,PayloadFinalised?:boolean,AlternateKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    GatewayPacketId;
    /** @type {string} */
    CommunicationStatusId;
    /** @type {string} */
    CommunicationStatus;
    /** @type {string} */
    StatusMessage;
    /** @type {?boolean} */
    PayloadFinalised;
    /** @type {string} */
    AlternateKey;
}
export class GetGatewayPacketStatus {
    /** @param {{GatewayPacketId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    GatewayPacketId;
}

JavaScript GetGatewayPacketStatus DTOs

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

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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