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.*;

public class dtos
{

    /**
    * Retrieve collectible(s)
    */
    @Api(Description="Retrieve collectible(s)")
    public static class GetCollectibleRequest
    {
        public Long GsId = null;
        public String ApiLevel = null;
        
        public Long getGsId() { return GsId; }
        public GetCollectibleRequest setGsId(Long value) { this.GsId = value; return this; }
        public String getApiLevel() { return ApiLevel; }
        public GetCollectibleRequest setApiLevel(String value) { this.ApiLevel = value; return this; }
    }

    public static class CollectibleResponse extends BaseResponse
    {
        public ArrayList<CollectibleDto> Data = null;
        
        public ArrayList<CollectibleDto> getData() { return Data; }
        public CollectibleResponse setData(ArrayList<CollectibleDto> value) { this.Data = value; return this; }
    }

    public static class BaseResponse
    {
        public Integer Total = null;
        public Integer OpCode = null;
        public String ErrorText = null;
        public String RequestTime = null;
        public String ResponseTime = null;
        public String TotalExecutionTime = null;
        public Boolean CachedResponse = null;
        public Boolean PermitAccess = null;
        public String AccessDeniedMessage = null;
        
        public Integer getTotal() { return Total; }
        public BaseResponse setTotal(Integer value) { this.Total = value; return this; }
        public Integer getOpCode() { return OpCode; }
        public BaseResponse setOpCode(Integer value) { this.OpCode = value; return this; }
        public String getErrorText() { return ErrorText; }
        public BaseResponse setErrorText(String value) { this.ErrorText = value; return this; }
        public String getRequestTime() { return RequestTime; }
        public BaseResponse setRequestTime(String value) { this.RequestTime = value; return this; }
        public String getResponseTime() { return ResponseTime; }
        public BaseResponse setResponseTime(String value) { this.ResponseTime = value; return this; }
        public String getTotalExecutionTime() { return TotalExecutionTime; }
        public BaseResponse setTotalExecutionTime(String value) { this.TotalExecutionTime = value; return this; }
        public Boolean isCachedResponse() { return CachedResponse; }
        public BaseResponse setCachedResponse(Boolean value) { this.CachedResponse = value; return this; }
        public Boolean isPermitAccess() { return PermitAccess; }
        public BaseResponse setPermitAccess(Boolean value) { this.PermitAccess = value; return this; }
        public String getAccessDeniedMessage() { return AccessDeniedMessage; }
        public BaseResponse setAccessDeniedMessage(String value) { this.AccessDeniedMessage = value; return this; }
    }

    public static class CollectibleDto
    {
        public Long Gsid = null;
        public Long UiParentId = null;
        public String Name = null;
        public String PcgsNumber = null;
        public String FriedbergNumber = null;
        public String CoinDate = null;
        public String DenominationShort = null;
        public String DenominationLong = null;
        public String Variety = null;
        public String Variety2 = null;
        public String Desg = null;
        public String Other = null;
        public String Prefix = null;
        public String MintMark = null;
        public String Composition = null;
        public String Mintage = null;
        public String StrikeType = null;
        public String Diameter = null;
        public String Fineness = null;
        public BigDecimal WeightGrams = null;
        public BigDecimal WeightOunces = null;
        public String Designer = null;
        public String Edge = null;
        public String Rarity = null;
        public String CoinShape = null;
        public String Description = null;
        public String GeneralNotes = null;
        public String GeneralNotesSource = null;
        public String GeneralCoinLettering = null;
        public String ObverseDescription = null;
        public String ObverseDesigner = null;
        public String ObverseLettering = null;
        public String ReverseDescription = null;
        public String ReverseDesigner = null;
        public String ReverseLettering = null;
        public String BnBNumber = null;
        public String NoteColor = null;
        public String NoteDimension = null;
        public String PickNumber = null;
        public String Watermark = null;
        public String Printer = null;
        public String NoteSecurityThread = null;
        public String NotePaperType = null;
        public String BnbSignatureName1 = null;
        public String BnbSignatureName2 = null;
        public String BnbSignatureName3 = null;
        public String ObsoleteBankId = null;
        public String ObsoleteStateName = null;
        public String ObsoleteCityName = null;
        public String ObsoleteBankName = null;
        public String HaxbyNumber = null;
        public String BnbTitle = null;
        public String IssueNumber = null;
        public Integer IssueMonth = null;
        public Integer IssueYear = null;
        public String Variant = null;
        public String ArtComment1 = null;
        public String ArtComment2 = null;
        public String ArtComment3 = null;
        public String KeyComment1 = null;
        public String KeyComment2 = null;
        public String KeyComment3 = null;
        public String Ngc = null;
        public String Krause = null;
        public Integer EbayCategory1 = null;
        public String FeaturedImageUrl = null;
        public String FeaturedImageAttribution = null;
        public Boolean IsType = null;
        public Boolean IsSet = null;
        public BigDecimal PriceLow = null;
        public BigDecimal PriceHigh = null;
        public Integer Is100GreatestUSCoins = null;
        public Integer Is100GreatestUSPaperMoney = null;
        public Integer Is100GreatestWorldPaperMoney = null;
        public Integer Is100GreatestModernUsCoins = null;
        public Boolean IsRedbook = null;
        public Boolean IsCherryPicker = null;
        public Long RootNode_Id = null;
        public Long ParentNode_Id = null;
        public String ParentNodeName = null;
        public Integer SortingPosition = null;
        public ArrayList<NodeDto> CatalogPath = null;
        
