| GET | /GetCollectibleByNodeRequest | Specify ApiLevel=Advanced for additional collectible information. |
|---|
"use strict";
export class BaseResponse {
/** @param {{Total?:number,OpCode?:number,ErrorText?:string,RequestTime?:string,ResponseTime?:string,TotalExecutionTime?:string,CachedResponse?:boolean,PermitAccess?:boolean,AccessDeniedMessage?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Total;
/** @type {number} */
OpCode;
/** @type {string} */
ErrorText;
/** @type {string} */
RequestTime;
/** @type {string} */
ResponseTime;
/** @type {string} */
TotalExecutionTime;
/** @type {boolean} */
CachedResponse;
/** @type {boolean} */
PermitAccess;
/** @type {string} */
AccessDeniedMessage;
}
export class NodeDto {
/** @param {{Id?:number,Name?:string,Description?:string,FeaturedImageUrl?:string,FeaturedImageAttribution?:string,FlagCode?:string,CountryName?:string,SortingPosition?:number,NodeChildrenCountLive?:number,CollectibleChildrenCountLive?:number,ParentNode_Id?:number,RootNode_Id?:number,ChildNodes?:NodeDto[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {string} */
FeaturedImageUrl;
/** @type {string} */
FeaturedImageAttribution;
/** @type {string} */
FlagCode;
/** @type {string} */
CountryName;
/** @type {number} */
SortingPosition;
/** @type {number} */
NodeChildrenCountLive;
/** @type {number} */
CollectibleChildrenCountLive;
/** @type {?number} */
ParentNode_Id;
/** @type {?number} */
RootNode_Id;
/** @type {NodeDto[]} */
ChildNodes;
}
export class CollectibleDto {
/** @param {{Gsid?:number,UiParentId?:number,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?:number,WeightOunces?:number,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?:number,IssueYear?:number,Variant?:string,ArtComment1?:string,ArtComment2?:string,ArtComment3?:string,KeyComment1?:string,KeyComment2?:string,KeyComment3?:string,Ngc?:string,Krause?:string,EbayCategory1?:number,FeaturedImageUrl?:string,FeaturedImageAttribution?:string,IsType?:boolean,IsSet?:boolean,PriceLow?:number,PriceHigh?:number,Is100GreatestUSCoins?:number,Is100GreatestUSPaperMoney?:number,Is100GreatestWorldPaperMoney?:number,Is100GreatestModernUsCoins?:number,IsRedbook?:boolean,IsCherryPicker?:boolean,RootNode_Id?:number,ParentNode_Id?:number,ParentNodeName?:string,SortingPosition?:number,CatalogPath?:NodeDto[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Gsid;
/** @type {?number} */
UiParentId;
/** @type {string} */
Name;
/** @type {string} */
PcgsNumber;
/** @type {string} */
FriedbergNumber;
/** @type {string} */
CoinDate;
/** @type {string} */
DenominationShort;
/** @type {string} */
DenominationLong;
/** @type {string} */
Variety;
/** @type {string} */
Variety2;
/** @type {string} */
Desg;
/** @type {string} */
Other;
/** @type {string} */
Prefix;
/** @type {string} */
MintMark;
/** @type {string} */
Composition;
/** @type {string} */
Mintage;
/** @type {string} */
StrikeType;
/** @type {string} */
Diameter;
/** @type {string} */
Fineness;
/** @type {number} */
WeightGrams;
/** @type {number} */
WeightOunces;
/** @type {string} */
Designer;
/** @type {string} */
Edge;
/** @type {string} */
Rarity;
/** @type {string} */
CoinShape;
/** @type {string} */
Description;
/** @type {string} */
GeneralNotes;
/** @type {string} */
GeneralNotesSource;
/** @type {string} */
GeneralCoinLettering;
/** @type {string} */
ObverseDescription;
/** @type {string} */
ObverseDesigner;
/** @type {string} */
ObverseLettering;
/** @type {string} */
ReverseDescription;
/** @type {string} */
ReverseDesigner;
/** @type {string} */
ReverseLettering;
/** @type {string} */
BnBNumber;
/** @type {string} */
NoteColor;
/** @type {string} */
NoteDimension;
/** @type {string} */
PickNumber;
/** @type {string} */
Watermark;
/** @type {string} */
Printer;
/** @type {string} */
NoteSecurityThread;
/** @type {string} */
NotePaperType;
/** @type {string} */
BnbSignatureName1;
/** @type {string} */
BnbSignatureName2;
/** @type {string} */
BnbSignatureName3;
/** @type {string} */
ObsoleteBankId;
/** @type {string} */
ObsoleteStateName;
/** @type {string} */
ObsoleteCityName;
/** @type {string} */
ObsoleteBankName;
/** @type {string} */
HaxbyNumber;
/** @type {string} */
BnbTitle;
/** @type {string} */
IssueNumber;
/** @type {number} */
IssueMonth;
/** @type {number} */
IssueYear;
/** @type {string} */
Variant;
/** @type {string} */
ArtComment1;
/** @type {string} */
ArtComment2;
/** @type {string} */
ArtComment3;
/** @type {string} */
KeyComment1;
/** @type {string} */
KeyComment2;
/** @type {string} */
KeyComment3;
/** @type {string} */
Ngc;
/** @type {string} */
Krause;
/** @type {number} */
EbayCategory1;
/** @type {string} */
FeaturedImageUrl;
/** @type {string} */
FeaturedImageAttribution;
/** @type {boolean} */
IsType;
/** @type {boolean} */
IsSet;
/** @type {number} */
PriceLow;
/** @type {number} */
PriceHigh;
/** @type {number} */
Is100GreatestUSCoins;
/** @type {number} */
Is100GreatestUSPaperMoney;
/** @type {number} */
Is100GreatestWorldPaperMoney;
/** @type {number} */
Is100GreatestModernUsCoins;
/** @type {boolean} */
IsRedbook;
/** @type {boolean} */
IsCherryPicker;
/** @type {number} */
RootNode_Id;
/** @type {number} */
ParentNode_Id;
/** @type {string} */
ParentNodeName;
/** @type {number} */
SortingPosition;
/** @type {NodeDto[]} */
CatalogPath;
}
export class CollectibleResponse extends BaseResponse {
/** @param {{Data?:CollectibleDto[],Total?:number,OpCode?:number,ErrorText?:string,RequestTime?:string,ResponseTime?:string,TotalExecutionTime?:string,CachedResponse?:boolean,PermitAccess?:boolean,AccessDeniedMessage?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {CollectibleDto[]} */
Data;
}
export class GetCollectibleByNodeRequest {
/** @param {{NodeId?:number,ApiLevel?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
NodeId;
/** @type {string} */
ApiLevel;
}
JavaScript GetCollectibleByNodeRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /GetCollectibleByNodeRequest 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
}