Needio.Services

<back to all web services

GetMyImportJobListRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Post/GetMyImportJobList/
GetMyImportJobListRequest Parameters:
NameParameterData TypeRequiredDescription
StoreIdqueryint?No
JobIdqueryint?No
CountqueryintNo
PagequeryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetMyImportJobListResponse Parameters:
NameParameterData TypeRequiredDescription
ImportFileJobListformList<ImportFileJobDTO>No
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
Other99
ImportTypes Enum:
NameValue
Excel1
Xml2
GetMyImportJobListResponse Parameters:
NameParameterData TypeRequiredDescription
ImportFileJobListformList<ImportFileJobDTO>No

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

{
	StoreId: 0,
	JobId: 0,
	Count: 0,
	Page: 0,
	start: 2021-11-29T01:54:15.1589882+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ImportFileJobList: 
	[
		{
			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
		}
	],
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}