| POST | /v4/collections |
|---|
"use strict";
export class V4BaseRequest {
constructor(init) { Object.assign(this, init) }
}
export class V4BaseResponse {
/** @param {{status?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
status;
}
export class PostCollectionResponse extends V4BaseResponse {
/** @param {{data?:IPostCollectionResponseData,status?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {IPostCollectionResponseData} */
data;
}
export class PostCollectionRequest extends V4BaseRequest {
/** @param {{title?:string,linkIds?:string[],collectionSettingsId?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
title;
/** @type {string[]} */
linkIds;
/** @type {string} */
collectionSettingsId;
}
JavaScript PostCollectionRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
title: String,
collectionSettingsId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
status:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}