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.

**GetCollectibleRequest** Parameters:
Name	Parameter	Data Type	Required	Description
GsId	query	long	No
ApiLevel	query	string	No

**CollectibleResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<CollectibleDto>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Total	form	int	No
OpCode	form	int	No
ErrorText	form	string	No
RequestTime	form	string	No
ResponseTime	form	string	No
TotalExecutionTime	form	string	No
CachedResponse	form	bool	No
PermitAccess	form	bool	No
AccessDeniedMessage	form	string	No

**CollectibleDto** Parameters:
Name	Parameter	Data Type	Required
Gsid	form	long	No
UiParentId	form	long?	No
Name	form	string	No
PcgsNumber	form	string	No
FriedbergNumber	form	string	No
CoinDate	form	string	No
DenominationShort	form	string	No
DenominationLong	form	string	No
Variety	form	string	No
Variety2	form	string	No
Desg	form	string	No
Other	form	string	No
Prefix	form	string	No
MintMark	form	string	No
Composition	form	string	No
Mintage	form	string	No
StrikeType	form	string	No
Diameter	form	string	No
Fineness	form	string	No
WeightGrams	form	decimal	No
WeightOunces	form	decimal	No
Designer	form	string	No
Edge	form	string	No
Rarity	form	string	No
CoinShape	form	string	No
Description	form	string	No
GeneralNotes	form	string	No
GeneralNotesSource	form	string	No
GeneralCoinLettering	form	string	No
ObverseDescription	form	string	No
ObverseDesigner	form	string	No
ObverseLettering	form	string	No
ReverseDescription	form	string	No
ReverseDesigner	form	string	No
ReverseLettering	form	string	No
BnBNumber	form	string	No
NoteColor	form	string	No
NoteDimension	form	string	No
PickNumber	form	string	No
Watermark	form	string	No
Printer	form	string	No
NoteSecurityThread	form	string	No
NotePaperType	form	string	No
BnbSignatureName1	form	string	No
BnbSignatureName2	form	string	No
BnbSignatureName3	form	string	No
ObsoleteBankId	form	string	No
ObsoleteStateName	form	string	No
ObsoleteCityName	form	string	No
ObsoleteBankName	form	string	No
HaxbyNumber	form	string	No
BnbTitle	form	string	No
IssueNumber	form	string	No
IssueMonth	form	int	No
IssueYear	form	int	No
Variant	form	string	No
ArtComment1	form	string	No
ArtComment2	form	string	No
ArtComment3	form	string	No
KeyComment1	form	string	No
KeyComment2	form	string	No
KeyComment3	form	string	No
Ngc	form	string	No
Krause	form	string	No
EbayCategory1	form	int	No
FeaturedImageUrl	form	string	No
FeaturedImageAttribution	form	string	No
IsType	form	bool	No
IsSet	form	bool	No
PriceLow	form	decimal	No
PriceHigh	form	decimal	No
Is100GreatestUSCoins	form	int	No
Is100GreatestUSPaperMoney	form	int	No
Is100GreatestWorldPaperMoney	form	int	No
Is100GreatestModernUsCoins	form	int	No
IsRedbook	form	bool	No
IsCherryPicker	form	bool	No
RootNode_Id	form	long	No
ParentNode_Id	form	long	No
ParentNodeName	form	string	No
SortingPosition	form	int	No
CatalogPath	form	List<NodeDto>	No

**NodeDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Name	form	string	No
Description	form	string	No
FeaturedImageUrl	form	string	No
FeaturedImageAttribution	form	string	No
FlagCode	form	string	No
CountryName	form	string	No
SortingPosition	form	int	No
NodeChildrenCountLive	form	int	No
CollectibleChildrenCountLive	form	int	No
ParentNode_Id	form	long?	No
RootNode_Id	form	long?	No
ChildNodes	form	List<NodeDto>	No

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>