GET regions

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Region
NameDescriptionTypeAdditional information
id

globally unique identifier

None.

countryId

globally unique identifier

None.

code

string

None.

name

string

None.

items

Collection of District

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": "56817ebd-1e35-4391-b01e-961d4bf5635e",
    "countryId": "5a995033-c272-490b-94b6-f38631af91a9",
    "code": "sample string 1",
    "name": "sample string 2",
    "items": [
      {
        "id": "0608ae2c-44db-41ef-8ee8-83aa74287864",
        "regionId": "b5c8c0ff-85d0-4d43-a0a5-aaab8a55ecf7",
        "code": "sample string 1",
        "name": "sample string 2",
        "khoroos": [
          {
            "id": "8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d",
            "districtId": "5cef7faa-0541-40e2-8e04-2569a480ff1a",
            "number": 1
          },
          {
            "id": "8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d",
            "districtId": "5cef7faa-0541-40e2-8e04-2569a480ff1a",
            "number": 1
          }
        ]
      },
      {
        "id": "0608ae2c-44db-41ef-8ee8-83aa74287864",
        "regionId": "b5c8c0ff-85d0-4d43-a0a5-aaab8a55ecf7",
        "code": "sample string 1",
        "name": "sample string 2",
        "khoroos": [
          {
            "id": "8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d",
            "districtId": "5cef7faa-0541-40e2-8e04-2569a480ff1a",
            "number": 1
          },
          {
            "id": "8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d",
            "districtId": "5cef7faa-0541-40e2-8e04-2569a480ff1a",
            "number": 1
          }
        ]
      }
    ]
  },
  {
    "id": "56817ebd-1e35-4391-b01e-961d4bf5635e",
    "countryId": "5a995033-c272-490b-94b6-f38631af91a9",
    "code": "sample string 1",
    "name": "sample string 2",
    "items": [
      {
        "id": "0608ae2c-44db-41ef-8ee8-83aa74287864",
        "regionId": "b5c8c0ff-85d0-4d43-a0a5-aaab8a55ecf7",
        "code": "sample string 1",
        "name": "sample string 2",
        "khoroos": [
          {
            "id": "8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d",
            "districtId": "5cef7faa-0541-40e2-8e04-2569a480ff1a",
            "number": 1
          },
          {
            "id": "8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d",
            "districtId": "5cef7faa-0541-40e2-8e04-2569a480ff1a",
            "number": 1
          }
        ]
      },
      {
        "id": "0608ae2c-44db-41ef-8ee8-83aa74287864",
        "regionId": "b5c8c0ff-85d0-4d43-a0a5-aaab8a55ecf7",
        "code": "sample string 1",
        "name": "sample string 2",
        "khoroos": [
          {
            "id": "8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d",
            "districtId": "5cef7faa-0541-40e2-8e04-2569a480ff1a",
            "number": 1
          },
          {
            "id": "8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d",
            "districtId": "5cef7faa-0541-40e2-8e04-2569a480ff1a",
            "number": 1
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfRegion xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Careby.Api.Models">
  <Region>
    <code>sample string 1</code>
    <countryId>5a995033-c272-490b-94b6-f38631af91a9</countryId>
    <id>56817ebd-1e35-4391-b01e-961d4bf5635e</id>
    <items>
      <District>
        <code>sample string 1</code>
        <id>0608ae2c-44db-41ef-8ee8-83aa74287864</id>
        <khoroos>
          <Khoroo>
            <districtId>5cef7faa-0541-40e2-8e04-2569a480ff1a</districtId>
            <id>8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d</id>
            <number>1</number>
          </Khoroo>
          <Khoroo>
            <districtId>5cef7faa-0541-40e2-8e04-2569a480ff1a</districtId>
            <id>8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d</id>
            <number>1</number>
          </Khoroo>
        </khoroos>
        <name>sample string 2</name>
        <regionId>b5c8c0ff-85d0-4d43-a0a5-aaab8a55ecf7</regionId>
      </District>
      <District>
        <code>sample string 1</code>
        <id>0608ae2c-44db-41ef-8ee8-83aa74287864</id>
        <khoroos>
          <Khoroo>
            <districtId>5cef7faa-0541-40e2-8e04-2569a480ff1a</districtId>
            <id>8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d</id>
            <number>1</number>
          </Khoroo>
          <Khoroo>
            <districtId>5cef7faa-0541-40e2-8e04-2569a480ff1a</districtId>
            <id>8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d</id>
            <number>1</number>
          </Khoroo>
        </khoroos>
        <name>sample string 2</name>
        <regionId>b5c8c0ff-85d0-4d43-a0a5-aaab8a55ecf7</regionId>
      </District>
    </items>
    <name>sample string 2</name>
  </Region>
  <Region>
    <code>sample string 1</code>
    <countryId>5a995033-c272-490b-94b6-f38631af91a9</countryId>
    <id>56817ebd-1e35-4391-b01e-961d4bf5635e</id>
    <items>
      <District>
        <code>sample string 1</code>
        <id>0608ae2c-44db-41ef-8ee8-83aa74287864</id>
        <khoroos>
          <Khoroo>
            <districtId>5cef7faa-0541-40e2-8e04-2569a480ff1a</districtId>
            <id>8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d</id>
            <number>1</number>
          </Khoroo>
          <Khoroo>
            <districtId>5cef7faa-0541-40e2-8e04-2569a480ff1a</districtId>
            <id>8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d</id>
            <number>1</number>
          </Khoroo>
        </khoroos>
        <name>sample string 2</name>
        <regionId>b5c8c0ff-85d0-4d43-a0a5-aaab8a55ecf7</regionId>
      </District>
      <District>
        <code>sample string 1</code>
        <id>0608ae2c-44db-41ef-8ee8-83aa74287864</id>
        <khoroos>
          <Khoroo>
            <districtId>5cef7faa-0541-40e2-8e04-2569a480ff1a</districtId>
            <id>8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d</id>
            <number>1</number>
          </Khoroo>
          <Khoroo>
            <districtId>5cef7faa-0541-40e2-8e04-2569a480ff1a</districtId>
            <id>8e19fc82-cc37-42d1-ae0a-91b83e9a9e8d</id>
            <number>1</number>
          </Khoroo>
        </khoroos>
        <name>sample string 2</name>
        <regionId>b5c8c0ff-85d0-4d43-a0a5-aaab8a55ecf7</regionId>
      </District>
    </items>
    <name>sample string 2</name>
  </Region>
</ArrayOfRegion>