POST api/Import/CustomImport/StartImport/{guid}/{payroll}

Kicks off the import process - returns whether the import was STARTED successfully, not the outcome.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
guid

globally unique identifier

Required

payroll

globally unique identifier

None.

Body Parameters

None.

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>