GET api/bv1/Country?country={country}

Documentation for 'GetCountryByName'.

Request Information

Parameters

NameDescriptionAdditional information
country
Documentation for 'country'.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
[
  {
    "CountryID": 1,
    "CountryFull": "sample string 2",
    "CountryAbrev": "sample string 3",
    "CountryFlag": "sample string 4",
    "IsActive": true,
    "Provinces": [
      {
        "StateProvID": 1,
        "StateProvAbrev": "sample string 2",
        "StateProvFull": "sample string 3",
        "IsActive": true,
        "CountryID": 1
      },
      {
        "StateProvID": 1,
        "StateProvAbrev": "sample string 2",
        "StateProvFull": "sample string 3",
        "IsActive": true,
        "CountryID": 1
      },
      {
        "StateProvID": 1,
        "StateProvAbrev": "sample string 2",
        "StateProvFull": "sample string 3",
        "IsActive": true,
        "CountryID": 1
      }
    ],
    "ProvinceCount": 5
  },
  {
    "CountryID": 1,
    "CountryFull": "sample string 2",
    "CountryAbrev": "sample string 3",
    "CountryFlag": "sample string 4",
    "IsActive": true,
    "Provinces": [
      {
        "StateProvID": 1,
        "StateProvAbrev": "sample string 2",
        "StateProvFull": "sample string 3",
        "IsActive": true,
        "CountryID": 1
      },
      {
        "StateProvID": 1,
        "StateProvAbrev": "sample string 2",
        "StateProvFull": "sample string 3",
        "IsActive": true,
        "CountryID": 1
      },
      {
        "StateProvID": 1,
        "StateProvAbrev": "sample string 2",
        "StateProvFull": "sample string 3",
        "IsActive": true,
        "CountryID": 1
      }
    ],
    "ProvinceCount": 5
  },
  {
    "CountryID": 1,
    "CountryFull": "sample string 2",
    "CountryAbrev": "sample string 3",
    "CountryFlag": "sample string 4",
    "IsActive": true,
    "Provinces": [
      {
        "StateProvID": 1,
        "StateProvAbrev": "sample string 2",
        "StateProvFull": "sample string 3",
        "IsActive": true,
        "CountryID": 1
      },
      {
        "StateProvID": 1,
        "StateProvAbrev": "sample string 2",
        "StateProvFull": "sample string 3",
        "IsActive": true,
        "CountryID": 1
      },
      {
        "StateProvID": 1,
        "StateProvAbrev": "sample string 2",
        "StateProvFull": "sample string 3",
        "IsActive": true,
        "CountryID": 1
      }
    ],
    "ProvinceCount": 5
  }
]

application/xml, text/xml

Sample:
<ArrayOfCountryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GolfWorld.DTOModel">
  <CountryDTO>
    <CountryAbrev>sample string 3</CountryAbrev>
    <CountryFlag>sample string 4</CountryFlag>
    <CountryFull>sample string 2</CountryFull>
    <CountryID>1</CountryID>
    <IsActive>true</IsActive>
    <ProvinceCount>5</ProvinceCount>
    <Provinces>
      <ProvinceDTO>
        <CountryID>1</CountryID>
        <IsActive>true</IsActive>
        <StateProvAbrev>sample string 2</StateProvAbrev>
        <StateProvFull>sample string 3</StateProvFull>
        <StateProvID>1</StateProvID>
      </ProvinceDTO>
      <ProvinceDTO>
        <CountryID>1</CountryID>
        <IsActive>true</IsActive>
        <StateProvAbrev>sample string 2</StateProvAbrev>
        <StateProvFull>sample string 3</StateProvFull>
        <StateProvID>1</StateProvID>
      </ProvinceDTO>
      <ProvinceDTO>
        <CountryID>1</CountryID>
        <IsActive>true</IsActive>
        <StateProvAbrev>sample string 2</StateProvAbrev>
        <StateProvFull>sample string 3</StateProvFull>
        <StateProvID>1</StateProvID>
      </ProvinceDTO>
    </Provinces>
  </CountryDTO>
  <CountryDTO>
    <CountryAbrev>sample string 3</CountryAbrev>
    <CountryFlag>sample string 4</CountryFlag>
    <CountryFull>sample string 2</CountryFull>
    <CountryID>1</CountryID>
    <IsActive>true</IsActive>
    <ProvinceCount>5</ProvinceCount>
    <Provinces>
      <ProvinceDTO>
        <CountryID>1</CountryID>
        <IsActive>true</IsActive>
        <StateProvAbrev>sample string 2</StateProvAbrev>
        <StateProvFull>sample string 3</StateProvFull>
        <StateProvID>1</StateProvID>
      </ProvinceDTO>
      <ProvinceDTO>
        <CountryID>1</CountryID>
        <IsActive>true</IsActive>
        <StateProvAbrev>sample string 2</StateProvAbrev>
        <StateProvFull>sample string 3</StateProvFull>
        <StateProvID>1</StateProvID>
      </ProvinceDTO>
      <ProvinceDTO>
        <CountryID>1</CountryID>
        <IsActive>true</IsActive>
        <StateProvAbrev>sample string 2</StateProvAbrev>
        <StateProvFull>sample string 3</StateProvFull>
        <StateProvID>1</StateProvID>
      </ProvinceDTO>
    </Provinces>
  </CountryDTO>
  <CountryDTO>
    <CountryAbrev>sample string 3</CountryAbrev>
    <CountryFlag>sample string 4</CountryFlag>
    <CountryFull>sample string 2</CountryFull>
    <CountryID>1</CountryID>
    <IsActive>true</IsActive>
    <ProvinceCount>5</ProvinceCount>
    <Provinces>
      <ProvinceDTO>
        <CountryID>1</CountryID>
        <IsActive>true</IsActive>
        <StateProvAbrev>sample string 2</StateProvAbrev>
        <StateProvFull>sample string 3</StateProvFull>
        <StateProvID>1</StateProvID>
      </ProvinceDTO>
      <ProvinceDTO>
        <CountryID>1</CountryID>
        <IsActive>true</IsActive>
        <StateProvAbrev>sample string 2</StateProvAbrev>
        <StateProvFull>sample string 3</StateProvFull>
        <StateProvID>1</StateProvID>
      </ProvinceDTO>
      <ProvinceDTO>
        <CountryID>1</CountryID>
        <IsActive>true</IsActive>
        <StateProvAbrev>sample string 2</StateProvAbrev>
        <StateProvFull>sample string 3</StateProvFull>
        <StateProvID>1</StateProvID>
      </ProvinceDTO>
    </Provinces>
  </CountryDTO>
</ArrayOfCountryDTO>