GET api/v2/countries/list

List country

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Name

StringExpressionQueryFilterList

None.

Alpha2Code

StringExpressionQueryFilterList

None.

Alpha3Code

StringExpressionQueryFilterList

None.

NumericCode

StringExpressionQueryFilterList

None.

Select

ListCountryQuerySelect

Required

Sort

Collection of ListCountryQuerySort

Required

Default value:

PageNumber

integer (32 bits)

Required

Default value: 1

PageSize

integer (32 bits)

Required

Default value: 100

Body Parameters

None.

Response Information

Resource Description

The list country query result

ListCountryQueryResult
NameDescriptionTypeAdditional information
Countries

Collection of ListCountryQueryResultCountry

Required

Count

integer (32 bits)

Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:
{
  "Countries": [
    {
      "CountryId": "00000000-0000-0000-0000-000000000000",
      "Name": "sample string 1",
      "Alpha2Code": "sample string 2",
      "Alpha3Code": "sample string 3",
      "NumericCode": 1
    },
    {
      "CountryId": "00000000-0000-0000-0000-000000000000",
      "Name": "sample string 1",
      "Alpha2Code": "sample string 2",
      "Alpha3Code": "sample string 3",
      "NumericCode": 1
    }
  ],
  "Count": 1
}