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 .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
}