Syntch Gateway API

<back to all web services

GetCountries

Lookup Data - Addresses
Requires Authentication
Requires any of the roles:Reseller, Merchant
The following routes are available for this service:
GET/lookup/countriesGets a list of country codes
GetCountriesResult Parameters:
NameParameterData TypeRequiredDescription
CountriesmodelList<AbbreviatedResponseItem>NoA collection of countries.
PaginationmodelPaginationStatsNoPagination stats regarding the result set.
AbbreviatedResponseItem Parameters:
NameParameterData TypeRequiredDescription
ShortNameformstringNo
LongNameformstringNo
PaginationStats Parameters:
NameParameterData TypeRequiredDescription
CurrentPageNumberformintNo
PageSizeformintNo
TotalRecordCountformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /lookup/countries HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCountriesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Lookup.BindingModels">
  <Countries>
    <AbbreviatedResponseItem>
      <LongName>String</LongName>
      <ShortName>String</ShortName>
    </AbbreviatedResponseItem>
  </Countries>
  <Pagination xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.Infrastructure.Common">
    <d2p1:CurrentPageNumber>0</d2p1:CurrentPageNumber>
    <d2p1:PageSize>0</d2p1:PageSize>
    <d2p1:TotalRecordCount>0</d2p1:TotalRecordCount>
  </Pagination>
</GetCountriesResult>