GET api/Common/CountryList?inUseOnly={inUseOnly}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
inUseOnly

boolean

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Country
NameDescriptionTypeAdditional information
CountryID

globally unique identifier

None.

CountryCode2

string

None.

CountryCode3

string

None.

CountryName

string

None.

TransactionSequencePrefix

string

None.

IsDeleted

boolean

None.

DefaultTimeZoneID

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CountryID": "0da091b7-59dd-4b25-a70c-0841e846030f",
    "CountryCode2": "sample string 2",
    "CountryCode3": "sample string 3",
    "CountryName": "sample string 4",
    "TransactionSequencePrefix": "sample string 5",
    "IsDeleted": true,
    "DefaultTimeZoneID": 7
  },
  {
    "CountryID": "0da091b7-59dd-4b25-a70c-0841e846030f",
    "CountryCode2": "sample string 2",
    "CountryCode3": "sample string 3",
    "CountryName": "sample string 4",
    "TransactionSequencePrefix": "sample string 5",
    "IsDeleted": true,
    "DefaultTimeZoneID": 7
  }
]

application/xml, text/xml

Sample:
<ArrayOfCountry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Common">
  <Country>
    <CountryCode2>sample string 2</CountryCode2>
    <CountryCode3>sample string 3</CountryCode3>
    <CountryID>0da091b7-59dd-4b25-a70c-0841e846030f</CountryID>
    <CountryName>sample string 4</CountryName>
    <DefaultTimeZoneID>7</DefaultTimeZoneID>
    <IsDeleted>true</IsDeleted>
    <TransactionSequencePrefix>sample string 5</TransactionSequencePrefix>
  </Country>
  <Country>
    <CountryCode2>sample string 2</CountryCode2>
    <CountryCode3>sample string 3</CountryCode3>
    <CountryID>0da091b7-59dd-4b25-a70c-0841e846030f</CountryID>
    <CountryName>sample string 4</CountryName>
    <DefaultTimeZoneID>7</DefaultTimeZoneID>
    <IsDeleted>true</IsDeleted>
    <TransactionSequencePrefix>sample string 5</TransactionSequencePrefix>
  </Country>
</ArrayOfCountry>