GET api/DocumentType/{auth}

Retrieve a list of document types

Request Information

URI Parameters

Name	Description	Type	Additional information
auth	Authorization token	string	Required

Body Parameters

None.

Response Information

Resource Description

DocumentTypeResp

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.
DocumentTypes	List of document types	Collection of DocumentTypeItem	None.

Response Formats

application/json, text/json

Sample:

{
  "DocumentTypes": [
    {
      "Description": "sample string 3",
      "DocumentTypeID": 1,
      "Name": "sample string 2"
    },
    {
      "Description": "sample string 3",
      "DocumentTypeID": 1,
      "Name": "sample string 2"
    }
  ],
  "ErrorMessage": "sample string 2",
  "IsSuccessful": true
}

application/xml, text/xml

Sample:

<DocumentTypeResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <DocumentTypes>
    <DocumentTypeItem>
      <Description>sample string 3</Description>
      <DocumentTypeID>1</DocumentTypeID>
      <Name>sample string 2</Name>
    </DocumentTypeItem>
    <DocumentTypeItem>
      <Description>sample string 3</Description>
      <DocumentTypeID>1</DocumentTypeID>
      <Name>sample string 2</Name>
    </DocumentTypeItem>
  </DocumentTypes>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</DocumentTypeResp>