Needio.Services

<back to all web services

SuggestRequest

The following routes are available for this service:
All Verbs/Items/Suggest/
SuggestRequest Parameters:
NameParameterData TypeRequiredDescription
TermsquerystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
SuggestResponse Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<SuggestionResult>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
SuggestionResult Parameters:
NameParameterData TypeRequiredDescription
TypeformintNo
UrlformstringNo
ResultformstringNo
FriendlyUrlformstringNo
SuggestResponse Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<SuggestionResult>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 /Items/Suggest/ HTTP/1.1 
Host: baseservices2.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SuggestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <DeviceUUID>String</DeviceUUID>
  <Terms>String</Terms>
</SuggestRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SuggestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <Items>
    <SuggestionResult>
      <FriendlyUrl>String</FriendlyUrl>
      <Result>String</Result>
      <Type>0</Type>
      <Url>String</Url>
    </SuggestionResult>
  </Items>
</SuggestResponse>