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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Url: String,
	start: 2021-10-24T06:05:12.7150005+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ParsedUrl: 
	{
		Domain: String,
		Page: String,
		Key: 0,
		CatKey: 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
	}
}