POST Client/GetClientCountry

Get Client Country Detail

Request Information

URI Parameters

None.

Body Parameters

ApiClientCountryFilter
NameDescriptionTypeAdditional information
ClientID

Gets or sets the CountryID identifier.

integer

None.

userID

Gets or sets the user identifier.

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ClientID": 1,
  "userID": 2
}

application/xml, text/xml

Sample:
<ApiClientCountryFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SyX.Online.API.Models">
  <userID>2</userID>
  <ClientID>1</ClientID>
</ApiClientCountryFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiClientCountryResponse
NameDescriptionTypeAdditional information
ResponseObject

Gets or sets the response object.

Collection of ApiClientCountry

None.

ResponseType

Gets or sets the type of the response.

integer

None.

ResponseMessage

Gets or sets the response message.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseObject": [
    {
      "CountryID": 1,
      "CountryName": "sample string 2",
      "CountryCode": "sample string 3",
      "CurrencyCode": "sample string 4",
      "CurrencySymbol": "sample string 5"
    },
    {
      "CountryID": 1,
      "CountryName": "sample string 2",
      "CountryCode": "sample string 3",
      "CurrencyCode": "sample string 4",
      "CurrencySymbol": "sample string 5"
    }
  ],
  "ResponseType": 1,
  "ResponseMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<ApiClientCountryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SyX.Online.API.Models">
  <ResponseMessage>sample string 2</ResponseMessage>
  <ResponseType>1</ResponseType>
  <ResponseObject>
    <ApiClientCountry>
      <CountryCode>sample string 3</CountryCode>
      <CountryID>1</CountryID>
      <CountryName>sample string 2</CountryName>
      <CurrencyCode>sample string 4</CurrencyCode>
      <CurrencySymbol>sample string 5</CurrencySymbol>
    </ApiClientCountry>
    <ApiClientCountry>
      <CountryCode>sample string 3</CountryCode>
      <CountryID>1</CountryID>
      <CountryName>sample string 2</CountryName>
      <CurrencyCode>sample string 4</CurrencyCode>
      <CurrencySymbol>sample string 5</CurrencySymbol>
    </ApiClientCountry>
  </ResponseObject>
</ApiClientCountryResponse>