| GET | /GetNodeRequest | When NodeChildrenCountLive > 0 then this is a leaf node and has Node children. If CollectibleChildrenCountLive > 0 then the node has collectible children. There is no advanced APi version for this call. |
|---|
"use strict";
export class BaseResponse {
/** @param {{Total?:number,OpCode?:number,ErrorText?:string,RequestTime?:string,ResponseTime?:string,TotalExecutionTime?:string,CachedResponse?:boolean,PermitAccess?:boolean,AccessDeniedMessage?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Total;
/** @type {number} */
OpCode;
/** @type {string} */
ErrorText;
/** @type {string} */
RequestTime;
/** @type {string} */
ResponseTime;
/** @type {string} */
TotalExecutionTime;
/** @type {boolean} */
CachedResponse;
/** @type {boolean} */
PermitAccess;
/** @type {string} */
AccessDeniedMessage;
}
export class NodeDto {
/** @param {{Id?:number,Name?:string,Description?:string,FeaturedImageUrl?:string,FeaturedImageAttribution?:string,FlagCode?:string,CountryName?:string,SortingPosition?:number,NodeChildrenCountLive?:number,CollectibleChildrenCountLive?:number,ParentNode_Id?:number,RootNode_Id?:number,ChildNodes?:NodeDto[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {string} */
FeaturedImageUrl;
/** @type {string} */
FeaturedImageAttribution;
/** @type {string} */
FlagCode;
/** @type {string} */
CountryName;
/** @type {number} */
SortingPosition;
/** @type {number} */
NodeChildrenCountLive;
/** @type {number} */
CollectibleChildrenCountLive;
/** @type {?number} */
ParentNode_Id;
/** @type {?number} */
RootNode_Id;
/** @type {NodeDto[]} */
ChildNodes;
}
export class NodeResponse extends BaseResponse {
/** @param {{Data?:NodeDto[],Total?:number,OpCode?:number,ErrorText?:string,RequestTime?:string,ResponseTime?:string,TotalExecutionTime?:string,CachedResponse?:boolean,PermitAccess?:boolean,AccessDeniedMessage?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {NodeDto[]} */
Data;
}
export class GetNodeRequest {
/** @param {{NodeId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
NodeId;
}
JavaScript GetNodeRequest 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 /GetNodeRequest HTTP/1.1 Host: cpgpublicapiv2dev.greysheet.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Data:
[
{
Id: 0,
Name: String,
Description: String,
FeaturedImageUrl: String,
FeaturedImageAttribution: String,
FlagCode: String,
CountryName: String,
SortingPosition: 0,
NodeChildrenCountLive: 0,
CollectibleChildrenCountLive: 0,
ParentNode_Id: 0,
RootNode_Id: 0,
ChildNodes:
[
{
Id: 0,
Name: String,
Description: String,
FeaturedImageUrl: String,
FeaturedImageAttribution: String,
FlagCode: String,
CountryName: String,
SortingPosition: 0,
NodeChildrenCountLive: 0,
CollectibleChildrenCountLive: 0,
ParentNode_Id: 0,
RootNode_Id: 0,
ChildNodes:
[
{
Id: 0,
Name: String,
Description: String,
FeaturedImageUrl: String,
FeaturedImageAttribution: String,
FlagCode: String,
CountryName: String,
SortingPosition: 0,
NodeChildrenCountLive: 0,
CollectibleChildrenCountLive: 0,
ParentNode_Id: 0,
RootNode_Id: 0
}
]
}
]
}
],
Total: 0,
OpCode: 0,
ErrorText: String,
RequestTime: String,
ResponseTime: String,
TotalExecutionTime: String,
CachedResponse: False,
PermitAccess: False,
AccessDeniedMessage: String
}