| GET | /v4/collections/list |
|---|
"use strict";
export class V4BaseRequest {
constructor(init) { Object.assign(this, init) }
}
export class V4PaginatedBaseRequest extends V4BaseRequest {
/** @param {{offset?:number,limit?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
offset;
/** @type {number} */
limit;
}
export class V4ListRequest extends V4PaginatedBaseRequest {
/** @param {{ids?:string[],offset?:number,limit?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string[]} */
ids;
}
export class V4BaseResponse {
/** @param {{status?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
status;
}
export class V4PageObject {
/** @param {{offset?:number,limit?:number,totalRecords?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
offset;
/** @type {number} */
limit;
/** @type {number} */
totalRecords;
}
export class V4PaginatedBaseResponse extends V4BaseResponse {
/** @param {{page?:V4PageObject,status?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {V4PageObject} */
page;
}
export class GetCollectionsResponse extends V4PaginatedBaseResponse {
/** @param {{data?:IUserCollection[],page?:V4PageObject,status?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {IUserCollection[]} */
data;
}
export class GetCollectionsRequest extends V4ListRequest {
/** @param {{ids?:string[],offset?:number,limit?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
JavaScript GetCollectionsRequest 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.
GET /v4/collections/list HTTP/1.1 Host: collections-api-zane.dev.platform.georiot.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}