GET api/DocumentType/{auth}

Request Information

URI Parameters

Name	Description	Type	Additional information
auth		string	Required

Body Parameters

None.

Response Information

Resource Description

DocumentTypeResp

Name	Type	Additional information
IsSuccessful	boolean	None.
ErrorMessage	string	None.
DocumentTypes	Collection of DocumentTypeItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "DocumentTypes": [
    {
      "DocumentTypeID": 1,
      "CompanyID": 2,
      "Name": "sample string 3",
      "Description": "sample string 4",
      "ForShipment": true,
      "ForCustomer": true,
      "ForCourier": true,
      "ForCarrier": true,
      "InsertUserID": 9,
      "InsertDateTime": "2024-12-28T09:17:54.6533193+00:00",
      "DeletedUserGUID": "sample string 11",
      "DeletedDateTime": "2024-12-28T09:17:54.6533193+00:00",
      "ShipperVisible": true,
      "HideFromAgent": true
    },
    {
      "DocumentTypeID": 1,
      "CompanyID": 2,
      "Name": "sample string 3",
      "Description": "sample string 4",
      "ForShipment": true,
      "ForCustomer": true,
      "ForCourier": true,
      "ForCarrier": true,
      "InsertUserID": 9,
      "InsertDateTime": "2024-12-28T09:17:54.6533193+00:00",
      "DeletedUserGUID": "sample string 11",
      "DeletedDateTime": "2024-12-28T09:17:54.6533193+00:00",
      "ShipperVisible": true,
      "HideFromAgent": true
    }
  ]
}

application/xml, text/xml

Sample:

<DocumentTypeResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <DocumentTypes>
    <DocumentTypeItem>
      <CompanyID>2</CompanyID>
      <DeletedDateTime>2024-12-28T09:17:54.6533193+00:00</DeletedDateTime>
      <DeletedUserGUID>sample string 11</DeletedUserGUID>
      <Description>sample string 4</Description>
      <DocumentTypeID>1</DocumentTypeID>
      <ForCarrier>true</ForCarrier>
      <ForCourier>true</ForCourier>
      <ForCustomer>true</ForCustomer>
      <ForShipment>true</ForShipment>
      <HideFromAgent>true</HideFromAgent>
      <InsertDateTime>2024-12-28T09:17:54.6533193+00:00</InsertDateTime>
      <InsertUserID>9</InsertUserID>
      <Name>sample string 3</Name>
      <ShipperVisible>true</ShipperVisible>
    </DocumentTypeItem>
    <DocumentTypeItem>
      <CompanyID>2</CompanyID>
      <DeletedDateTime>2024-12-28T09:17:54.6533193+00:00</DeletedDateTime>
      <DeletedUserGUID>sample string 11</DeletedUserGUID>
      <Description>sample string 4</Description>
      <DocumentTypeID>1</DocumentTypeID>
      <ForCarrier>true</ForCarrier>
      <ForCourier>true</ForCourier>
      <ForCustomer>true</ForCustomer>
      <ForShipment>true</ForShipment>
      <HideFromAgent>true</HideFromAgent>
      <InsertDateTime>2024-12-28T09:17:54.6533193+00:00</InsertDateTime>
      <InsertUserID>9</InsertUserID>
      <Name>sample string 3</Name>
      <ShipperVisible>true</ShipperVisible>
    </DocumentTypeItem>
  </DocumentTypes>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</DocumentTypeResp>