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}
import Foundation
import ServiceStack

/**
* Retrieve GatewayPacket status
*/
// @Api(Description="Retrieve GatewayPacket status")
public class GetGatewayPacketStatus : Codable
{
    public var gatewayPacketId:String

    required public init(){}
}

public class GatewayPacketStatus : Codable
{
    public var gatewayPacketId:String
    public var communicationStatusId:String
    public var communicationStatus:String
    public var statusMessage:String
    public var payloadFinalised:Bool?
    public var alternateKey:String

    required public init(){}
}


Swift 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"}