        public Long getGsid() { return Gsid; }
        public CollectibleDto setGsid(Long value) { this.Gsid = value; return this; }
        public Long getUiParentId() { return UiParentId; }
        public CollectibleDto setUiParentId(Long value) { this.UiParentId = value; return this; }
        public String getName() { return Name; }
        public CollectibleDto setName(String value) { this.Name = value; return this; }
        public String getPcgsNumber() { return PcgsNumber; }
        public CollectibleDto setPcgsNumber(String value) { this.PcgsNumber = value; return this; }
        public String getFriedbergNumber() { return FriedbergNumber; }
        public CollectibleDto setFriedbergNumber(String value) { this.FriedbergNumber = value; return this; }
        public String getCoinDate() { return CoinDate; }
        public CollectibleDto setCoinDate(String value) { this.CoinDate = value; return this; }
        public String getDenominationShort() { return DenominationShort; }
        public CollectibleDto setDenominationShort(String value) { this.DenominationShort = value; return this; }
        public String getDenominationLong() { return DenominationLong; }
        public CollectibleDto setDenominationLong(String value) { this.DenominationLong = value; return this; }
        public String getVariety() { return Variety; }
        public CollectibleDto setVariety(String value) { this.Variety = value; return this; }
        public String getVariety2() { return Variety2; }
        public CollectibleDto setVariety2(String value) { this.Variety2 = value; return this; }
        public String getDesg() { return Desg; }
        public CollectibleDto setDesg(String value) { this.Desg = value; return this; }
        public String getOther() { return Other; }
        public CollectibleDto setOther(String value) { this.Other = value; return this; }
        public String getPrefix() { return Prefix; }
        public CollectibleDto setPrefix(String value) { this.Prefix = value; return this; }
        public String getMintMark() { return MintMark; }
        public CollectibleDto setMintMark(String value) { this.MintMark = value; return this; }
        public String getComposition() { return Composition; }
        public CollectibleDto setComposition(String value) { this.Composition = value; return this; }
        public String getMintage() { return Mintage; }
        public CollectibleDto setMintage(String value) { this.Mintage = value; return this; }
        public String getStrikeType() { return StrikeType; }
        public CollectibleDto setStrikeType(String value) { this.StrikeType = value; return this; }
        public String getDiameter() { return Diameter; }
        public CollectibleDto setDiameter(String value) { this.Diameter = value; return this; }
        public String getFineness() { return Fineness; }
        public CollectibleDto setFineness(String value) { this.Fineness = value; return this; }
        public BigDecimal getWeightGrams() { return WeightGrams; }
        public CollectibleDto setWeightGrams(BigDecimal value) { this.WeightGrams = value; return this; }
        public BigDecimal getWeightOunces() { return WeightOunces; }
        public CollectibleDto setWeightOunces(BigDecimal value) { this.WeightOunces = value; return this; }
        public String getDesigner() { return Designer; }
        public CollectibleDto setDesigner(String value) { this.Designer = value; return this; }
        public String getEdge() { return Edge; }
        public CollectibleDto setEdge(String value) { this.Edge = value; return this; }
        public String getRarity() { return Rarity; }
        public CollectibleDto setRarity(String value) { this.Rarity = value; return this; }
        public String getCoinShape() { return CoinShape; }
        public CollectibleDto setCoinShape(String value) { this.CoinShape = value; return this; }
        public String getDescription() { return Description; }
        public CollectibleDto setDescription(String value) { this.Description = value; return this; }
        public String getGeneralNotes() { return GeneralNotes; }
        public CollectibleDto setGeneralNotes(String value) { this.GeneralNotes = value; return this; }
        public String getGeneralNotesSource() { return GeneralNotesSource; }
        public CollectibleDto setGeneralNotesSource(String value) { this.GeneralNotesSource = value; return this; }
        public String getGeneralCoinLettering() { return GeneralCoinLettering; }
        public CollectibleDto setGeneralCoinLettering(String value) { this.GeneralCoinLettering = value; return this; }
        public String getObverseDescription() { return ObverseDescription; }
        public CollectibleDto setObverseDescription(String value) { this.ObverseDescription = value; return this; }
        public String getObverseDesigner() { return ObverseDesigner; }
        public CollectibleDto setObverseDesigner(String value) { this.ObverseDesigner = value; return this; }
        public String getObverseLettering() { return ObverseLettering; }
        public CollectibleDto setObverseLettering(String value) { this.ObverseLettering = value; return this; }
        public String getReverseDescription() { return ReverseDescription; }
        public CollectibleDto setReverseDescription(String value) { this.ReverseDescription = value; return this; }
        public String getReverseDesigner() { return ReverseDesigner; }
        public CollectibleDto setReverseDesigner(String value) { this.ReverseDesigner = value; return this; }
        public String getReverseLettering() { return ReverseLettering; }
        public CollectibleDto setReverseLettering(String value) { this.ReverseLettering = value; return this; }
        public String getBnBNumber() { return BnBNumber; }
        public CollectibleDto setBnBNumber(String value) { this.BnBNumber = value; return this; }
        public String getNoteColor() { return NoteColor; }
        public CollectibleDto setNoteColor(String value) { this.NoteColor = value; return this; }
        public String getNoteDimension() { return NoteDimension; }
        public CollectibleDto setNoteDimension(String value) { this.NoteDimension = value; return this; }
        public String getPickNumber() { return PickNumber; }
        public CollectibleDto setPickNumber(String value) { this.PickNumber = value; return this; }
        public String getWatermark() { return Watermark; }
        public CollectibleDto setWatermark(String value) { this.Watermark = value; return this; }
        public String getPrinter() { return Printer; }
        public CollectibleDto setPrinter(String value) { this.Printer = value; return this; }
        public String getNoteSecurityThread() { return NoteSecurityThread; }
        public CollectibleDto setNoteSecurityThread(String value) { this.NoteSecurityThread = value; return this; }
        public String getNotePaperType() { return NotePaperType; }
        public CollectibleDto setNotePaperType(String value) { this.NotePaperType = value; return this; }
        public String getBnbSignatureName1() { return BnbSignatureName1; }
        public CollectibleDto setBnbSignatureName1(String value) { this.BnbSignatureName1 = value; return this; }
        public String getBnbSignatureName2() { return BnbSignatureName2; }
        public CollectibleDto setBnbSignatureName2(String value) { this.BnbSignatureName2 = value; return this; }
        public String getBnbSignatureName3() { return BnbSignatureName3; }
        public CollectibleDto setBnbSignatureName3(String value) { this.BnbSignatureName3 = value; return this; }
        public String getObsoleteBankId() { return ObsoleteBankId; }
        public CollectibleDto setObsoleteBankId(String value) { this.ObsoleteBankId = value; return this; }
        public String getObsoleteStateName() { return ObsoleteStateName; }
        public CollectibleDto setObsoleteStateName(String value) { this.ObsoleteStateName = value; return this; }
        public String getObsoleteCityName() { return ObsoleteCityName; }
        public CollectibleDto setObsoleteCityName(String value) { this.ObsoleteCityName = value; return this; }
        public String getObsoleteBankName() { return ObsoleteBankName; }
        public CollectibleDto setObsoleteBankName(String value) { this.ObsoleteBankName = value; return this; }
        public String getHaxbyNumber() { return HaxbyNumber; }
        public CollectibleDto setHaxbyNumber(String value) { this.HaxbyNumber = value; return this; }
        public String getBnbTitle() { return BnbTitle; }
        public CollectibleDto setBnbTitle(String value) { this.BnbTitle = value; return this; }
        public String getIssueNumber() { return IssueNumber; }
        public CollectibleDto setIssueNumber(String value) { this.IssueNumber = value; return this; }
        public Integer getIssueMonth() { return IssueMonth; }
        public CollectibleDto setIssueMonth(Integer value) { this.IssueMonth = value; return this; }
        public Integer getIssueYear() { return IssueYear; }
        public CollectibleDto setIssueYear(Integer value) { this.IssueYear = value; return this; }
        public String getVariant() { return Variant; }
        public CollectibleDto setVariant(String value) { this.Variant = value; return this; }
        public String getArtComment1() { return ArtComment1; }
        public CollectibleDto setArtComment1(String value) { this.ArtComment1 = value; return this; }
        public String getArtComment2() { return ArtComment2; }
        public CollectibleDto setArtComment2(String value) { this.ArtComment2 = value; return this; }
        public String getArtComment3() { return ArtComment3; }
        public CollectibleDto setArtComment3(String value) { this.ArtComment3 = value; return this; }
        public String getKeyComment1() { return KeyComment1; }
        public CollectibleDto setKeyComment1(String value) { this.KeyComment1 = value; return this; }
        public String getKeyComment2() { return KeyComment2; }
        public CollectibleDto setKeyComment2(String value) { this.KeyComment2 = value; return this; }
        public String getKeyComment3() { return KeyComment3; }
        public CollectibleDto setKeyComment3(String value) { this.KeyComment3 = value; return this; }
        public String getNgc() { return Ngc; }
        public CollectibleDto setNgc(String value) { this.Ngc = value; return this; }
        public String getKrause() { return Krause; }
        public CollectibleDto setKrause(String value) { this.Krause = value; return this; }
        public Integer getEbayCategory1() { return EbayCategory1; }
        public CollectibleDto setEbayCategory1(Integer value) { this.EbayCategory1 = value; return this; }
        public String getFeaturedImageUrl() { return FeaturedImageUrl; }
        public CollectibleDto setFeaturedImageUrl(String value) { this.FeaturedImageUrl = value; return this; }
        public String getFeaturedImageAttribution() { return FeaturedImageAttribution; }
        public CollectibleDto setFeaturedImageAttribution(String value) { this.FeaturedImageAttribution = value; return this; }
        public Boolean getIsType() { return IsType; }
        public CollectibleDto setIsType(Boolean value) { this.IsType = value; return this; }
        public Boolean getIsSet() { return IsSet; }
        public CollectibleDto setIsSet(Boolean value) { this.IsSet = value; return this; }
        public BigDecimal getPriceLow() { return PriceLow; }
        public CollectibleDto setPriceLow(BigDecimal value) { this.PriceLow = value; return this; }
        public BigDecimal getPriceHigh() { return PriceHigh; }
        public CollectibleDto setPriceHigh(BigDecimal value) { this.PriceHigh = value; return this; }
        public Integer getIs100GreatestUSCoins() { return Is100GreatestUSCoins; }
        public CollectibleDto setIs100GreatestUSCoins(Integer value) { this.Is100GreatestUSCoins = value; return this; }
        public Integer getIs100GreatestUSPaperMoney() { return Is100GreatestUSPaperMoney; }
        public CollectibleDto setIs100GreatestUSPaperMoney(Integer value) { this.Is100GreatestUSPaperMoney = value; return this; }
        public Integer getIs100GreatestWorldPaperMoney() { return Is100GreatestWorldPaperMoney; }
        public CollectibleDto setIs100GreatestWorldPaperMoney(Integer value) { this.Is100GreatestWorldPaperMoney = value; return this; }
        public Integer getIs100GreatestModernUsCoins() { return Is100GreatestModernUsCoins; }
        public CollectibleDto setIs100GreatestModernUsCoins(Integer value) { this.Is100GreatestModernUsCoins = value; return this; }
        public Boolean getIsRedbook() { return IsRedbook; }
        public CollectibleDto setIsRedbook(Boolean value) { this.IsRedbook = value; return this; }
        public Boolean getIsCherryPicker() { return IsCherryPicker; }
        public CollectibleDto setIsCherryPicker(Boolean value) { this.IsCherryPicker = value; return this; }
        public Long getRootNodeId() { return RootNode_Id; }
        public CollectibleDto setRootNodeId(Long value) { this.RootNode_Id = value; return this; }
        public Long getParentNodeId() { return ParentNode_Id; }
        public CollectibleDto setParentNodeId(Long value) { this.ParentNode_Id = value; return this; }
        public String getParentNodeName() { return ParentNodeName; }
        public CollectibleDto setParentNodeName(String value) { this.ParentNodeName = value; return this; }
        public Integer getSortingPosition() { return SortingPosition; }
        public CollectibleDto setSortingPosition(Integer value) { this.SortingPosition = value; return this; }
        public ArrayList<NodeDto> getCatalogPath() { return CatalogPath; }
        public CollectibleDto setCatalogPath(ArrayList<NodeDto> value) { this.CatalogPath = value; return this; }
    }

