Needio.Services

<back to all web services

ReceiveKeyRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/KeyMan/ReceiveKey
ReceiveKeyRequest Parameters:
NameParameterData TypeRequiredDescription
ServiceTypequeryServiceTypeNo
RefIdqueryintNo
UserAddressIdqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
ServiceType Enum:
NameValue
Invalid0
Offer1
Service2
Hangfire3

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 /KeyMan/ReceiveKey HTTP/1.1 
Host: baseservices.needion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ServiceType: 0,
	RefId: 0,
	UserAddressId: 0,
	start: 2021-10-28T07:08:57.7959097+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}