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.

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Retrieve collectible(s)
*/
@Api(Description="Retrieve collectible(s)")
open class GetCollectibleRequest
{
    open var GsId:Long? = null
    open var ApiLevel:String? = null
}

open class CollectibleResponse : BaseResponse()
{
    open var Data:ArrayList<CollectibleDto>? = null
}

open class BaseResponse
{
    open var Total:Int? = null
    open var OpCode:Int? = null
    open var ErrorText:String? = null
    open var RequestTime:String? = null
    open var ResponseTime:String? = null
    open var TotalExecutionTime:String? = null
    open var CachedResponse:Boolean? = null
    open var PermitAccess:Boolean? = null
    open var AccessDeniedMessage:String? = null
}

open class CollectibleDto
{
    open var Gsid:Long? = null
    open var UiParentId:Long? = null
    open var Name:String? = null
    open var PcgsNumber:String? = null
    open var FriedbergNumber:String? = null
    open var CoinDate:String? = null
    open var DenominationShort:String? = null
    open var DenominationLong:String? = null
    open var Variety:String? = null
    open var Variety2:String? = null
    open var Desg:String? = null
    open var Other:String? = null
    open var Prefix:String? = null
    open var MintMark:String? = null
    open var Composition:String? = null
    open var Mintage:String? = null
    open var StrikeType:String? = null
    open var Diameter:String? = null
    open var Fineness:String? = null
    open var WeightGrams:BigDecimal? = null
    open var WeightOunces:BigDecimal? = null
    open var Designer:String? = null
    open var Edge:String? = null
    open var Rarity:String? = null
    open var CoinShape:String? = null
    open var Description:String? = null
    open var GeneralNotes:String? = null
    open var GeneralNotesSource:String? = null
    open var GeneralCoinLettering:String? = null
    open var ObverseDescription:String? = null
    open var ObverseDesigner:String? = null
    open var ObverseLettering:String? = null
    open var ReverseDescription:String? = null
    open var ReverseDesigner:String? = null
    open var ReverseLettering:String? = null
    open var BnBNumber:String? = null
    open var NoteColor:String? = null
    open var NoteDimension:String? = null
    open var PickNumber:String? = null
    open var Watermark:String? = null
    open var Printer:String? = null
    open var NoteSecurityThread:String? = null
    open var NotePaperType:String? = null
    open var BnbSignatureName1:String? = null
    open var BnbSignatureName2:String? = null
    open var BnbSignatureName3:String? = null
    open var ObsoleteBankId:String? = null
    open var ObsoleteStateName:String? = null
    open var ObsoleteCityName:String? = null
    open var ObsoleteBankName:String? = null
    open var HaxbyNumber:String? = null
    open var BnbTitle:String? = null
    open var IssueNumber:String? = null
    open var IssueMonth:Int? = null
    open var IssueYear:Int? = null
    open var Variant:String? = null
    open var ArtComment1:String? = null
    open var ArtComment2:String? = null
    open var ArtComment3:String? = null
    open var KeyComment1:String? = null
    open var KeyComment2:String? = null
    open var KeyComment3:String? = null
    open var Ngc:String? = null
    open var Krause:String? = null
    open var EbayCategory1:Int? = null
    open var FeaturedImageUrl:String? = null
    open var FeaturedImageAttribution:String? = null
    open var IsType:Boolean? = null
    open var IsSet:Boolean? = null
    open var PriceLow:BigDecimal? = null
    open var PriceHigh:BigDecimal? = null
    open var Is100GreatestUSCoins:Int? = null
    open var Is100GreatestUSPaperMoney:Int? = null
    open var Is100GreatestWorldPaperMoney:Int? = null
    open var Is100GreatestModernUsCoins:Int? = null
    open var IsRedbook:Boolean? = null
    open var IsCherryPicker:Boolean? = null
    open var RootNode_Id:Long? = null
    open var ParentNode_Id:Long? = null
    open var ParentNodeName:String? = null
    open var SortingPosition:Int? = null
    open var CatalogPath:ArrayList<NodeDto>? = null
}

open class NodeDto
{
    open var Id:Long? = null
    open var Name:String? = null
    open var Description:String? = null
    open var FeaturedImageUrl:String? = null
    open var FeaturedImageAttribution:String? = null
    open var FlagCode:String? = null
    open var CountryName:String? = null
    open var SortingPosition:Int? = null
    open var NodeChildrenCountLive:Int? = null
    open var CollectibleChildrenCountLive:Int? = null
    open var ParentNode_Id:Long? = null
    open var RootNode_Id:Long? = null
    open var ChildNodes:ArrayList<NodeDto>? = null
}

Kotlin 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: publicapiv2dev.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>