GET api/ReferenceType/{auth}

Retrieve a list of reference types available to shipper

Request Information

URI Parameters

Name	Description	Type	Additional information
auth	Authorization token	string	Required

Body Parameters

None.

Response Information

Resource Description

ReferenceTypeResp

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.
ReferenceTypes	List of reference types avaialble to shipper	Collection of ReferenceTypeItem	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorMessage": "sample string 2",
  "IsSuccessful": true,
  "ReferenceTypes": [
    {
      "Name": "sample string 2",
      "ReferenceTypeID": 1
    },
    {
      "Name": "sample string 2",
      "ReferenceTypeID": 1
    }
  ]
}

application/xml, text/xml

Sample:

<ReferenceTypeResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <ReferenceTypes>
    <ReferenceTypeItem>
      <Name>sample string 2</Name>
      <ReferenceTypeID>1</ReferenceTypeID>
    </ReferenceTypeItem>
    <ReferenceTypeItem>
      <Name>sample string 2</Name>
      <ReferenceTypeID>1</ReferenceTypeID>
    </ReferenceTypeItem>
  </ReferenceTypes>
</ReferenceTypeResp>