Needio.Services

<back to all web services

DownloadImportJobResultRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Post/DownloadImportJobResult/
DownloadImportJobResultRequest Parameters:
NameParameterData TypeRequiredDescription
ImportFileJobIdqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
DownloadImportJobResultResponse Parameters:
NameParameterData TypeRequiredDescription
ImportFileJobDtoformImportFileJobDTONo
FileContentBase64formstringNo
MimeTypeformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
ImportFileJobDTO Parameters:
NameParameterData TypeRequiredDescription
ImportFileJobIdformintNo
UserIdformintNo
StoreIdformintNo
StatusformImportFileStatusesNo
ImportTypeformImportTypesNo
FileNameformstringNo
FileMimeTypeformstringNo
FileTypeformintNo
InputFileIdformlongNo
OutputFileIdformlong?No
CreatedDateformDateTimeNo
ScheduledDateformDateTimeNo
ExecutionDateformDateTime?No
JobIdformint?No
HJobIdformstringNo
TimeSpentformTimeSpan?No
ResultformstringNo
ImportFileStatuses Enum:
NameValue
Waiting1
InProgress2
Cancelled3
Rejected4
CompletedWithError9
Completed10
ImportTypes Enum:
NameValue
Excel1
Xml2
DownloadImportJobResultResponse Parameters:
NameParameterData TypeRequiredDescription
ImportFileJobDtoformImportFileJobDTONo
FileContentBase64formstringNo
MimeTypeformstringNo

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

{
	ImportFileJobId: 0,
	start: 2021-10-20T22:52:10.3457335+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ImportFileJobDto: 
	{
		ImportFileJobId: 0,
		UserId: 0,
		StoreId: 0,
		Status: 1,
		ImportType: 1,
		FileName: String,
		FileMimeType: String,
		FileType: 0,
		InputFileId: 0,
		OutputFileId: 0,
		CreatedDate: 0001-01-01,
		ScheduledDate: 0001-01-01,
		ExecutionDate: 0001-01-01,
		JobId: 0,
		HJobId: String,
		TimeSpent: PT0S,
		Result: String
	},
	FileContentBase64: String,
	MimeType: String,
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}