| GET | /v2/collections | ||
|---|---|---|---|
| GET | /v2/collections/{Id} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | UserCollection | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | string | No | |
| Id | form | string | No | |
| BaseCode | form | string | No | |
| Url | form | string | No | |
| Title | form | string | No | |
| LinkIds | form | IEnumerable<string> | No | |
| CollectionSettingsId | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v2/collections HTTP/1.1 Host: api.booklinker.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"data":{"type":"collection","id":"String","baseCode":"String","url":"String","title":"String","collectionSettingsId":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}