Cdn Public Collector's Pricing Guide (CPG) API V2

<back to all web services

GetCollectibleByNodeRequest

Catalog

Get all collectibles for a given Node

The following routes are available for this service:
GET/GetCollectibleByNodeRequestSpecify ApiLevel=Advanced for additional collectible information.
import 'package:servicestack/servicestack.dart';

class BaseResponse implements IConvertible
{
    int? Total;
    int? OpCode;
    String? ErrorText;
    String? RequestTime;
    String? ResponseTime;
    String? TotalExecutionTime;
    bool? CachedResponse;
    bool? PermitAccess;
    String? AccessDeniedMessage;

    BaseResponse({this.Total,this.OpCode,this.ErrorText,this.RequestTime,this.ResponseTime,this.TotalExecutionTime,this.CachedResponse,this.PermitAccess,this.AccessDeniedMessage});
    BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Total = json['Total'];
        OpCode = json['OpCode'];
        ErrorText = json['ErrorText'];
        RequestTime = json['RequestTime'];
        ResponseTime = json['ResponseTime'];
        TotalExecutionTime = json['TotalExecutionTime'];
        CachedResponse = json['CachedResponse'];
        PermitAccess = json['PermitAccess'];
        AccessDeniedMessage = json['AccessDeniedMessage'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Total': Total,
        'OpCode': OpCode,
        'ErrorText': ErrorText,
        'RequestTime': RequestTime,
        'ResponseTime': ResponseTime,
        'TotalExecutionTime': TotalExecutionTime,
        'CachedResponse': CachedResponse,
        'PermitAccess': PermitAccess,
        'AccessDeniedMessage': AccessDeniedMessage
    };

    getTypeName() => "BaseResponse";
    TypeContext? context = _ctx;
}

class NodeDto implements IConvertible
{
    int? Id;
    String? Name;
    String? Description;
    String? FeaturedImageUrl;
    String? FeaturedImageAttribution;
    String? FlagCode;
    String? CountryName;
    int? SortingPosition;
    int? NodeChildrenCountLive;
    int? CollectibleChildrenCountLive;
    int? ParentNode_Id;
    int? RootNode_Id;
    List<NodeDto>? ChildNodes;

    NodeDto({this.Id,this.Name,this.Description,this.FeaturedImageUrl,this.FeaturedImageAttribution,this.FlagCode,this.CountryName,this.SortingPosition,this.NodeChildrenCountLive,this.CollectibleChildrenCountLive,this.ParentNode_Id,this.RootNode_Id,this.ChildNodes});
    NodeDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Name = json['Name'];
        Description = json['Description'];
        FeaturedImageUrl = json['FeaturedImageUrl'];
        FeaturedImageAttribution = json['FeaturedImageAttribution'];
        FlagCode = json['FlagCode'];
        CountryName = json['CountryName'];
        SortingPosition = json['SortingPosition'];
        NodeChildrenCountLive = json['NodeChildrenCountLive'];
        CollectibleChildrenCountLive = json['CollectibleChildrenCountLive'];
        ParentNode_Id = json['ParentNode_Id'];
        RootNode_Id = json['RootNode_Id'];
        ChildNodes = JsonConverters.fromJson(json['ChildNodes'],'List<NodeDto>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Name': Name,
        'Description': Description,
        'FeaturedImageUrl': FeaturedImageUrl,
        'FeaturedImageAttribution': FeaturedImageAttribution,
        'FlagCode': FlagCode,
        'CountryName': CountryName,
        'SortingPosition': SortingPosition,
        'NodeChildrenCountLive': NodeChildrenCountLive,
        'CollectibleChildrenCountLive': CollectibleChildrenCountLive,
        'ParentNode_Id': ParentNode_Id,
        'RootNode_Id': RootNode_Id,
        'ChildNodes': JsonConverters.toJson(ChildNodes,'List<NodeDto>',context!)
    };

    getTypeName() => "NodeDto";
    TypeContext? context = _ctx;
}

