GET ClassificationType/GetClassificationType?classificationType={classificationType}

Returns a list of Classifications of the requested type.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
classificationType

The Type of Classifications to Return.

ClassificationTypes

Required

Body Parameters

Response Information

Resource Description

Returns a list of Classifications of the requested type.

AgvClassificationType
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

string
Count

Number of Classifications returned.

string
ClassificationTypes

List of Properties and Values returned for each Classification.

Collection of ClsMasterClassNames

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "ClassificationTypes": [
    {
      "ClassificationKey": 5,
      "ClassificationName": "sample string 6",
      "ClassificationType": "sample string 7",
      "QuickSelect": true
    },
    {
      "ClassificationKey": 5,
      "ClassificationName": "sample string 6",
      "ClassificationType": "sample string 7",
      "QuickSelect": true
    }
  ]
}

application/xml, text/xml

Sample:
<AgvClassificationType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.General">
  <ClassificationTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI">
    <d2p1:ClassificationType>
      <d2p1:ClassificationKey>5</d2p1:ClassificationKey>
      <d2p1:ClassificationName>sample string 6</d2p1:ClassificationName>
      <d2p1:ClassificationType>sample string 7</d2p1:ClassificationType>
      <d2p1:QuickSelect>true</d2p1:QuickSelect>
    </d2p1:ClassificationType>
    <d2p1:ClassificationType>
      <d2p1:ClassificationKey>5</d2p1:ClassificationKey>
      <d2p1:ClassificationName>sample string 6</d2p1:ClassificationName>
      <d2p1:ClassificationType>sample string 7</d2p1:ClassificationType>
      <d2p1:QuickSelect>true</d2p1:QuickSelect>
    </d2p1:ClassificationType>
  </ClassificationTypes>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvClassificationType>