POST api/getservicestatus

This method returns Carrier Service Statuses

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apikey	Unique Value assigned by an administrator during account setup.	string	None.
username	Username Assigned by an administrator during account setup	string	None.
password	Password Assigned by an administrator during account setup	string	None.
ctoken	Optional Client Token	string	None.

Request Formats

application/xml

Sample:

<GetServiceStatusRequest>
  <apikey>8881BA2F-5FE2-4CF1-D99E-5963J9192806</apikey>
  <ctoken>428d9925-d176-42b3-8c19-5df0d53125f3</ctoken>
  <password>dpassword</password>
  <username>demoapi</username>
</GetServiceStatusRequest>

application/json, text/json

Sample:

{
  "apikey": "8881BA2F-5FE2-4CF1-D99E-5963J9192806",
  "username": "demoapi",
  "password": "dpassword",
  "ctoken": "428d9925-d176-42b3-8c19-5df0d53125f3"
}

application/x-www-form-urlencoded

Sample:

apikey=8881BA2F-5FE2-4CF1-D99E-5963J9192806&ctoken=428d9925-d176-42b3-8c19-5df0d53125f3&password=dpassword&username=demoapi

text/xml

Sample:

<GetServiceStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalRestService.Models">
  <apikey>sample string 1</apikey>
  <ctoken>sample string 4</ctoken>
  <password>sample string 3</password>
  <username>sample string 2</username>
</GetServiceStatusRequest>

Response Information

Resource Description

response

GetServiceStatusResponse

Name	Description	Type	Additional information
carriers	Array of Carrier Service Statuses	Collection of CarrierStatusDTO	None.
ack	A flag indicating success or failure of the web service response back to the client. Default is success.	AcknowledgeType	None.
exceptions	Message back to client. Mostly used when a web service failure occurs.	Collection of ResponseExceptionDto	None.
ctoken	Optional Client Token	string	None.

Response Formats

application/xml

Sample:

<GetServiceStatusResponse>
  <ack>1</ack>
  <ctoken>428d9925-d176-42b3-8c19-5df0d53125f3</ctoken>
  <exceptions />
  <carriers />
</GetServiceStatusResponse>

application/json, text/json

Sample:

{
  "carriers": null,
  "ack": 1,
  "exceptions": null,
  "ctoken": "428d9925-d176-42b3-8c19-5df0d53125f3"
}

text/xml

Sample:

<GetServiceStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalRestService.Models">
  <ack>0</ack>
  <ctoken>sample string 1</ctoken>
  <exceptions>
    <ResponseExceptionDto>
      <errorcode>sample string 1</errorcode>
      <msg>sample string 2</msg>
      <suggestion>sample string 4</suggestion>
      <validationcodes>sample string 3</validationcodes>
      <validationdetails i:nil="true" />
    </ResponseExceptionDto>
    <ResponseExceptionDto>
      <errorcode>sample string 1</errorcode>
      <msg>sample string 2</msg>
      <suggestion>sample string 4</suggestion>
      <validationcodes>sample string 3</validationcodes>
      <validationdetails i:nil="true" />
    </ResponseExceptionDto>
  </exceptions>
  <carriers>
    <CarrierStatusDTO>
      <carriercode>sample string 1</carriercode>
      <carriername>sample string 2</carriername>
      <from>2025-10-01T16:49:37.7189507+00:00</from>
      <ianatz>sample string 7</ianatz>
      <message>sample string 6</message>
      <scac>sample string 3</scac>
      <scacs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </scacs>
      <stscode>sample string 4</stscode>
      <stsdescrip>sample string 5</stsdescrip>
      <to>2025-10-01T16:49:37.7189507+00:00</to>
    </CarrierStatusDTO>
    <CarrierStatusDTO>
      <carriercode>sample string 1</carriercode>
      <carriername>sample string 2</carriername>
      <from>2025-10-01T16:49:37.7189507+00:00</from>
      <ianatz>sample string 7</ianatz>
      <message>sample string 6</message>
      <scac>sample string 3</scac>
      <scacs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </scacs>
      <stscode>sample string 4</stscode>
      <stsdescrip>sample string 5</stsdescrip>
      <to>2025-10-01T16:49:37.7189507+00:00</to>
    </CarrierStatusDTO>
  </carriers>
</GetServiceStatusResponse>