Cdn API

TypeSenseSearchRequest

**TypeSenseSearchRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Sort	query	string	No

**BaseTypeSenseSearchRequest** Parameters:
Name	Parameter	Data Type	Required
Keywords	form	string	No
Page	form	int	No
PerPage	form	int	No
FacetBy	form	string	No
FilterBy	form	string	No

**TypeSenseSearchResponse<T>** Parameters:
Name	Parameter	Data Type	Required
facet_counts	form	List<FacetCount>	No
found	form	int	No
hits	form	List<TypeSenseHit<'T>>	No
out_of	form	int	No
page	form	int	No
request_params	form	TypeSenseRequestParams	No
search_cutoff	form	bool	No
search_time_ms	form	int	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Total	form	int	No
OpCode	form	int	No
ErrorText	form	string	No
RequestTime	form	string	No
ResponseTime	form	string	No
TotalExecutionTime	form	string	No
CachedResponse	form	bool	No

**FacetCount** Parameters:
Name	Parameter	Data Type	Required
counts	form	List<TypeSenseCount>	No
field_name	form	string	No
stats	form	TypeSenseStat	No

**TypeSenseCount** Parameters:
Name	Parameter	Data Type	Required
count	form	int	No
highlighted	form	string	No
value	form	string	No

**TypeSenseStat** Parameters:
Name	Parameter	Data Type	Required
total_values	form	int	No
avg	form	double?	No
max	form	double?	No
min	form	double?	No
sum	form	double?	No

**TypeSenseRequestParams** Parameters:
Name	Parameter	Data Type	Required
collection_name	form	string	No
per_page	form	int	No
q	form	string	No

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.

POST /xml/reply/TypeSenseSearchRequest HTTP/1.1 
Host: cdnapidev-cdnx.greysheet.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TypeSenseSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.RequestObjects">
  <FacetBy>String</FacetBy>
  <FilterBy>String</FilterBy>
  <Keywords>String</Keywords>
  <Page>0</Page>
  <PerPage>0</PerPage>
  <Sort>String</Sort>
</TypeSenseSearchRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TypeSenseSearchResponseOfMarketplaceItemK9uct2fR xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.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.Api.Models.TypeSense">
    <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.Api.Models.TypeSense">
    <d2p1:TypeSenseHitOfMarketplaceItemK9uct2fR>
      <d2p1:document xmlns:d4p1="http://schemas.datacontract.org/2004/07/Cdn.Api.DocumentObjects">
        <d4p1:aprId>0</d4p1:aprId>
        <d4p1:askId>0</d4p1:askId>
        <d4p1:auctionEnds>0001-01-01T00:00:00</d4p1:auctionEnds>
        <d4p1:auctionHouseAbbrev>String</d4p1:auctionHouseAbbrev>
        <d4p1:auctionHouseName>String</d4p1:auctionHouseName>
        <d4p1:auctionSoldFor>0</d4p1:auctionSoldFor>
        <d4p1:avatar>String</d4p1:avatar>
        <d4p1:callForPrice>false</d4p1:callForPrice>
        <d4p1:catalog>String</d4p1:catalog>
        <d4p1:catalogSort>0</d4p1:catalogSort>
        <d4p1:catalog_id>0</d4p1:catalog_id>
        <d4p1:cdnEntryId>0</d4p1:cdnEntryId>
        <d4p1:cdnxEntryCode>String</d4p1:cdnxEntryCode>
        <d4p1:companyName>String</d4p1:companyName>
        <d4p1:customerId>0</d4p1:customerId>
        <d4p1:description>String</d4p1:description>
        <d4p1:details>false</d4p1:details>
        <d4p1:entryImageSource>String</d4p1:entryImageSource>
        <d4p1:entryImageUrl>String</d4p1:entryImageUrl>
        <d4p1:entryName>String</d4p1:entryName>
        <d4p1:entrySort>0</d4p1:entrySort>
        <d4p1:error>false</d4p1:error>
        <d4p1:expireDate>String</d4p1:expireDate>
        <d4p1:extended>String</d4p1:extended>
        <d4p1:fullGrade>String</d4p1:fullGrade>
        <d4p1:grade>0</d4p1:grade>
        <d4p1:group>String</d4p1:group>
        <d4p1:groupSort>0</d4p1:groupSort>
        <d4p1:group_id>0</d4p1:group_id>
        <d4p1:id>String</d4p1:id>
        <d4p1:images xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d4p1:images>
        <d4p1:isAuction>false</d4p1:isAuction>
        <d4p1:isCac>false</d4p1:isCac>
        <d4p1:isSold>false</d4p1:isSold>
        <d4p1:lastModified>String</d4p1:lastModified>
        <d4p1:paperQuality />
        <d4p1:price>0</d4p1:price>
        <d4p1:quantity>0</d4p1:quantity>
        <d4p1:rec_type>String</d4p1:rec_type>
        <d4p1:series>String</d4p1:series>
        <d4p1:seriesSort>0</d4p1:seriesSort>
        <d4p1:series_id>0</d4p1:series_id>
        <d4p1:service>String</d4p1:service>
        <d4p1:sightCode>String</d4p1:sightCode>
        <d4p1:sortOrder>0</d4p1:sortOrder>
        <d4p1:spotBased>false</d4p1:spotBased>
        <d4p1:spotDollarPercent>String</d4p1:spotDollarPercent>
        <d4p1:spotMessage />
        <d4p1:spotOffset>0</d4p1:spotOffset>
        <d4p1:spotPlusMinus>String</d4p1:spotPlusMinus>
        <d4p1:url>String</d4p1:url>
        <d4p1:userCode>String</d4p1:userCode>
        <d4p1:userId>0</d4p1:userId>
      </d2p1:document>
    </d2p1:TypeSenseHitOfMarketplaceItemK9uct2fR>
  </hits>
  <out_of>0</out_of>
  <page>0</page>
  <request_params xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Models.TypeSense">
    <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>
</TypeSenseSearchResponseOfMarketplaceItemK9uct2fR>