SupplierConnect Gateway API

GetGatewayPacketStatus

Retrieve GatewayPacket status

The following routes are available for this service:
GET	/api/packet/getstatus/{GatewayPacketId}

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Retrieve GatewayPacket status
    */
    @Api(Description="Retrieve GatewayPacket status")
    public static class GetGatewayPacketStatus
    {
        public UUID GatewayPacketId = null;
        
        public UUID getGatewayPacketId() { return GatewayPacketId; }
        public GetGatewayPacketStatus setGatewayPacketId(UUID value) { this.GatewayPacketId = value; return this; }
    }

    public static class GatewayPacketStatus
    {
        public UUID GatewayPacketId = null;
        public UUID CommunicationStatusId = null;
        public String CommunicationStatus = null;
        public String StatusMessage = null;
        public Boolean PayloadFinalised = null;
        public String AlternateKey = null;
        
        public UUID getGatewayPacketId() { return GatewayPacketId; }
        public GatewayPacketStatus setGatewayPacketId(UUID value) { this.GatewayPacketId = value; return this; }
        public UUID getCommunicationStatusId() { return CommunicationStatusId; }
        public GatewayPacketStatus setCommunicationStatusId(UUID value) { this.CommunicationStatusId = value; return this; }
        public String getCommunicationStatus() { return CommunicationStatus; }
        public GatewayPacketStatus setCommunicationStatus(String value) { this.CommunicationStatus = value; return this; }
        public String getStatusMessage() { return StatusMessage; }
        public GatewayPacketStatus setStatusMessage(String value) { this.StatusMessage = value; return this; }
        public Boolean isPayloadFinalised() { return PayloadFinalised; }
        public GatewayPacketStatus setPayloadFinalised(Boolean value) { this.PayloadFinalised = value; return this; }
        public String getAlternateKey() { return AlternateKey; }
        public GatewayPacketStatus setAlternateKey(String value) { this.AlternateKey = value; return this; }
    }

}

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