SupplierConnect Gateway API

GetGatewayPacketStatus

Retrieve GatewayPacket status

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GatewayPacketStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
  <AlternateKey>String</AlternateKey>
  <CommunicationStatus>String</CommunicationStatus>
  <CommunicationStatusId>00000000-0000-0000-0000-000000000000</CommunicationStatusId>
  <GatewayPacketId>00000000-0000-0000-0000-000000000000</GatewayPacketId>
  <PayloadFinalised>false</PayloadFinalised>
  <StatusMessage>String</StatusMessage>
</GatewayPacketStatus>