GET api/v{version}/Configuration/GetStates

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

None.

Response Information

Resource Description

StatesModel
NameDescriptionTypeAdditional information
States

Collection of StateModel

None.

Error

Error

None.

ValidationErrors

Collection of Error

None.

Response Formats

application/json, text/json

Sample:
{
  "States": [
    {
      "ShortName": "sample string 1",
      "FullName": "sample string 2"
    },
    {
      "ShortName": "sample string 1",
      "FullName": "sample string 2"
    }
  ],
  "Error": {
    "Id": "sample string 1",
    "Message": "sample string 2"
  },
  "ValidationErrors": [
    {
      "Id": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "Id": "sample string 1",
      "Message": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<StatesModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/K12.Shared.Models">
  <Error>
    <Id>sample string 1</Id>
    <Message>sample string 2</Message>
  </Error>
  <ValidationErrors>
    <Error>
      <Id>sample string 1</Id>
      <Message>sample string 2</Message>
    </Error>
    <Error>
      <Id>sample string 1</Id>
      <Message>sample string 2</Message>
    </Error>
  </ValidationErrors>
  <States>
    <StateModel>
      <FullName>sample string 2</FullName>
      <ShortName>sample string 1</ShortName>
    </StateModel>
    <StateModel>
      <FullName>sample string 2</FullName>
      <ShortName>sample string 1</ShortName>
    </StateModel>
  </States>
</StatesModel>