GET Countries/Find?CountryId={CountryId}&GlobalCountryId={GlobalCountryId}&Label={Label}&CountryCode={CountryCode}&Alpha3CountryCode={Alpha3CountryCode}&Numeric3CountryCode={Numeric3CountryCode}&Archived={Archived}&SearchOperator={SearchOperator}

Finds all Countries matching specified criteria. Search for CountryId = 0 to get all unmapped global countries. Available querystring parameters : SearchOperator,Alpha3CountryCode,Country,CountryCode,CountryId,GlobalCountryId,Numeric3CountryCode,Archived. Use SearchOperator=0 to specify an AND query or SearchOperator=1 for an OR query

Request Parameters
Response Samples

Parameters

Name	Description	Additional information
CountryId	CountryId	Define this parameter in the request URI.
GlobalCountryId	GlobalCountryId	Define this parameter in the request URI.
Label	Label	Define this parameter in the request URI.
CountryCode	CountryCode	Define this parameter in the request URI.
Alpha3CountryCode	Alpha3CountryCode	Define this parameter in the request URI.
Numeric3CountryCode	Numeric3CountryCode	Define this parameter in the request URI.
Archived	Archived	Define this parameter in the request URI.
SearchOperator	SearchOperator	Define this parameter in the request URI.

Response body formats

A GetCountriesResponse containing matching Countries.

application/json, text/json

Sample:

{
  "List": [
    {
      "CountryId": 1,
      "CountryName": "sample string 2",
      "GlobalCountryId": 3,
      "VatRates": [
        {
          "ExpenseSubCategoryId": 1,
          "Vat": 2.1,
          "VatPercent": 3.1
        },
        {
          "ExpenseSubCategoryId": 1,
          "Vat": 2.1,
          "VatPercent": 3.1
        },
        {
          "ExpenseSubCategoryId": 1,
          "Vat": 2.1,
          "VatPercent": 3.1
        }
      ],
      "Archived": true
    },
    {
      "CountryId": 1,
      "CountryName": "sample string 2",
      "GlobalCountryId": 3,
      "VatRates": [
        {
          "ExpenseSubCategoryId": 1,
          "Vat": 2.1,
          "VatPercent": 3.1
        },
        {
          "ExpenseSubCategoryId": 1,
          "Vat": 2.1,
          "VatPercent": 3.1
        },
        {
          "ExpenseSubCategoryId": 1,
          "Vat": 2.1,
          "VatPercent": 3.1
        }
      ],
      "Archived": true
    },
    {
      "CountryId": 1,
      "CountryName": "sample string 2",
      "GlobalCountryId": 3,
      "VatRates": [
        {
          "ExpenseSubCategoryId": 1,
          "Vat": 2.1,
          "VatPercent": 3.1
        },
        {
          "ExpenseSubCategoryId": 1,
          "Vat": 2.1,
          "VatPercent": 3.1
        },
        {
          "ExpenseSubCategoryId": 1,
          "Vat": 2.1,
          "VatPercent": 3.1
        }
      ],
      "Archived": true
    }
  ],
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample:

<FindCountriesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <List xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:Country>
      <d2p1:Archived>true</d2p1:Archived>
      <d2p1:CountryId>1</d2p1:CountryId>
      <d2p1:CountryName>sample string 2</d2p1:CountryName>
      <d2p1:GlobalCountryId>3</d2p1:GlobalCountryId>
      <d2p1:VatRates>
        <d2p1:VatRate>
          <d2p1:ExpenseSubCategoryId>1</d2p1:ExpenseSubCategoryId>
          <d2p1:Vat>2.1</d2p1:Vat>
          <d2p1:VatPercent>3.1</d2p1:VatPercent>
        </d2p1:VatRate>
        <d2p1:VatRate>
          <d2p1:ExpenseSubCategoryId>1</d2p1:ExpenseSubCategoryId>
          <d2p1:Vat>2.1</d2p1:Vat>
          <d2p1:VatPercent>3.1</d2p1:VatPercent>
        </d2p1:VatRate>
        <d2p1:VatRate>
          <d2p1:ExpenseSubCategoryId>1</d2p1:ExpenseSubCategoryId>
          <d2p1:Vat>2.1</d2p1:Vat>
          <d2p1:VatPercent>3.1</d2p1:VatPercent>
        </d2p1:VatRate>
      </d2p1:VatRates>
    </d2p1:Country>
    <d2p1:Country>
      <d2p1:Archived>true</d2p1:Archived>
      <d2p1:CountryId>1</d2p1:CountryId>
      <d2p1:CountryName>sample string 2</d2p1:CountryName>
      <d2p1:GlobalCountryId>3</d2p1:GlobalCountryId>
      <d2p1:VatRates>
        <d2p1:VatRate>
          <d2p1:ExpenseSubCategoryId>1</d2p1:ExpenseSubCategoryId>
          <d2p1:Vat>2.1</d2p1:Vat>
          <d2p1:VatPercent>3.1</d2p1:VatPercent>
        </d2p1:VatRate>
        <d2p1:VatRate>
          <d2p1:ExpenseSubCategoryId>1</d2p1:ExpenseSubCategoryId>
          <d2p1:Vat>2.1</d2p1:Vat>
          <d2p1:VatPercent>3.1</d2p1:VatPercent>
        </d2p1:VatRate>
        <d2p1:VatRate>
          <d2p1:ExpenseSubCategoryId>1</d2p1:ExpenseSubCategoryId>
          <d2p1:Vat>2.1</d2p1:Vat>
          <d2p1:VatPercent>3.1</d2p1:VatPercent>
        </d2p1:VatRate>
      </d2p1:VatRates>
    </d2p1:Country>
    <d2p1:Country>
      <d2p1:Archived>true</d2p1:Archived>
      <d2p1:CountryId>1</d2p1:CountryId>
      <d2p1:CountryName>sample string 2</d2p1:CountryName>
      <d2p1:GlobalCountryId>3</d2p1:GlobalCountryId>
      <d2p1:VatRates>
        <d2p1:VatRate>
          <d2p1:ExpenseSubCategoryId>1</d2p1:ExpenseSubCategoryId>
          <d2p1:Vat>2.1</d2p1:Vat>
          <d2p1:VatPercent>3.1</d2p1:VatPercent>
        </d2p1:VatRate>
        <d2p1:VatRate>
          <d2p1:ExpenseSubCategoryId>1</d2p1:ExpenseSubCategoryId>
          <d2p1:Vat>2.1</d2p1:Vat>
          <d2p1:VatPercent>3.1</d2p1:VatPercent>
        </d2p1:VatRate>
        <d2p1:VatRate>
          <d2p1:ExpenseSubCategoryId>1</d2p1:ExpenseSubCategoryId>
          <d2p1:Vat>2.1</d2p1:Vat>
          <d2p1:VatPercent>3.1</d2p1:VatPercent>
        </d2p1:VatRate>
      </d2p1:VatRates>
    </d2p1:Country>
  </List>
</FindCountriesResponse>

GET Countries/Find?CountryId={CountryId}&GlobalCountryId={GlobalCountryId}&Label={Label}&CountryCode={CountryCode}&Alpha3CountryCode={Alpha3CountryCode}&Numeric3CountryCode={Numeric3CountryCode}&Archived={Archived}&SearchOperator={SearchOperator}

Parameters

Response body formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body