class CollectibleDto implements IConvertible
{
    int? Gsid;
    int? UiParentId;
    String? 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;
    double? WeightGrams;
    double? WeightOunces;
    String? 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;
    int? IssueMonth;
    int? IssueYear;
    String? Variant;
    String? ArtComment1;
    String? ArtComment2;
    String? ArtComment3;
    String? KeyComment1;
    String? KeyComment2;
    String? KeyComment3;
    String? Ngc;
    String? Krause;
    int? EbayCategory1;
    String? FeaturedImageUrl;
    String? FeaturedImageAttribution;
    bool? IsType;
    bool? IsSet;
    double? PriceLow;
    double? PriceHigh;
    int? Is100GreatestUSCoins;
    int? Is100GreatestUSPaperMoney;
    int? Is100GreatestWorldPaperMoney;
    int? Is100GreatestModernUsCoins;
    bool? IsRedbook;
    bool? IsCherryPicker;
    int? RootNode_Id;
    int? ParentNode_Id;
    String? ParentNodeName;
    int? SortingPosition;
    List<NodeDto>? CatalogPath;

    CollectibleDto({this.Gsid,this.UiParentId,this.Name,this.PcgsNumber,this.FriedbergNumber,this.CoinDate,this.DenominationShort,this.DenominationLong,this.Variety,this.Variety2,this.Desg,this.Other,this.Prefix,this.MintMark,this.Composition,this.Mintage,this.StrikeType,this.Diameter,this.Fineness,this.WeightGrams,this.WeightOunces,this.Designer,this.Edge,this.Rarity,this.CoinShape,this.Description,this.GeneralNotes,this.GeneralNotesSource,this.GeneralCoinLettering,this.ObverseDescription,this.ObverseDesigner,this.ObverseLettering,this.ReverseDescription,this.ReverseDesigner,this.ReverseLettering,this.BnBNumber,this.NoteColor,this.NoteDimension,this.PickNumber,this.Watermark,this.Printer,this.NoteSecurityThread,this.NotePaperType,this.BnbSignatureName1,this.BnbSignatureName2,this.BnbSignatureName3,this.ObsoleteBankId,this.ObsoleteStateName,this.ObsoleteCityName,this.ObsoleteBankName,this.HaxbyNumber,this.BnbTitle,this.IssueNumber,this.IssueMonth,this.IssueYear,this.Variant,this.ArtComment1,this.ArtComment2,this.ArtComment3,this.KeyComment1,this.KeyComment2,this.KeyComment3,this.Ngc,this.Krause,this.EbayCategory1,this.FeaturedImageUrl,this.FeaturedImageAttribution,this.IsType,this.IsSet,this.PriceLow,this.PriceHigh,this.Is100GreatestUSCoins,this.Is100GreatestUSPaperMoney,this.Is100GreatestWorldPaperMoney,this.Is100GreatestModernUsCoins,this.IsRedbook,this.IsCherryPicker,this.RootNode_Id,this.ParentNode_Id,this.ParentNodeName,this.SortingPosition,this.CatalogPath});
    CollectibleDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Gsid = json['Gsid'];
        UiParentId = json['UiParentId'];
        Name = json['Name'];
        PcgsNumber = json['PcgsNumber'];
        FriedbergNumber = json['FriedbergNumber'];
        CoinDate = json['CoinDate'];
        DenominationShort = json['DenominationShort'];
        DenominationLong = json['DenominationLong'];
        Variety = json['Variety'];
        Variety2 = json['Variety2'];
        Desg = json['Desg'];
        Other = json['Other'];
        Prefix = json['Prefix'];
        MintMark = json['MintMark'];
        Composition = json['Composition'];
        Mintage = json['Mintage'];
        StrikeType = json['StrikeType'];
        Diameter = json['Diameter'];
        Fineness = json['Fineness'];
        WeightGrams = JsonConverters.toDouble(json['WeightGrams']);
        WeightOunces = JsonConverters.toDouble(json['WeightOunces']);
        Designer = json['Designer'];
        Edge = json['Edge'];
        Rarity = json['Rarity'];
        CoinShape = json['CoinShape'];
        Description = json['Description'];
        GeneralNotes = json['GeneralNotes'];
        GeneralNotesSource = json['GeneralNotesSource'];
        GeneralCoinLettering = json['GeneralCoinLettering'];
        ObverseDescription = json['ObverseDescription'];
        ObverseDesigner = json['ObverseDesigner'];
        ObverseLettering = json['ObverseLettering'];
        ReverseDescription = json['ReverseDescription'];
        ReverseDesigner = json['ReverseDesigner'];
        ReverseLettering = json['ReverseLettering'];
        BnBNumber = json['BnBNumber'];
        NoteColor = json['NoteColor'];
        NoteDimension = json['NoteDimension'];
        PickNumber = json['PickNumber'];
        Watermark = json['Watermark'];
        Printer = json['Printer'];
        NoteSecurityThread = json['NoteSecurityThread'];
        NotePaperType = json['NotePaperType'];
        BnbSignatureName1 = json['BnbSignatureName1'];
        BnbSignatureName2 = json['BnbSignatureName2'];
        BnbSignatureName3 = json['BnbSignatureName3'];
        ObsoleteBankId = json['ObsoleteBankId'];
        ObsoleteStateName = json['ObsoleteStateName'];
        ObsoleteCityName = json['ObsoleteCityName'];
        ObsoleteBankName = json['ObsoleteBankName'];
        HaxbyNumber = json['HaxbyNumber'];
        BnbTitle = json['BnbTitle'];
        IssueNumber = json['IssueNumber'];
        IssueMonth = json['IssueMonth'];
        IssueYear = json['IssueYear'];
        Variant = json['Variant'];
        ArtComment1 = json['ArtComment1'];
        ArtComment2 = json['ArtComment2'];
        ArtComment3 = json['ArtComment3'];
        KeyComment1 = json['KeyComment1'];
        KeyComment2 = json['KeyComment2'];
        KeyComment3 = json['KeyComment3'];
        Ngc = json['Ngc'];
        Krause = json['Krause'];
        EbayCategory1 = json['EbayCategory1'];
        FeaturedImageUrl = json['FeaturedImageUrl'];
        FeaturedImageAttribution = json['FeaturedImageAttribution'];
        IsType = json['IsType'];
        IsSet = json['IsSet'];
        PriceLow = JsonConverters.toDouble(json['PriceLow']);
        PriceHigh = JsonConverters.toDouble(json['PriceHigh']);
        Is100GreatestUSCoins = json['Is100GreatestUSCoins'];
        Is100GreatestUSPaperMoney = json['Is100GreatestUSPaperMoney'];
        Is100GreatestWorldPaperMoney = json['Is100GreatestWorldPaperMoney'];
        Is100GreatestModernUsCoins = json['Is100GreatestModernUsCoins'];
        IsRedbook = json['IsRedbook'];
        IsCherryPicker = json['IsCherryPicker'];
        RootNode_Id = json['RootNode_Id'];
        ParentNode_Id = json['ParentNode_Id'];
        ParentNodeName = json['ParentNodeName'];
        SortingPosition = json['SortingPosition'];
        CatalogPath = JsonConverters.fromJson(json['CatalogPath'],'List<NodeDto>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Gsid': Gsid,
        'UiParentId': UiParentId,
        'Name': Name,
        'PcgsNumber': PcgsNumber,
        'FriedbergNumber': FriedbergNumber,
        'CoinDate': CoinDate,
        'DenominationShort': DenominationShort,
        'DenominationLong': DenominationLong,
        'Variety': Variety,
        'Variety2': Variety2,
        'Desg': Desg,
        'Other': Other,
        'Prefix': Prefix,
        'MintMark': MintMark,
        'Composition': Composition,
        'Mintage': Mintage,
        'StrikeType': StrikeType,
        'Diameter': Diameter,
        'Fineness': Fineness,
        'WeightGrams': WeightGrams,
        'WeightOunces': WeightOunces,
        'Designer': Designer,
        'Edge': Edge,
        'Rarity': Rarity,
        'CoinShape': CoinShape,
        'Description': Description,
        'GeneralNotes': GeneralNotes,
        'GeneralNotesSource': GeneralNotesSource,
        'GeneralCoinLettering': GeneralCoinLettering,
        'ObverseDescription': ObverseDescription,
        'ObverseDesigner': ObverseDesigner,
        'ObverseLettering': ObverseLettering,
        'ReverseDescription': ReverseDescription,
        'ReverseDesigner': ReverseDesigner,
        'ReverseLettering': ReverseLettering,
        'BnBNumber': BnBNumber,
        'NoteColor': NoteColor,
        'NoteDimension': NoteDimension,
        'PickNumber': PickNumber,
        'Watermark': Watermark,
        'Printer': Printer,
        'NoteSecurityThread': NoteSecurityThread,
        'NotePaperType': NotePaperType,
        'BnbSignatureName1': BnbSignatureName1,
        'BnbSignatureName2': BnbSignatureName2,
        'BnbSignatureName3': BnbSignatureName3,
        'ObsoleteBankId': ObsoleteBankId,
        'ObsoleteStateName': ObsoleteStateName,
        'ObsoleteCityName': ObsoleteCityName,
        'ObsoleteBankName': ObsoleteBankName,
        'HaxbyNumber': HaxbyNumber,
        'BnbTitle': BnbTitle,
        'IssueNumber': IssueNumber,
        'IssueMonth': IssueMonth,
        'IssueYear': IssueYear,
        'Variant': Variant,
        'ArtComment1': ArtComment1,
        'ArtComment2': ArtComment2,
        'ArtComment3': ArtComment3,
        'KeyComment1': KeyComment1,
        'KeyComment2': KeyComment2,
        'KeyComment3': KeyComment3,
        'Ngc': Ngc,
        'Krause': Krause,
        'EbayCategory1': EbayCategory1,
        'FeaturedImageUrl': FeaturedImageUrl,
        'FeaturedImageAttribution': FeaturedImageAttribution,
        'IsType': IsType,
        'IsSet': IsSet,
        'PriceLow': PriceLow,
        'PriceHigh': PriceHigh,
        'Is100GreatestUSCoins': Is100GreatestUSCoins,
        'Is100GreatestUSPaperMoney': Is100GreatestUSPaperMoney,
        'Is100GreatestWorldPaperMoney': Is100GreatestWorldPaperMoney,
        'Is100GreatestModernUsCoins': Is100GreatestModernUsCoins,
        'IsRedbook': IsRedbook,
        'IsCherryPicker': IsCherryPicker,
        'RootNode_Id': RootNode_Id,
        'ParentNode_Id': ParentNode_Id,
        'ParentNodeName': ParentNodeName,
        'SortingPosition': SortingPosition,
        'CatalogPath': JsonConverters.toJson(CatalogPath,'List<NodeDto>',context!)
    };

