POST Agents/List/GetCountry

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/List/GetCountry

Gets a Country object.

Query String Parameters

Parameter Name Type Description
countryId int32 Required The primary key.
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. 
POST /api/v1/Agents/List/GetCountry?countryId=153
POST /api/v1/Agents/List/GetCountry?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: Country

Property Name Type Description
CountryId int32 Primary key
Name string Name of country in installed language
CurrencyId int32 Default currency for this country
EnglishName string Name of country in english
TwoLetterISOCountry string Two-letter country-code according to ISO3166
ThreeLetterISOCountry string Three-letter country-code according to ISO3166
ImageDescription string Description of the country's flag image. (This is the country flag that is displayed in the CRM client)
OrgNrText string Lead text for organisation field
InterAreaPrefix string International prefix
DialInPrefix string Dial in prefix
ZipPrefix string Post prefix
DomainName string Domain name of the country
AddressLayoutId int32 Address layout of the country
DomesticAddressLayoutId int32 Domestic address layout of the country
ForeignAddressLayoutId int32 Foreign address layout of the country
Rank int32 The rank of the country
Tooltip string The tooltip of the country
Deleted bool true if the country is deleted
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/List/GetCountry
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "CountryId": 757,
  "Name": "Ziemann, Davis and Schiller",
  "CurrencyId": 4,
  "EnglishName": "McDermott, Bednar and Shanahan",
  "TwoLetterISOCountry": "Sokovia",
  "ThreeLetterISOCountry": "Sokovia",
  "ImageDescription": "Progressive attitude-oriented core",
  "OrgNrText": "1378368",
  "InterAreaPrefix": "eius",
  "DialInPrefix": "ducimus",
  "ZipPrefix": "dolores",
  "DomainName": "Rohan, Hegmann and Kling",
  "AddressLayoutId": 18,
  "DomesticAddressLayoutId": 842,
  "ForeignAddressLayoutId": 84,
  "Rank": 50,
  "Tooltip": "assumenda",
  "Deleted": false,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 501
    }
  }
}