Needio.Services

<back to all web services

GetStaticDocumentRequest

The following routes are available for this service:
All Verbs/GetStaticDocument/
GetStaticDocumentRequest Parameters:
NameParameterData TypeRequiredDescription
DocumentTypequeryDocumentTypeNo
ParameterListqueryList<NameValue>No
RelatedIdqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetStaticDocumentResponse Parameters:
NameParameterData TypeRequiredDescription
DocumentStringformstringNo
RelatedIdformintNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
DocumentType Enum:
NameValue
MembershipAgreement1
CommercialElectronicMessageConditions2
GDPR3
SellerAgreement4
PersonalDataDisclosure5
ProductCommentInfoText6
ContinueWithoutMember7
HowDoSellSupport8
SupportInfo9
SendMessageDocument10
NameValue Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformObjectNo
GetStaticDocumentResponse Parameters:
NameParameterData TypeRequiredDescription
DocumentStringformstringNo
RelatedIdformintNo

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

{
	DocumentType: 1,
	ParameterList: 
	[
		{
			Name: String,
			Value: {}
		}
	],
	RelatedId: 0,
	start: 2021-10-19T17:05:36.9032160+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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