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

GetNodeRequest

Catalog

Retrieve a node

The following routes are available for this service:
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.

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Cdn.PublicApiV2.RequestObjects
Imports Cdn.PublicApiV2.ResponseObjects
Imports Cdn.PublicApiV2.Dto

Namespace Global

    Namespace Cdn.PublicApiV2.Dto

        Public Partial Class NodeDto
            Public Overridable Property Id As Long
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property FeaturedImageUrl As String
            Public Overridable Property FeaturedImageAttribution As String
            Public Overridable Property FlagCode As String
            Public Overridable Property CountryName As String
            Public Overridable Property SortingPosition As Integer
            Public Overridable Property NodeChildrenCountLive As Integer
            Public Overridable Property CollectibleChildrenCountLive As Integer
            Public Overridable Property ParentNode_Id As Long?
            Public Overridable Property RootNode_Id As Long?
            Public Overridable Property ChildNodes As List(Of NodeDto)
        End Class
    End Namespace

    Namespace Cdn.PublicApiV2.RequestObjects

        '''<Summary>
        '''Retrieve a node
        '''</Summary>
        <Api(Description:="Retrieve a node")>
        Public Partial Class GetNodeRequest
            Public Overridable Property NodeId As Long
        End Class
    End Namespace

    Namespace Cdn.PublicApiV2.ResponseObjects

        Public Partial Class BaseResponse
            Public Overridable Property Total As Integer
            Public Overridable Property OpCode As Integer
            Public Overridable Property ErrorText As String
            Public Overridable Property RequestTime As String
            Public Overridable Property ResponseTime As String
            Public Overridable Property TotalExecutionTime As String
            Public Overridable Property CachedResponse As Boolean
            Public Overridable Property PermitAccess As Boolean
            Public Overridable Property AccessDeniedMessage As String
        End Class

        Public Partial Class NodeResponse
            Inherits BaseResponse
            Public Overridable Property Data As List(Of NodeDto)
        End Class
    End Namespace
End Namespace

VB.NET 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: publicapiv2dev.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>