    getTypeName() => "CollectibleDto";
    TypeContext? context = _ctx;
}

class CollectibleResponse extends BaseResponse implements IConvertible
{
    List<CollectibleDto>? Data;

    CollectibleResponse({this.Data});
    CollectibleResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Data = JsonConverters.fromJson(json['Data'],'List<CollectibleDto>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Data': JsonConverters.toJson(Data,'List<CollectibleDto>',context!)
    });

    getTypeName() => "CollectibleResponse";
    TypeContext? context = _ctx;
}

/**
* Get all collectibles for a given Node
*/
// @Api(Description="Get all collectibles for a given Node")
class GetCollectibleByNodeRequest implements IConvertible
{
    int? NodeId;
    String? ApiLevel;

    GetCollectibleByNodeRequest({this.NodeId,this.ApiLevel});
    GetCollectibleByNodeRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        NodeId = json['NodeId'];
        ApiLevel = json['ApiLevel'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'NodeId': NodeId,
        'ApiLevel': ApiLevel
    };

    getTypeName() => "GetCollectibleByNodeRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'publicapiv2dev.greysheet.com', types: <String, TypeInfo> {
    'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
    'NodeDto': TypeInfo(TypeOf.Class, create:() => NodeDto()),
    'List<NodeDto>': TypeInfo(TypeOf.Class, create:() => <NodeDto>[]),
    'CollectibleDto': TypeInfo(TypeOf.Class, create:() => CollectibleDto()),
    'CollectibleResponse': TypeInfo(TypeOf.Class, create:() => CollectibleResponse()),
    'List<CollectibleDto>': TypeInfo(TypeOf.Class, create:() => <CollectibleDto>[]),
    'GetCollectibleByNodeRequest': TypeInfo(TypeOf.Class, create:() => GetCollectibleByNodeRequest()),
});

Dart GetCollectibleByNodeRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}