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

<back to all web services

GetCollectibleRequest

Catalog

Retrieve collectible(s)

The following routes are available for this service:
GET/GetCollectibleRequestSpecify ApiLevel=Advanced for additional collectible information.
namespace Cdn.PublicApiV2.Dto

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BaseResponse() = 
        member val Total:Int32 = new Int32() with get,set
        member val OpCode:Int32 = new Int32() with get,set
        member val ErrorText:String = null with get,set
        member val RequestTime:String = null with get,set
        member val ResponseTime:String = null with get,set
        member val TotalExecutionTime:String = null with get,set
        member val CachedResponse:Boolean = new Boolean() with get,set
        member val PermitAccess:Boolean = new Boolean() with get,set
        member val AccessDeniedMessage:String = null with get,set

    [<AllowNullLiteral>]
    type NodeDto() = 
        member val Id:Int64 = new Int64() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val FeaturedImageUrl:String = null with get,set
        member val FeaturedImageAttribution:String = null with get,set
        member val FlagCode:String = null with get,set
        member val CountryName:String = null with get,set
        member val SortingPosition:Int32 = new Int32() with get,set
        member val NodeChildrenCountLive:Int32 = new Int32() with get,set
        member val CollectibleChildrenCountLive:Int32 = new Int32() with get,set
        member val ParentNode_Id:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val RootNode_Id:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val ChildNodes:ResizeArray<NodeDto> = null with get,set

    [<AllowNullLiteral>]
    type CollectibleDto() = 
        member val Gsid:Int64 = new Int64() with get,set
        member val UiParentId:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val Name:String = null with get,set
        member val PcgsNumber:String = null with get,set
        member val FriedbergNumber:String = null with get,set
        member val CoinDate:String = null with get,set
        member val DenominationShort:String = null with get,set
        member val DenominationLong:String = null with get,set
        member val Variety:String = null with get,set
        member val Variety2:String = null with get,set
        member val Desg:String = null with get,set
        member val Other:String = null with get,set
        member val Prefix:String = null with get,set
        member val MintMark:String = null with get,set
        member val Composition:String = null with get,set
        member val Mintage:String = null with get,set
        member val StrikeType:String = null with get,set
        member val Diameter:String = null with get,set
        member val Fineness:String = null with get,set
        member val WeightGrams:Decimal = new Decimal() with get,set
        member val WeightOunces:Decimal = new Decimal() with get,set
        member val Designer:String = null with get,set
        member val Edge:String = null with get,set
        member val Rarity:String = null with get,set
        member val CoinShape:String = null with get,set
        member val Description:String = null with get,set
        member val GeneralNotes:String = null with get,set
        member val GeneralNotesSource:String = null with get,set
        member val GeneralCoinLettering:String = null with get,set
        member val ObverseDescription:String = null with get,set
        member val ObverseDesigner:String = null with get,set
        member val ObverseLettering:String = null with get,set
        member val ReverseDescription:String = null with get,set
        member val ReverseDesigner:String = null with get,set
        member val ReverseLettering:String = null with get,set
        member val BnBNumber:String = null with get,set
        member val NoteColor:String = null with get,set
        member val NoteDimension:String = null with get,set
        member val PickNumber:String = null with get,set
        member val Watermark:String = null with get,set
        member val Printer:String = null with get,set
        member val NoteSecurityThread:String = null with get,set
        member val NotePaperType:String = null with get,set
        member val BnbSignatureName1:String = null with get,set
        member val BnbSignatureName2:String = null with get,set
        member val BnbSignatureName3:String = null with get,set
        member val ObsoleteBankId:String = null with get,set
        member val ObsoleteStateName:String = null with get,set
        member val ObsoleteCityName:String = null with get,set
        member val ObsoleteBankName:String = null with get,set
        member val HaxbyNumber:String = null with get,set
        member val BnbTitle:String = null with get,set
        member val IssueNumber:String = null with get,set
        member val IssueMonth:Int32 = new Int32() with get,set
        member val IssueYear:Int32 = new Int32() with get,set
        member val Variant:String = null with get,set
        member val ArtComment1:String = null with get,set
        member val ArtComment2:String = null with get,set
        member val ArtComment3:String = null with get,set
        member val KeyComment1:String = null with get,set
        member val KeyComment2:String = null with get,set
        member val KeyComment3:String = null with get,set
        member val Ngc:String = null with get,set
        member val Krause:String = null with get,set
        member val EbayCategory1:Int32 = new Int32() with get,set
        member val FeaturedImageUrl:String = null with get,set
        member val FeaturedImageAttribution:String = null with get,set
        member val IsType:Boolean = new Boolean() with get,set
        member val IsSet:Boolean = new Boolean() with get,set
        member val PriceLow:Decimal = new Decimal() with get,set
        member val PriceHigh:Decimal = new Decimal() with get,set
        member val Is100GreatestUSCoins:Int32 = new Int32() with get,set
        member val Is100GreatestUSPaperMoney:Int32 = new Int32() with get,set
        member val Is100GreatestWorldPaperMoney:Int32 = new Int32() with get,set
        member val Is100GreatestModernUsCoins:Int32 = new Int32() with get,set
        member val IsRedbook:Boolean = new Boolean() with get,set
        member val IsCherryPicker:Boolean = new Boolean() with get,set
        member val RootNode_Id:Int64 = new Int64() with get,set
        member val ParentNode_Id:Int64 = new Int64() with get,set
        member val ParentNodeName:String = null with get,set
        member val SortingPosition:Int32 = new Int32() with get,set
        member val CatalogPath:ResizeArray<NodeDto> = null with get,set

    [<AllowNullLiteral>]
    type CollectibleResponse() = 
        inherit BaseResponse()
        member val Data:ResizeArray<CollectibleDto> = null with get,set

    ///<summary>
    ///Retrieve collectible(s)
    ///</summary>
    [<Api(Description="Retrieve collectible(s)")>]
    [<AllowNullLiteral>]
    type GetCollectibleRequest() = 
        member val GsId:Int64 = new Int64() with get,set
        member val ApiLevel:String = null with get,set

F# 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>