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

GetCollectibleRequest

Catalog

Retrieve collectible(s)

The following routes are available for this service:
GET	/GetCollectibleRequest		Specify ApiLevel=Advanced for additional collectible information.

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 CollectibleDto
            Public Overridable Property Gsid As Long
            Public Overridable Property UiParentId As Long?
            Public Overridable Property Name As String
            Public Overridable Property PcgsNumber As String
            Public Overridable Property FriedbergNumber As String
            Public Overridable Property CoinDate As String
            Public Overridable Property DenominationShort As String
            Public Overridable Property DenominationLong As String
            Public Overridable Property Variety As String
            Public Overridable Property Variety2 As String
            Public Overridable Property Desg As String
            Public Overridable Property Other As String
            Public Overridable Property Prefix As String
            Public Overridable Property MintMark As String
            Public Overridable Property Composition As String
            Public Overridable Property Mintage As String
            Public Overridable Property StrikeType As String
            Public Overridable Property Diameter As String
            Public Overridable Property Fineness As String
            Public Overridable Property WeightGrams As Decimal
            Public Overridable Property WeightOunces As Decimal
            Public Overridable Property Designer As String
            Public Overridable Property Edge As String
            Public Overridable Property Rarity As String
            Public Overridable Property CoinShape As String
            Public Overridable Property Description As String
            Public Overridable Property GeneralNotes As String
            Public Overridable Property GeneralNotesSource As String
            Public Overridable Property GeneralCoinLettering As String
            Public Overridable Property ObverseDescription As String
            Public Overridable Property ObverseDesigner As String
            Public Overridable Property ObverseLettering As String
            Public Overridable Property ReverseDescription As String
            Public Overridable Property ReverseDesigner As String
            Public Overridable Property ReverseLettering As String
            Public Overridable Property BnBNumber As String
            Public Overridable Property NoteColor As String
            Public Overridable Property NoteDimension As String
            Public Overridable Property PickNumber As String
            Public Overridable Property Watermark As String
            Public Overridable Property Printer As String
            Public Overridable Property NoteSecurityThread As String
            Public Overridable Property NotePaperType As String
            Public Overridable Property BnbSignatureName1 As String
            Public Overridable Property BnbSignatureName2 As String
            Public Overridable Property BnbSignatureName3 As String
            Public Overridable Property ObsoleteBankId As String
            Public Overridable Property ObsoleteStateName As String
            Public Overridable Property ObsoleteCityName As String
            Public Overridable Property ObsoleteBankName As String
            Public Overridable Property HaxbyNumber As String
            Public Overridable Property BnbTitle As String
            Public Overridable Property IssueNumber As String
            Public Overridable Property IssueMonth As Integer
            Public Overridable Property IssueYear As Integer
            Public Overridable Property [Variant] As String
            Public Overridable Property ArtComment1 As String
            Public Overridable Property ArtComment2 As String
            Public Overridable Property ArtComment3 As String
            Public Overridable Property KeyComment1 As String
            Public Overridable Property KeyComment2 As String
            Public Overridable Property KeyComment3 As String
            Public Overridable Property Ngc As String
            Public Overridable Property Krause As String
            Public Overridable Property EbayCategory1 As Integer
            Public Overridable Property FeaturedImageUrl As String
            Public Overridable Property FeaturedImageAttribution As String
            Public Overridable Property IsType As Boolean
            Public Overridable Property IsSet As Boolean
            Public Overridable Property PriceLow As Decimal
            Public Overridable Property PriceHigh As Decimal
            Public Overridable Property Is100GreatestUSCoins As Integer
            Public Overridable Property Is100GreatestUSPaperMoney As Integer
            Public Overridable Property Is100GreatestWorldPaperMoney As Integer
            Public Overridable Property Is100GreatestModernUsCoins As Integer
            Public Overridable Property IsRedbook As Boolean
            Public Overridable Property IsCherryPicker As Boolean
            Public Overridable Property RootNode_Id As Long
            Public Overridable Property ParentNode_Id As Long
            Public Overridable Property ParentNodeName As String
            Public Overridable Property SortingPosition As Integer
            Public Overridable Property CatalogPath As List(Of NodeDto)
        End Class

        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 collectible(s)
        '''</Summary>
        <Api(Description:="Retrieve collectible(s)")>
        Public Partial Class GetCollectibleRequest
            Public Overridable Property GsId As Long
            Public Overridable Property ApiLevel As String
        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 CollectibleResponse
            Inherits BaseResponse
            Public Overridable Property Data As List(Of CollectibleDto)
        End Class
    End Namespace
End Namespace

VB.NET GetCollectibleRequest 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 /GetCollectibleRequest HTTP/1.1 
Host: cpgpublicapiv2dev.greysheet.com 
Accept: application/xml

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

<CollectibleResponse 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:CollectibleDto>
      <d2p1:ArtComment1>String</d2p1:ArtComment1>
      <d2p1:ArtComment2>String</d2p1:ArtComment2>
      <d2p1:ArtComment3>String</d2p1:ArtComment3>
      <d2p1:BnBNumber>String</d2p1:BnBNumber>
      <d2p1:BnbSignatureName1>String</d2p1:BnbSignatureName1>
      <d2p1:BnbSignatureName2>String</d2p1:BnbSignatureName2>
      <d2p1:BnbSignatureName3>String</d2p1:BnbSignatureName3>
      <d2p1:BnbTitle>String</d2p1:BnbTitle>
      <d2p1:CatalogPath>
        <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>
      </d2p1:CatalogPath>
      <d2p1:CoinDate>String</d2p1:CoinDate>
      <d2p1:CoinShape>String</d2p1:CoinShape>
      <d2p1:Composition>String</d2p1:Composition>
      <d2p1:DenominationLong>String</d2p1:DenominationLong>
      <d2p1:DenominationShort>String</d2p1:DenominationShort>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Desg>String</d2p1:Desg>
      <d2p1:Designer>String</d2p1:Designer>
      <d2p1:Diameter>String</d2p1:Diameter>
      <d2p1:EbayCategory1>0</d2p1:EbayCategory1>
      <d2p1:Edge>String</d2p1:Edge>
      <d2p1:FeaturedImageAttribution>String</d2p1:FeaturedImageAttribution>
      <d2p1:FeaturedImageUrl>String</d2p1:FeaturedImageUrl>
      <d2p1:Fineness>String</d2p1:Fineness>
      <d2p1:FriedbergNumber>String</d2p1:FriedbergNumber>
      <d2p1:GeneralCoinLettering>String</d2p1:GeneralCoinLettering>
      <d2p1:GeneralNotes>String</d2p1:GeneralNotes>
      <d2p1:GeneralNotesSource>String</d2p1:GeneralNotesSource>
      <d2p1:Gsid>0</d2p1:Gsid>
      <d2p1:HaxbyNumber>String</d2p1:HaxbyNumber>
      <d2p1:Is100GreatestModernUsCoins>0</d2p1:Is100GreatestModernUsCoins>
      <d2p1:Is100GreatestUSCoins>0</d2p1:Is100GreatestUSCoins>
      <d2p1:Is100GreatestUSPaperMoney>0</d2p1:Is100GreatestUSPaperMoney>
      <d2p1:Is100GreatestWorldPaperMoney>0</d2p1:Is100GreatestWorldPaperMoney>
      <d2p1:IsCherryPicker>false</d2p1:IsCherryPicker>
      <d2p1:IsRedbook>false</d2p1:IsRedbook>
      <d2p1:IsSet>false</d2p1:IsSet>
      <d2p1:IsType>false</d2p1:IsType>
      <d2p1:IssueMonth>0</d2p1:IssueMonth>
      <d2p1:IssueNumber>String</d2p1:IssueNumber>
      <d2p1:IssueYear>0</d2p1:IssueYear>
      <d2p1:KeyComment1>String</d2p1:KeyComment1>
      <d2p1:KeyComment2>String</d2p1:KeyComment2>
      <d2p1:KeyComment3>String</d2p1:KeyComment3>
      <d2p1:Krause>String</d2p1:Krause>
      <d2p1:MintMark>String</d2p1:MintMark>
      <d2p1:Mintage>String</d2p1:Mintage>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Ngc>String</d2p1:Ngc>
      <d2p1:NoteColor>String</d2p1:NoteColor>
      <d2p1:NoteDimension>String</d2p1:NoteDimension>
      <d2p1:NotePaperType>String</d2p1:NotePaperType>
      <d2p1:NoteSecurityThread>String</d2p1:NoteSecurityThread>
      <d2p1:ObsoleteBankId>String</d2p1:ObsoleteBankId>
      <d2p1:ObsoleteBankName>String</d2p1:ObsoleteBankName>
      <d2p1:ObsoleteCityName>String</d2p1:ObsoleteCityName>
      <d2p1:ObsoleteStateName>String</d2p1:ObsoleteStateName>
      <d2p1:ObverseDescription>String</d2p1:ObverseDescription>
      <d2p1:ObverseDesigner>String</d2p1:ObverseDesigner>
      <d2p1:ObverseLettering>String</d2p1:ObverseLettering>
      <d2p1:Other>String</d2p1:Other>
      <d2p1:ParentNodeName>String</d2p1:ParentNodeName>
      <d2p1:ParentNode_Id>0</d2p1:ParentNode_Id>
      <d2p1:PcgsNumber>String</d2p1:PcgsNumber>
      <d2p1:PickNumber>String</d2p1:PickNumber>
      <d2p1:Prefix>String</d2p1:Prefix>
      <d2p1:PriceHigh>0</d2p1:PriceHigh>
      <d2p1:PriceLow>0</d2p1:PriceLow>
      <d2p1:Printer>String</d2p1:Printer>
      <d2p1:Rarity>String</d2p1:Rarity>
      <d2p1:ReverseDescription>String</d2p1:ReverseDescription>
      <d2p1:ReverseDesigner>String</d2p1:ReverseDesigner>
      <d2p1:ReverseLettering>String</d2p1:ReverseLettering>
      <d2p1:RootNode_Id>0</d2p1:RootNode_Id>
      <d2p1:SortingPosition>0</d2p1:SortingPosition>
      <d2p1:StrikeType>String</d2p1:StrikeType>
      <d2p1:UiParentId>0</d2p1:UiParentId>
      <d2p1:Variant>String</d2p1:Variant>
      <d2p1:Variety>String</d2p1:Variety>
      <d2p1:Variety2>String</d2p1:Variety2>
      <d2p1:Watermark>String</d2p1:Watermark>
      <d2p1:WeightGrams>0</d2p1:WeightGrams>
      <d2p1:WeightOunces>0</d2p1:WeightOunces>
    </d2p1:CollectibleDto>
  </Data>
</CollectibleResponse>