POST {version}/GetStates

Get States

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

Query
NameDescriptionTypeAdditional information
ActiveOnly

boolean

None.

Ids

Collection of globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "ActiveOnly": true,
  "Ids": [
    "03f104bd-df00-4e9b-a5a1-b1d14acc7045",
    "d9e2cee8-f10c-4483-b426-ecec4c299407"
  ]
}

application/xml, text/xml

Sample:
<Query xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <ActiveOnly>true</ActiveOnly>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>03f104bd-df00-4e9b-a5a1-b1d14acc7045</d2p1:guid>
    <d2p1:guid>d9e2cee8-f10c-4483-b426-ecec4c299407</d2p1:guid>
  </Ids>
</Query>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of States

Collection of State
NameDescriptionTypeAdditional information
Abbreviation

string

None.

Name

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Abbreviation": "sample string 1",
    "Name": "sample string 2"
  },
  {
    "Abbreviation": "sample string 1",
    "Name": "sample string 2"
  }
]

application/xml, text/xml

Sample:
<ArrayOfState xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <State>
    <Abbreviation>sample string 1</Abbreviation>
    <Name>sample string 2</Name>
  </State>
  <State>
    <Abbreviation>sample string 1</Abbreviation>
    <Name>sample string 2</Name>
  </State>
</ArrayOfState>