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.
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Cdn.PublicApiV2.RequestObjects;
using Cdn.PublicApiV2.ResponseObjects;
using Cdn.PublicApiV2.Dto;

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

    public partial class NodeDto
    {
        public virtual long Id { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual string FeaturedImageUrl { get; set; }
        public virtual string FeaturedImageAttribution { get; set; }
        public virtual string FlagCode { get; set; }
        public virtual string CountryName { get; set; }
        public virtual int SortingPosition { get; set; }
        public virtual int NodeChildrenCountLive { get; set; }
        public virtual int CollectibleChildrenCountLive { get; set; }
        public virtual long? ParentNode_Id { get; set; }
        public virtual long? RootNode_Id { get; set; }
        public virtual List<NodeDto> ChildNodes { get; set; }
    }

}

namespace Cdn.PublicApiV2.RequestObjects
{
    ///<summary>
    ///Retrieve collectible(s)
    ///</summary>
    [Api(Description="Retrieve collectible(s)")]
    public partial class GetCollectibleRequest
    {
        public virtual long GsId { get; set; }
        public virtual string ApiLevel { get; set; }
    }

}

namespace Cdn.PublicApiV2.ResponseObjects
{
    public partial class BaseResponse
    {
        public virtual int Total { get; set; }
        public virtual int OpCode { get; set; }
        public virtual string ErrorText { get; set; }
        public virtual string RequestTime { get; set; }
        public virtual string ResponseTime { get; set; }
        public virtual string TotalExecutionTime { get; set; }
        public virtual bool CachedResponse { get; set; }
        public virtual bool PermitAccess { get; set; }
        public virtual string AccessDeniedMessage { get; set; }
    }

    public partial class CollectibleResponse
        : BaseResponse
    {
        public virtual List<CollectibleDto> Data { get; set; }
    }

}

C# GetCollectibleRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			Gsid: 0,
			UiParentId: 0,
			Name: String,
			PcgsNumber: String,
			FriedbergNumber: String,
			CoinDate: String,
			DenominationShort: String,
			DenominationLong: String,
			Variety: String,
			Variety2: String,
			Desg: String,
			Other: String,
			Prefix: String,
			MintMark: String,
			Composition: String,
			Mintage: String,
			StrikeType: String,
			Diameter: String,
			Fineness: String,
			WeightGrams: 0,
			WeightOunces: 0,
			Designer: String,
			Edge: String,
			Rarity: String,
			CoinShape: String,
			Description: String,
			GeneralNotes: String,
			GeneralNotesSource: String,
			GeneralCoinLettering: String,
			ObverseDescription: String,
			ObverseDesigner: String,
			ObverseLettering: String,
			ReverseDescription: String,
			ReverseDesigner: String,
			ReverseLettering: String,
			BnBNumber: String,
			NoteColor: String,
			NoteDimension: String,
			PickNumber: String,
			Watermark: String,
			Printer: String,
			NoteSecurityThread: String,
			NotePaperType: String,
			BnbSignatureName1: String,
			BnbSignatureName2: String,
			BnbSignatureName3: String,
			ObsoleteBankId: String,
			ObsoleteStateName: String,
			ObsoleteCityName: String,
			ObsoleteBankName: String,
			HaxbyNumber: String,
			BnbTitle: String,
			IssueNumber: String,
			IssueMonth: 0,
			IssueYear: 0,
			Variant: String,
			ArtComment1: String,
			ArtComment2: String,
			ArtComment3: String,
			KeyComment1: String,
			KeyComment2: String,
			KeyComment3: String,
			Ngc: String,
			Krause: String,
			EbayCategory1: 0,
			FeaturedImageUrl: String,
			FeaturedImageAttribution: String,
			IsType: False,
			IsSet: False,
			PriceLow: 0,
			PriceHigh: 0,
			Is100GreatestUSCoins: 0,
			Is100GreatestUSPaperMoney: 0,
			Is100GreatestWorldPaperMoney: 0,
			Is100GreatestModernUsCoins: 0,
			IsRedbook: False,
			IsCherryPicker: False,
			RootNode_Id: 0,
			ParentNode_Id: 0,
			ParentNodeName: String,
			SortingPosition: 0,
			CatalogPath: 
			[
				{
					Id: 0,
					Name: String,
					Description: String,
					FeaturedImageUrl: String,
					FeaturedImageAttribution: String,
					FlagCode: String,
					CountryName: String,
					SortingPosition: 0,
					NodeChildrenCountLive: 0,
					CollectibleChildrenCountLive: 0,
					ParentNode_Id: 0,
					RootNode_Id: 0,
					ChildNodes: 
					[
						{
							Id: 0,
							Name: String,
							Description: String,
							FeaturedImageUrl: String,
							FeaturedImageAttribution: String,
							FlagCode: String,
							CountryName: String,
							SortingPosition: 0,
							NodeChildrenCountLive: 0,
							CollectibleChildrenCountLive: 0,
							ParentNode_Id: 0,
							RootNode_Id: 0,
							ChildNodes: 
							[
								{
									Id: 0,
									Name: String,
									Description: String,
									FeaturedImageUrl: String,
									FeaturedImageAttribution: String,
									FlagCode: String,
									CountryName: String,
									SortingPosition: 0,
									NodeChildrenCountLive: 0,
									CollectibleChildrenCountLive: 0,
									ParentNode_Id: 0,
									RootNode_Id: 0
								}
							]
						}
					]
				}
			]
		}
	],
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False,
	PermitAccess: False,
	AccessDeniedMessage: String
}