| GET | /GetCollectibleRequest | Specify 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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>