SUsurense
Employers

Start an import

post/employers/imports/{id}/start

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/employers/imports/{id}/start
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token

Path parameters

idstring uuid required

Response

OK

idstring uuid
tenantIdstring uuid
agencyIdstring uuid
fileNamestring
fileMimestring
fileSizeinteger
status'INITIATED' | 'UPLOADED' | 'PROCESSING' | 'PROCESSED' | 'FAILED' | 'PARTIAL'
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
startedAtstring date-time
endedAtstring date-time
errorMessagestring
totalRecordsinteger
importedRecordsinteger
failedRecordsinteger
resultsFileNamestring
resultsFileMimestring
downloadExpiresAtstring date-time
originalDownloadableboolean
resultsDownloadableboolean

Changes

No recorded changes to this operation across all 1 revision of this API.