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}

export class GatewayPacketStatus
{
    public GatewayPacketId: string;
    public CommunicationStatusId: string;
    public CommunicationStatus: string;
    public StatusMessage: string;
    public PayloadFinalised?: boolean;
    public AlternateKey: string;

    public constructor(init?: Partial<GatewayPacketStatus>) { (Object as any).assign(this, init); }
}

/** @description Retrieve GatewayPacket status */
// @Api(Description="Retrieve GatewayPacket status")
export class GetGatewayPacketStatus
{
    public GatewayPacketId: string;

    public constructor(init?: Partial<GetGatewayPacketStatus>) { (Object as any).assign(this, init); }
}

TypeScript 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>