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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetMyImportJobListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <DeviceUUID>String</DeviceUUID>
  <Count>0</Count>
  <JobId>0</JobId>
  <Page>0</Page>
  <StoreId>0</StoreId>
</GetMyImportJobListRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetMyImportJobListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <ImportFileJobList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:ImportFileJobDTO>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:ExecutionDate>0001-01-01T00:00:00</d2p1:ExecutionDate>
      <d2p1:FileMimeType>String</d2p1:FileMimeType>
      <d2p1:FileName>String</d2p1:FileName>
      <d2p1:FileType>0</d2p1:FileType>
      <d2p1:HJobId>String</d2p1:HJobId>
      <d2p1:ImportFileJobId>0</d2p1:ImportFileJobId>
      <d2p1:ImportType>Excel</d2p1:ImportType>
      <d2p1:InputFileId>0</d2p1:InputFileId>
      <d2p1:JobId>0</d2p1:JobId>
      <d2p1:OutputFileId>0</d2p1:OutputFileId>
      <d2p1:Result>String</d2p1:Result>
      <d2p1:ScheduledDate>0001-01-01T00:00:00</d2p1:ScheduledDate>
      <d2p1:Status>Waiting</d2p1:Status>
      <d2p1:StoreId>0</d2p1:StoreId>
      <d2p1:TimeSpent>PT0S</d2p1:TimeSpent>
      <d2p1:UserId>0</d2p1:UserId>
    </d2p1:ImportFileJobDTO>
  </ImportFileJobList>
</GetMyImportJobListResponse>