GET api/States

Returns a list of all state lookups defined in your database

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of State

Name	Type	Additional information
StateId	integer	None.
OrganizationId	integer	None.
Name	string	None.
Abbreviation	string	None.
IsActive	boolean	None.
Links	Collection of Link	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "StateId": 1,
    "OrganizationId": 2,
    "Name": "sample string 3",
    "Abbreviation": "sample string 4",
    "IsActive": true,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      }
    ]
  },
  {
    "StateId": 1,
    "OrganizationId": 2,
    "Name": "sample string 3",
    "Abbreviation": "sample string 4",
    "IsActive": true,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfState xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProClassApi.Web.Api.Models">
  <State>
    <Abbreviation>sample string 4</Abbreviation>
    <IsActive>true</IsActive>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
    </Links>
    <Name>sample string 3</Name>
    <OrganizationId>2</OrganizationId>
    <StateId>1</StateId>
  </State>
  <State>
    <Abbreviation>sample string 4</Abbreviation>
    <IsActive>true</IsActive>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
    </Links>
    <Name>sample string 3</Name>
    <OrganizationId>2</OrganizationId>
    <StateId>1</StateId>
  </State>
</ArrayOfState>