Needio.Services

<back to all web services

ParseUrlRequest

The following routes are available for this service:
All Verbs/ParseUrl/
ParseUrlRequest Parameters:
NameParameterData TypeRequiredDescription
UrlquerystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
ParseUrlResponse Parameters:
NameParameterData TypeRequiredDescription
ParsedUrlformUrlComponentsNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
UrlComponents Parameters:
NameParameterData TypeRequiredDescription
DomainformstringNo
PageformstringNo
KeyformintNo
CatKeyformstringNo
CampaignCodeformstringNo
Segmentsformstring[]No
ParamsformDictionary<string, string>No
SearchAttrDatasformList<SearchAttrData>No
SearchAttrData Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
KeyformstringNo
ParseUrlResponse Parameters:
NameParameterData TypeRequiredDescription
ParsedUrlformUrlComponentsNo

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 /ParseUrl/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<ParseUrlResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <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>
  <ParsedUrl xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:CampaignCode>String</d2p1:CampaignCode>
    <d2p1:CatKey>String</d2p1:CatKey>
    <d2p1:Domain>String</d2p1:Domain>
    <d2p1:Key>0</d2p1:Key>
    <d2p1:Page>String</d2p1:Page>
    <d2p1:Params xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Params>
    <d2p1:SearchAttrDatas>
      <SearchAttrData>
        <Key>String</Key>
        <Type>String</Type>
      </SearchAttrData>
    </d2p1:SearchAttrDatas>
    <d2p1:Segments xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Segments>
  </ParsedUrl>
</ParseUrlResponse>