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 'package:servicestack/servicestack.dart';

class GatewayPacketStatus implements IConvertible
{
    String? GatewayPacketId;
    String? CommunicationStatusId;
    String? CommunicationStatus;
    String? StatusMessage;
    bool? PayloadFinalised;
    String? AlternateKey;

    GatewayPacketStatus({this.GatewayPacketId,this.CommunicationStatusId,this.CommunicationStatus,this.StatusMessage,this.PayloadFinalised,this.AlternateKey});
    GatewayPacketStatus.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        GatewayPacketId = json['GatewayPacketId'];
        CommunicationStatusId = json['CommunicationStatusId'];
        CommunicationStatus = json['CommunicationStatus'];
        StatusMessage = json['StatusMessage'];
        PayloadFinalised = json['PayloadFinalised'];
        AlternateKey = json['AlternateKey'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'GatewayPacketId': GatewayPacketId,
        'CommunicationStatusId': CommunicationStatusId,
        'CommunicationStatus': CommunicationStatus,
        'StatusMessage': StatusMessage,
        'PayloadFinalised': PayloadFinalised,
        'AlternateKey': AlternateKey
    };

    getTypeName() => "GatewayPacketStatus";
    TypeContext? context = _ctx;
}

/**
* Retrieve GatewayPacket status
*/
// @Api(Description="Retrieve GatewayPacket status")
class GetGatewayPacketStatus implements IConvertible
{
    String? GatewayPacketId;

    GetGatewayPacketStatus({this.GatewayPacketId});
    GetGatewayPacketStatus.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        GatewayPacketId = json['GatewayPacketId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'GatewayPacketId': GatewayPacketId
    };

    getTypeName() => "GetGatewayPacketStatus";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'production_eros_gateway_api_supplierconnect.azurewebsites.net', types: <String, TypeInfo> {
    'GatewayPacketStatus': TypeInfo(TypeOf.Class, create:() => GatewayPacketStatus()),
    'GetGatewayPacketStatus': TypeInfo(TypeOf.Class, create:() => GetGatewayPacketStatus()),
});

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