CollectionsAPI

<back to all web services

PostCollectionRequest

Requires Authentication
The following routes are available for this service:
POST/v4/collections
PostCollectionRequest Parameters:
NameParameterData TypeRequiredDescription
TitlebodystringNo
LinkIdsbodyIEnumerable<string>No
CollectionSettingsIdbodystringNo
PostCollectionResponse Parameters:
NameParameterData TypeRequiredDescription
DataformIPostCollectionResponseDataNo
V4BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
IPostCollectionResponseData Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v4/collections HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"title":"String","collectionSettingsId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}