POST api/Import/CustomImport/Upload

Upload a file to the custom importer

Request Information

URI Parameters

None.

Body Parameters

In request Body: File details

ImportDetail
NameDescriptionTypeAdditional information
FileName

FileName with extension

string

Required

ImportFormat

Custom Import Name

string

Required

DateCreated

date

Nullable

ImportStatus

integer

None.

DateImported

date

Nullable

Detail

string

None.

Rows

integer

Nullable

Progress

integer

Nullable

DateImportStarted

date

Nullable

DateImportFinished

date

Nullable

Disabled

boolean

None.

ImportFormatVersion

date

Nullable

IsPartial

boolean

None.

Guid

globally unique identifier

Nullable

FileData

Byte Array of file data - used in import

Collection of byte

None.

DocumentId

globally unique identifier

None.

PayrollId

globally unique identifier

Nullable

SheetIds

Collection of globally unique identifier

Nullable

Request Formats

application/json, text/json

Sample:
{
  "FileName": "sample string 1",
  "ImportFormat": "sample string 2",
  "DateCreated": "2024-12-23T06:22:45.2772882+00:00",
  "ImportStatus": 3,
  "DateImported": "2024-12-23T06:22:45.2772882+00:00",
  "Detail": "sample string 4",
  "Rows": 1,
  "Progress": 1,
  "DateImportStarted": "2024-12-23T06:22:45.2772882+00:00",
  "DateImportFinished": "2024-12-23T06:22:45.2772882+00:00",
  "Disabled": true,
  "ImportFormatVersion": "2024-12-23T06:22:45.2772882+00:00",
  "IsPartial": true,
  "Guid": "525148c2-b1dc-470b-b7ef-18d887a9670d",
  "FileData": "QEA=",
  "DocumentId": "bd06a247-9485-423e-9d25-50fd6f01b93a",
  "PayrollId": "932a77f1-c17b-458b-a91c-380ce93534f8",
  "SheetIds": [
    "27c4efdc-111d-48a7-9030-362d16298ed2",
    "25de5400-f328-43a6-bab6-03ac811f4808"
  ]
}

application/xml, text/xml

Sample:
<ImportDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebServicesRESTful.Models">
  <DateCreated>2024-12-23T06:22:45.2772882+00:00</DateCreated>
  <DateImportFinished>2024-12-23T06:22:45.2772882+00:00</DateImportFinished>
  <DateImportStarted>2024-12-23T06:22:45.2772882+00:00</DateImportStarted>
  <DateImported>2024-12-23T06:22:45.2772882+00:00</DateImported>
  <Detail>sample string 4</Detail>
  <Disabled>true</Disabled>
  <DocumentId>bd06a247-9485-423e-9d25-50fd6f01b93a</DocumentId>
  <FileData>QEA=</FileData>
  <FileName>sample string 1</FileName>
  <Guid>525148c2-b1dc-470b-b7ef-18d887a9670d</Guid>
  <ImportFormat>sample string 2</ImportFormat>
  <ImportFormatVersion>2024-12-23T06:22:45.2772882+00:00</ImportFormatVersion>
  <ImportStatus>3</ImportStatus>
  <IsPartial>true</IsPartial>
  <PayrollId>932a77f1-c17b-458b-a91c-380ce93534f8</PayrollId>
  <Progress>1</Progress>
  <Rows>1</Rows>
  <SheetIds xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:guid>27c4efdc-111d-48a7-9030-362d16298ed2</d2p1:guid>
    <d2p1:guid>25de5400-f328-43a6-bab6-03ac811f4808</d2p1:guid>
  </SheetIds>
</ImportDetail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Status message

ResultWithMessage
NameDescriptionTypeAdditional information
result

'OK', 'Error'

string

None.

message

Returns if result is Error

string

None.

returnValue

string

None.

Response Formats

application/json, text/json

Sample:
{
    "result": "OK"
}

{
    "result": "Error",
    "message": "Unable to save: the..."
}

application/xml, text/xml

Sample:
<ResultWithMessage>
    <result>OK</result>
</ResultWithMessage>

<ResultWithMessage>  
    <result>Error</result>
    <message>Unable to save: the...</message>
</ResultWithMessage>