| GET | /GetCollectibleRequest | Specify ApiLevel=Advanced for additional collectible information. |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse:
total: int = 0
op_code: int = 0
error_text: Optional[str] = None
request_time: Optional[str] = None
response_time: Optional[str] = None
total_execution_time: Optional[str] = None
cached_response: bool = False
permit_access: bool = False
access_denied_message: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NodeDto:
id: int = 0
name: Optional[str] = None
description: Optional[str] = None
featured_image_url: Optional[str] = None
featured_image_attribution: Optional[str] = None
flag_code: Optional[str] = None
country_name: Optional[str] = None
sorting_position: int = 0
node_children_count_live: int = 0
collectible_children_count_live: int = 0
parent_node__id: Optional[int] = None
root_node__id: Optional[int] = None
child_nodes: Optional[List[NodeDto]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CollectibleDto:
gsid: int = 0
ui_parent_id: Optional[int] = None
name: Optional[str] = None
pcgs_number: Optional[str] = None
friedberg_number: Optional[str] = None
coin_date: Optional[str] = None
denomination_short: Optional[str] = None
denomination_long: Optional[str] = None
variety: Optional[str] = None
variety2: Optional[str] = None
desg: Optional[str] = None
other: Optional[str] = None
prefix: Optional[str] = None
mint_mark: Optional[str] = None
composition: Optional[str] = None
mintage: Optional[str] = None
strike_type: Optional[str] = None
diameter: Optional[str] = None
fineness: Optional[str] = None
weight_grams: Decimal = decimal.Decimal(0)
weight_ounces: Decimal = decimal.Decimal(0)
designer: Optional[str] = None
edge: Optional[str] = None
rarity: Optional[str] = None
coin_shape: Optional[str] = None
description: Optional[str] = None
general_notes: Optional[str] = None
general_notes_source: Optional[str] = None
general_coin_lettering: Optional[str] = None
obverse_description: Optional[str] = None
obverse_designer: Optional[str] = None
obverse_lettering: Optional[str] = None
reverse_description: Optional[str] = None
reverse_designer: Optional[str] = None
reverse_lettering: Optional[str] = None
bn_b_number: Optional[str] = None
note_color: Optional[str] = None
note_dimension: Optional[str] = None
pick_number: Optional[str] = None
watermark: Optional[str] = None
printer: Optional[str] = None
note_security_thread: Optional[str] = None
note_paper_type: Optional[str] = None
bnb_signature_name1: Optional[str] = None
bnb_signature_name2: Optional[str] = None
bnb_signature_name3: Optional[str] = None
obsolete_bank_id: Optional[str] = None
obsolete_state_name: Optional[str] = None
obsolete_city_name: Optional[str] = None
obsolete_bank_name: Optional[str] = None
haxby_number: Optional[str] = None
bnb_title: Optional[str] = None
issue_number: Optional[str] = None
issue_month: int = 0
issue_year: int = 0
variant: Optional[str] = None
art_comment1: Optional[str] = None
art_comment2: Optional[str] = None
art_comment3: Optional[str] = None
key_comment1: Optional[str] = None
key_comment2: Optional[str] = None
key_comment3: Optional[str] = None
ngc: Optional[str] = None
krause: Optional[str] = None
ebay_category1: int = 0
featured_image_url: Optional[str] = None
featured_image_attribution: Optional[str] = None
is_type: bool = False
is_set: bool = False
price_low: Decimal = decimal.Decimal(0)
price_high: Decimal = decimal.Decimal(0)
is100_greatest_u_s_coins: int = 0
is100_greatest_u_s_paper_money: int = 0
is100_greatest_world_paper_money: int = 0
is100_greatest_modern_us_coins: int = 0
is_redbook: bool = False
is_cherry_picker: bool = False
root_node__id: int = 0
parent_node__id: int = 0
parent_node_name: Optional[str] = None
sorting_position: int = 0
catalog_path: Optional[List[NodeDto]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CollectibleResponse(BaseResponse):
data: Optional[List[CollectibleDto]] = None
# @Api(Description="Retrieve collectible(s)")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCollectibleRequest:
"""
Retrieve collectible(s)
"""
gs_id: int = 0
api_level: Optional[str] = None
Python GetCollectibleRequest 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 /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
}