GET api/CountriesStates

Returns lists of all Countries and States/Provinces.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

CountriesStatesResult object

ApiSuccessOfCountriesStatesResult
NameDescriptionTypeAdditional information
Success

boolean
Data

CountriesStatesResult

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Data": {
    "Countries": [
      {
        "Id": 1,
        "Description": "sample string 2",
        "ShortDescription": "sample string 3",
        "UseState": true,
        "Inactive": true,
        "IsoAlpha3Code": "sample string 6",
        "IsoAlpha2Code": "sample string 7"
      },
      {
        "Id": 1,
        "Description": "sample string 2",
        "ShortDescription": "sample string 3",
        "UseState": true,
        "Inactive": true,
        "IsoAlpha3Code": "sample string 6",
        "IsoAlpha2Code": "sample string 7"
      }
    ],
    "States": [
      {
        "Id": "sample string 1",
        "Description": "sample string 2",
        "Country": 3,
        "Inactive": true,
        "StateCode": "sample string 5"
      },
      {
        "Id": "sample string 1",
        "Description": "sample string 2",
        "Country": 3,
        "Inactive": true,
        "StateCode": "sample string 5"
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<ApiSuccessOfCountriesStatesResultjDjzYIbp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Reference">
    <d2p1:Countries>
      <d2p1:Country>
        <d2p1:Description>sample string 2</d2p1:Description>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Inactive>true</d2p1:Inactive>
        <d2p1:IsoAlpha2Code>sample string 7</d2p1:IsoAlpha2Code>
        <d2p1:IsoAlpha3Code>sample string 6</d2p1:IsoAlpha3Code>
        <d2p1:ShortDescription>sample string 3</d2p1:ShortDescription>
        <d2p1:UseState>true</d2p1:UseState>
      </d2p1:Country>
      <d2p1:Country>
        <d2p1:Description>sample string 2</d2p1:Description>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Inactive>true</d2p1:Inactive>
        <d2p1:IsoAlpha2Code>sample string 7</d2p1:IsoAlpha2Code>
        <d2p1:IsoAlpha3Code>sample string 6</d2p1:IsoAlpha3Code>
        <d2p1:ShortDescription>sample string 3</d2p1:ShortDescription>
        <d2p1:UseState>true</d2p1:UseState>
      </d2p1:Country>
    </d2p1:Countries>
    <d2p1:States>
      <d2p1:State>
        <d2p1:Country>3</d2p1:Country>
        <d2p1:Description>sample string 2</d2p1:Description>
        <d2p1:Id>sample string 1</d2p1:Id>
        <d2p1:Inactive>true</d2p1:Inactive>
        <d2p1:StateCode>sample string 5</d2p1:StateCode>
      </d2p1:State>
      <d2p1:State>
        <d2p1:Country>3</d2p1:Country>
        <d2p1:Description>sample string 2</d2p1:Description>
        <d2p1:Id>sample string 1</d2p1:Id>
        <d2p1:Inactive>true</d2p1:Inactive>
        <d2p1:StateCode>sample string 5</d2p1:StateCode>
      </d2p1:State>
    </d2p1:States>
  </Data>
</ApiSuccessOfCountriesStatesResultjDjzYIbp>