GET api/ReferenceType/{auth}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
auth

string

Required

Body Parameters

None.

Response Information

Resource Description

ReferenceTypeResp
NameDescriptionTypeAdditional information
IsSuccessful

boolean

None.

ErrorMessage

string

None.

ReferenceTypes

Collection of ReferenceTypeItem

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "ReferenceTypes": [
    {
      "ReferenceTypeID": 1,
      "Code": "sample string 2",
      "Name": "sample string 3",
      "FieldLabelInternal": "sample string 4",
      "FieldLabelExternal": "sample string 5",
      "ReferenceGroupGUID": "sample string 6",
      "InsertUserID": 7,
      "InsertDateTime": "2024-12-28T09:25:39.1263149+00:00",
      "DeletedUserID": 1,
      "DeletedDateTime": "2024-12-28T09:25:39.1263149+00:00",
      "ReferenceGroupName": "sample string 9",
      "InsertUserName": "sample string 10",
      "ExcludeFromAlert": true
    },
    {
      "ReferenceTypeID": 1,
      "Code": "sample string 2",
      "Name": "sample string 3",
      "FieldLabelInternal": "sample string 4",
      "FieldLabelExternal": "sample string 5",
      "ReferenceGroupGUID": "sample string 6",
      "InsertUserID": 7,
      "InsertDateTime": "2024-12-28T09:25:39.1263149+00:00",
      "DeletedUserID": 1,
      "DeletedDateTime": "2024-12-28T09:25:39.1263149+00:00",
      "ReferenceGroupName": "sample string 9",
      "InsertUserName": "sample string 10",
      "ExcludeFromAlert": true
    }
  ]
}

application/xml, text/xml

Sample:
<ReferenceTypeResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <ReferenceTypes>
    <ReferenceTypeItem>
      <Code>sample string 2</Code>
      <DeletedDateTime>2024-12-28T09:25:39.1263149+00:00</DeletedDateTime>
      <DeletedUserID>1</DeletedUserID>
      <ExcludeFromAlert>true</ExcludeFromAlert>
      <FieldLabelExternal>sample string 5</FieldLabelExternal>
      <FieldLabelInternal>sample string 4</FieldLabelInternal>
      <InsertDateTime>2024-12-28T09:25:39.1263149+00:00</InsertDateTime>
      <InsertUserID>7</InsertUserID>
      <InsertUserName>sample string 10</InsertUserName>
      <Name>sample string 3</Name>
      <ReferenceGroupGUID>sample string 6</ReferenceGroupGUID>
      <ReferenceGroupName>sample string 9</ReferenceGroupName>
      <ReferenceTypeID>1</ReferenceTypeID>
    </ReferenceTypeItem>
    <ReferenceTypeItem>
      <Code>sample string 2</Code>
      <DeletedDateTime>2024-12-28T09:25:39.1263149+00:00</DeletedDateTime>
      <DeletedUserID>1</DeletedUserID>
      <ExcludeFromAlert>true</ExcludeFromAlert>
      <FieldLabelExternal>sample string 5</FieldLabelExternal>
      <FieldLabelInternal>sample string 4</FieldLabelInternal>
      <InsertDateTime>2024-12-28T09:25:39.1263149+00:00</InsertDateTime>
      <InsertUserID>7</InsertUserID>
      <InsertUserName>sample string 10</InsertUserName>
      <Name>sample string 3</Name>
      <ReferenceGroupGUID>sample string 6</ReferenceGroupGUID>
      <ReferenceGroupName>sample string 9</ReferenceGroupName>
      <ReferenceTypeID>1</ReferenceTypeID>
    </ReferenceTypeItem>
  </ReferenceTypes>
</ReferenceTypeResp>