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