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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"Url":"String","start":"\/Date(1635360925597+0300)\/","DeviceUUID":"String","APIKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ParsedUrl":{"Domain":"String","Page":"String","Key":0,"CatKey":"String","CampaignCode":"String","Segments":["String"],"Params":{"String":"String"},"SearchAttrDatas":[{"Type":"String","Key":"String"}]},"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}