MyWorkPal

1) Uploading data via a predefined Data Transfer Template (DTT)

The easiest way to insert data into MyWorkPal is via a DTT. Each MyWorkPal tenant (/client) can support many DTT's for various purposes - e.g. new users, salary increases or holiday allowance changes.

The actual template would be defined by the appropriate MyWorkPal administrator against the appropriate tenant on the platform.

The diagram above and PDF attached describe the data flow and process.

1.1) Performing the upload

With a DTT in place, a programmatic post request can be made by calling the following API endpoint:

• POST    /api/admin/tenant/datatransfer/template/json/upload

(See here for further details on the API endpoint),

The end point will require different JSON structures depending on the user-defined DTT that has been configured on MyWorkPal showing the data structures / what parameters to pass.

To help with the JSON structure implementation, the Administration system of MyWorkPal can be used by the administrator to request a sample JSON structure to be produced for the DTT being used. 

E.g.

When the request is made the following return information will be obtained:

1.2) Checking on the status of the upload

The upload data request can be significant, containing hundreds of records, therefore the upload request is processed asynchronously.

To check on the status of the upload, a programmatic get request can be made by calling the following API endpoint:

• GET  /api/admin/tenant/datatransfer/template/status/{tenantId}/{scheduledTaskId}

(See here for further details on the API endpoint),

The results of the get request will be:

It is recommend that the external system polls this URL no frequently than 15 seconds.

1.2) Understanding the failure reason

During the construction of the integration system (and less so during normal day to day operation), there will likely be data compatibility issues or business rules failures to resolved

When a failure response is returned (with a 200) the Administration system of MyWorkPal would be used to see the reason why the job has failed.

2) Downloading data via a predefined Data Transfer Template (DTT)

As with uploading data to MyWorkPal, retrieving or downloading data from MyWorkPal is best performed via a DTT.

To download data, the following three supporting API's will need to be called in turn.

2.1)  Requesting a download

This method is similar to the upload, in that it is a asynchronous request to obtain the data.

POST    /api/admin/tenant/datatransfer/template/json/requestdownload

(See here for further details on the API endpoint),

2.2)  Check Status of Download

Again, as with the upload data request processing can be significant, obtaining hundreds of records, therefore the download request is processed asynchronously. This API is used to check the status of the job:

• GET  /api/admin/tenant/datatransfer/template/status/{tenantId}/{scheduledTaskId}

(See here for further details on the API endpoint),

The results of the get request will be:

It would be rare for the Job to fail, if the data can be downloaded via the UI. Again the Administration system will contain more detail if this is the case.

2.3)  Download the actual data

Once the API call returns a status of "Success" the JSON data can be obtained by called the following API:

GET  /api/admin/tenant/datatransfer/template/json/download/{tenantId}/{scheduledTaskId}

(See here for further details on the API endpoint),

___________________________________________________________________________________________________

A code example of all 5 calls above in C#  can be found here.