ApexERPHost

<back to all web services

GetCity

Requires Authentication
The following routes are available for this service:
GET/Common/City/{CityId}
GET/Common/City
GET/Common/Country/{CountryId}/City
GetCity Parameters:
NameParameterData TypeRequiredDescription
CountryIdpathstringNoCity id
CityIdpathstringNo
GetCityResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<City>No
City Parameters:
NameParameterData TypeRequiredDescription
CityIdformstringNocity id
CountryIdformstringNoCountry id
CityNameEngformstringNoCity Name (Eng)
LDefaultformboolNoDefault City for Use
SpendformboolNoRecord for Use - 0 ; Record Blocked for Use - 1
CityNuformstringNoName (Geo Unicode)

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

HTTP + X-PROTOBUF

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

GET /Common/City/{CityId} HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/x-protobuf
HTTP/1.1 200 OK
Content-Type: application/x-protobuf
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Result":[{"CityId":"String","CountryId":"String","CityNameEng":"String","LDefault":false,"Spend":false,"CityNu":"String"}]}