POST api/UserAccounts

Use this method to get a list of accounts available to the shipper user

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
auth	Authorization token	string	None.
ShowBillingAccountsOnly	Return only billing accounts (use for order entry)	boolean	None.
ShowViewAccountsOnly	Return only view accounts (use for active orders, recent deliveries, search orders)	boolean	None.
IncludeAllItemInResponse	Include a blank "All" item in the response (othewise for ALL item pass empty string as AccountNumber)	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "IncludeAllItemInResponse": true,
  "ShowBillingAccountsOnly": true,
  "ShowViewAccountsOnly": true,
  "auth": "sample string 1"
}

application/xml, text/xml

Sample:

<UserAccountParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <IncludeAllItemInResponse>true</IncludeAllItemInResponse>
  <ShowBillingAccountsOnly>true</ShowBillingAccountsOnly>
  <ShowViewAccountsOnly>true</ShowViewAccountsOnly>
  <auth>sample string 1</auth>
</UserAccountParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UserAccountResp

Name	Description	Type	Additional information
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.
Accounts	Listing of accounts assigned to user	Collection of UserAccountItem	None.

Response Formats

application/json, text/json

Sample:

{
  "Accounts": [
    {
      "AccountNumber": "sample string 2",
      "DisplayName": "sample string 4",
      "IsBillable": true,
      "OperationsAlertEmail": "sample string 5",
      "UserAccountRowGUID": "sample string 1",
      "UserID": 3,
      "ViewOrders": true
    },
    {
      "AccountNumber": "sample string 2",
      "DisplayName": "sample string 4",
      "IsBillable": true,
      "OperationsAlertEmail": "sample string 5",
      "UserAccountRowGUID": "sample string 1",
      "UserID": 3,
      "ViewOrders": true
    }
  ],
  "ErrorMessage": "sample string 2",
  "IsSuccessful": true
}

application/xml, text/xml

Sample:

<UserAccountResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <Accounts>
    <UserAccountItem>
      <AccountNumber>sample string 2</AccountNumber>
      <DisplayName>sample string 4</DisplayName>
      <IsBillable>true</IsBillable>
      <OperationsAlertEmail>sample string 5</OperationsAlertEmail>
      <UserAccountRowGUID>sample string 1</UserAccountRowGUID>
      <UserID>3</UserID>
      <ViewOrders>true</ViewOrders>
    </UserAccountItem>
    <UserAccountItem>
      <AccountNumber>sample string 2</AccountNumber>
      <DisplayName>sample string 4</DisplayName>
      <IsBillable>true</IsBillable>
      <OperationsAlertEmail>sample string 5</OperationsAlertEmail>
      <UserAccountRowGUID>sample string 1</UserAccountRowGUID>
      <UserID>3</UserID>
      <ViewOrders>true</ViewOrders>
    </UserAccountItem>
  </Accounts>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</UserAccountResp>