GET api/Shipper/GetAccountList/{auth}/{IncludeAllItem}

Use this method to retrieve a list of account number for the user to display in a drop down field

Request Information

URI Parameters

Name	Description	Type	Additional information
auth	Unique authorization identifier	string	Required
IncludeAllItem	Set to "true" to specify including of the "ALL ACCOUNTS" item in the results	boolean	Required

Body Parameters

None.

Response Information

Resource Description

GetAccountListResp

Name	Description	Type	Additional information
IsSuccessful	Set to true if method was successful	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.
Accounts	The list of accounts available to the user	Collection of UserAccountItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Accounts": [
    {
      "Value": "sample string 1",
      "Display": "sample string 2"
    },
    {
      "Value": "sample string 1",
      "Display": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<GetAccountListResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.Shipper">
  <Accounts>
    <UserAccountItem>
      <Display>sample string 2</Display>
      <Value>sample string 1</Value>
    </UserAccountItem>
    <UserAccountItem>
      <Display>sample string 2</Display>
      <Value>sample string 1</Value>
    </UserAccountItem>
  </Accounts>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</GetAccountListResp>