NAV

<back to all web services

RegionGetList

DomainAPI|Regions
The following routes are available for this service:
GET/regions
GetListResponse<TEntity> Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<TEntity>No
ResponseStatusformResponseStatusNo
RegionViewModel Parameters:
NameParameterData TypeRequiredDescription
RegionIdformstringNo
RegionDescriptionformstringNo

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

HTTP + CSV

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

GET /regions HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"items":[{"regionId":"String","regionDescription":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}