CollectionsAPI

<back to all web services

GetCollectionsRequest

Requires Authentication
The following routes are available for this service:
GET/v4/collections/list
V4ListRequest Parameters:
NameParameterData TypeRequiredDescription
IdsformList<string>No
V4PaginatedBaseRequest Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
LimitformintNo
GetCollectionsResponse Parameters:
NameParameterData TypeRequiredDescription
DataformIEnumerable<IUserCollection>No
V4PaginatedBaseResponse Parameters:
NameParameterData TypeRequiredDescription
PageformV4PageObjectNo
V4BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
V4PageObject Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
LimitformintNo
TotalRecordsformintNo
IUserCollection Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TitleformstringNo
LinkIdsformIEnumerable<string>No
CollectionSettingsIdformstringNo

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 /v4/collections/list HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"page":{"offset":0,"limit":0,"totalRecords":0},"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}