POST api/efs/getbalance/{token}

Request Information

URI Parameters

Name	Description	Type	Additional information
token		string	Required

Body Parameters

Collection of integer

Request Formats

application/json, text/json

Sample:

[
  1,
  2
]

application/xml, text/xml

Sample:

<ArrayOfint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <int>1</int>
  <int>2</int>
</ArrayOfint>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Int32[]'.

Response Information

Resource Description

EFSChildCarrierResponseDTO

Name	Description	Type	Additional information
requestStatus		EFSRequestStatusDTO	None.
childCarriers		Collection of EFSChildCarrierDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "requestStatus": {
    "code": "sample string 1",
    "description": "sample string 2",
    "stackTrace": "sample string 3"
  },
  "childCarriers": [
    {
      "carrierId": 1,
      "vendorId": "sample string 2",
      "createDate": "2024-09-19T10:19:50.7915242-05:00",
      "contracts": [
        {
          "contractId": 1,
          "description": "sample string 2",
          "balance": 3.1
        },
        {
          "contractId": 1,
          "description": "sample string 2",
          "balance": 3.1
        }
      ]
    },
    {
      "carrierId": 1,
      "vendorId": "sample string 2",
      "createDate": "2024-09-19T10:19:50.7915242-05:00",
      "contracts": [
        {
          "contractId": 1,
          "description": "sample string 2",
          "balance": 3.1
        },
        {
          "contractId": 1,
          "description": "sample string 2",
          "balance": 3.1
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<EFSChildCarrierResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.DTO">
  <childCarriers>
    <EFSChildCarrierDTO>
      <carrierId>1</carrierId>
      <contracts>
        <EFSCarrierContractDTO>
          <balance>3.1</balance>
          <contractId>1</contractId>
          <description>sample string 2</description>
        </EFSCarrierContractDTO>
        <EFSCarrierContractDTO>
          <balance>3.1</balance>
          <contractId>1</contractId>
          <description>sample string 2</description>
        </EFSCarrierContractDTO>
      </contracts>
      <createDate>2024-09-19T10:19:50.7915242-05:00</createDate>
      <vendorId>sample string 2</vendorId>
    </EFSChildCarrierDTO>
    <EFSChildCarrierDTO>
      <carrierId>1</carrierId>
      <contracts>
        <EFSCarrierContractDTO>
          <balance>3.1</balance>
          <contractId>1</contractId>
          <description>sample string 2</description>
        </EFSCarrierContractDTO>
        <EFSCarrierContractDTO>
          <balance>3.1</balance>
          <contractId>1</contractId>
          <description>sample string 2</description>
        </EFSCarrierContractDTO>
      </contracts>
      <createDate>2024-09-19T10:19:50.7915242-05:00</createDate>
      <vendorId>sample string 2</vendorId>
    </EFSChildCarrierDTO>
  </childCarriers>
  <requestStatus>
    <code>sample string 1</code>
    <description>sample string 2</description>
    <stackTrace>sample string 3</stackTrace>
  </requestStatus>
</EFSChildCarrierResponseDTO>