Cdn Mobile API

<back to all web services

TypeSenseCollectibleRequest

Cdn.MobileApi

The following routes are available for this service:
GET/TypeSenseCollectibleRequest
TypeSenseCollectibleRequest Parameters:
NameParameterData TypeRequiredDescription
CatalogquerystringNo
KeywordsquerystringNo
PagequeryintNo
PerPagequeryintNo
SortquerystringNo
DatesquerystringNo
TypeSenseSearchResponse<T> Parameters:
NameParameterData TypeRequiredDescription
facet_countsformList<FacetCount>No
foundformintNo
hitsformList<TypeSenseHit<'T>>No
out_offormintNo
pageformintNo
request_paramsformTypeSenseRequestParamsNo
search_cutoffformboolNo
search_time_msformintNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
FacetCount Parameters:
NameParameterData TypeRequiredDescription
countsformList<TypeSenseCount>No
field_nameformstringNo
statsformTypeSenseStatNo
TypeSenseCount Parameters:
NameParameterData TypeRequiredDescription
countformintNo
highlightedformstringNo
valueformstringNo
TypeSenseStat Parameters:
NameParameterData TypeRequiredDescription
total_valuesformintNo
avgformdouble?No
maxformdouble?No
minformdouble?No
sumformdouble?No
TypeSenseRequestParams Parameters:
NameParameterData TypeRequiredDescription
collection_nameformstringNo
per_pageformintNo
qformstringNo

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /TypeSenseCollectibleRequest HTTP/1.1 
Host: mobileapidevsw.greysheet.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TypeSenseSearchResponseOfTypesenseCollectiblez3RKLF_Sf xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.MobileApi.ResponseObjects">
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <facet_counts xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.MobileApi.Models">
    <d2p1:FacetCount>
      <d2p1:counts>
        <d2p1:TypeSenseCount>
          <d2p1:count>0</d2p1:count>
          <d2p1:highlighted>String</d2p1:highlighted>
          <d2p1:value>String</d2p1:value>
        </d2p1:TypeSenseCount>
      </d2p1:counts>
      <d2p1:field_name>String</d2p1:field_name>
      <d2p1:stats>
        <d2p1:avg>0</d2p1:avg>
        <d2p1:max>0</d2p1:max>
        <d2p1:min>0</d2p1:min>
        <d2p1:sum>0</d2p1:sum>
        <d2p1:total_values>0</d2p1:total_values>
      </d2p1:stats>
    </d2p1:FacetCount>
  </facet_counts>
  <found>0</found>
  <hits xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.MobileApi.Models">
    <d2p1:TypeSenseHitOfTypesenseCollectiblez3RKLF_Sf>
      <d2p1:document>
        <d2p1:BnbNumber>String</d2p1:BnbNumber>
        <d2p1:Catalog>String</d2p1:Catalog>
        <d2p1:CatalogSort>0</d2p1:CatalogSort>
        <d2p1:Catalog_id>0</d2p1:Catalog_id>
        <d2p1:CoinDate>String</d2p1:CoinDate>
        <d2p1:Denomination>String</d2p1:Denomination>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:Designation>String</d2p1:Designation>
        <d2p1:Designer>String</d2p1:Designer>
        <d2p1:EntryImageSource>String</d2p1:EntryImageSource>
        <d2p1:EntryImageUrl>String</d2p1:EntryImageUrl>
        <d2p1:EntryName>String</d2p1:EntryName>
        <d2p1:EntrySort>0</d2p1:EntrySort>
        <d2p1:Group>String</d2p1:Group>
        <d2p1:GroupPermalink>String</d2p1:GroupPermalink>
        <d2p1:GroupSort>0</d2p1:GroupSort>
        <d2p1:Group_id>0</d2p1:Group_id>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:IsSet>false</d2p1:IsSet>
        <d2p1:IsType>false</d2p1:IsType>
        <d2p1:MintMark>String</d2p1:MintMark>
        <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:Series>String</d2p1:Series>
        <d2p1:SeriesPermalink>String</d2p1:SeriesPermalink>
        <d2p1:SeriesSort>0</d2p1:SeriesSort>
        <d2p1:Series_id>0</d2p1:Series_id>
        <d2p1:SortOrder>0</d2p1:SortOrder>
        <d2p1:UiParentId>0</d2p1:UiParentId>
      </d2p1:document>
    </d2p1:TypeSenseHitOfTypesenseCollectiblez3RKLF_Sf>
  </hits>
  <out_of>0</out_of>
  <page>0</page>
  <request_params xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.MobileApi.Models">
    <d2p1:collection_name>String</d2p1:collection_name>
    <d2p1:per_page>0</d2p1:per_page>
    <d2p1:q>String</d2p1:q>
  </request_params>
  <search_cutoff>false</search_cutoff>
  <search_time_ms>0</search_time_ms>
</TypeSenseSearchResponseOfTypesenseCollectiblez3RKLF_Sf>