    public static class NodeDto
    {
        public Long Id = null;
        public String Name = null;
        public String Description = null;
        public String FeaturedImageUrl = null;
        public String FeaturedImageAttribution = null;
        public String FlagCode = null;
        public String CountryName = null;
        public Integer SortingPosition = null;
        public Integer NodeChildrenCountLive = null;
        public Integer CollectibleChildrenCountLive = null;
        public Long ParentNode_Id = null;
        public Long RootNode_Id = null;
        public ArrayList<NodeDto> ChildNodes = null;
        
        public Long getId() { return Id; }
        public NodeDto setId(Long value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public NodeDto setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public NodeDto setDescription(String value) { this.Description = value; return this; }
        public String getFeaturedImageUrl() { return FeaturedImageUrl; }
        public NodeDto setFeaturedImageUrl(String value) { this.FeaturedImageUrl = value; return this; }
        public String getFeaturedImageAttribution() { return FeaturedImageAttribution; }
        public NodeDto setFeaturedImageAttribution(String value) { this.FeaturedImageAttribution = value; return this; }
        public String getFlagCode() { return FlagCode; }
        public NodeDto setFlagCode(String value) { this.FlagCode = value; return this; }
        public String getCountryName() { return CountryName; }
        public NodeDto setCountryName(String value) { this.CountryName = value; return this; }
        public Integer getSortingPosition() { return SortingPosition; }
        public NodeDto setSortingPosition(Integer value) { this.SortingPosition = value; return this; }
        public Integer getNodeChildrenCountLive() { return NodeChildrenCountLive; }
        public NodeDto setNodeChildrenCountLive(Integer value) { this.NodeChildrenCountLive = value; return this; }
        public Integer getCollectibleChildrenCountLive() { return CollectibleChildrenCountLive; }
        public NodeDto setCollectibleChildrenCountLive(Integer value) { this.CollectibleChildrenCountLive = value; return this; }
        public Long getParentNodeId() { return ParentNode_Id; }
        public NodeDto setParentNodeId(Long value) { this.ParentNode_Id = value; return this; }
        public Long getRootNodeId() { return RootNode_Id; }
        public NodeDto setRootNodeId(Long value) { this.RootNode_Id = value; return this; }
        public ArrayList<NodeDto> getChildNodes() { return ChildNodes; }
        public NodeDto setChildNodes(ArrayList<NodeDto> value) { this.ChildNodes = value; return this; }
    }

}

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