Cdn Public Collector's Pricing Guide (CPG) API V2

<back to all web services

GetNodeRequest

Catalog

Retrieve a node

The following routes are available for this service:
GET/GetNodeRequestWhen 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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NodeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.PublicApiV2.ResponseObjects">
  <AccessDeniedMessage>String</AccessDeniedMessage>
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <PermitAccess>false</PermitAccess>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.PublicApiV2.Dto">
    <d2p1:NodeDto>
      <d2p1:ChildNodes>
        <d2p1:NodeDto>
          <d2p1:ChildNodes>
            <d2p1:NodeDto>
              <d2p1:ChildNodes i:nil="true" />
              <d2p1:CollectibleChildrenCountLive>0</d2p1:CollectibleChildrenCountLive>
              <d2p1:CountryName>String</d2p1:CountryName>
              <d2p1:Description>String</d2p1:Description>
              <d2p1:FeaturedImageAttribution>String</d2p1:FeaturedImageAttribution>
              <d2p1:FeaturedImageUrl>String</d2p1:FeaturedImageUrl>
              <d2p1:FlagCode>String</d2p1:FlagCode>
              <d2p1:Id>0</d2p1:Id>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:NodeChildrenCountLive>0</d2p1:NodeChildrenCountLive>
              <d2p1:ParentNode_Id>0</d2p1:ParentNode_Id>
              <d2p1:RootNode_Id>0</d2p1:RootNode_Id>
              <d2p1:SortingPosition>0</d2p1:SortingPosition>
            </d2p1:NodeDto>
          </d2p1:ChildNodes>
          <d2p1:CollectibleChildrenCountLive>0</d2p1:CollectibleChildrenCountLive>
          <d2p1:CountryName>String</d2p1:CountryName>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:FeaturedImageAttribution>String</d2p1:FeaturedImageAttribution>
          <d2p1:FeaturedImageUrl>String</d2p1:FeaturedImageUrl>
          <d2p1:FlagCode>String</d2p1:FlagCode>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:NodeChildrenCountLive>0</d2p1:NodeChildrenCountLive>
          <d2p1:ParentNode_Id>0</d2p1:ParentNode_Id>
          <d2p1:RootNode_Id>0</d2p1:RootNode_Id>
          <d2p1:SortingPosition>0</d2p1:SortingPosition>
        </d2p1:NodeDto>
      </d2p1:ChildNodes>
      <d2p1:CollectibleChildrenCountLive>0</d2p1:CollectibleChildrenCountLive>
      <d2p1:CountryName>String</d2p1:CountryName>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:FeaturedImageAttribution>String</d2p1:FeaturedImageAttribution>
      <d2p1:FeaturedImageUrl>String</d2p1:FeaturedImageUrl>
      <d2p1:FlagCode>String</d2p1:FlagCode>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:NodeChildrenCountLive>0</d2p1:NodeChildrenCountLive>
      <d2p1:ParentNode_Id>0</d2p1:ParentNode_Id>
      <d2p1:RootNode_Id>0</d2p1:RootNode_Id>
      <d2p1:SortingPosition>0</d2p1:SortingPosition>
    </d2p1:NodeDto>
  </Data>
</NodeResponse>