Work Order endpoints
Version | Date | Comment |
---|---|---|
Current Version (v. 13) | Jul 02, 2024 16:53 | Angel Javier Larrosa |
v. 12 | Jul 02, 2024 16:42 | Angel Javier Larrosa |
v. 11 | May 15, 2024 16:32 | Juan Eduardo Sosa |
v. 10 | Oct 23, 2023 20:57 | Luciana Danzi (Unlicensed) |
v. 9 | Aug 22, 2023 18:00 | Angel Javier Larrosa |
v. 8 | Jan 12, 2023 20:02 | Nicolas Corvalan |
v. 7 | Aug 08, 2022 17:49 | Angel Javier Larrosa |
v. 6 | Aug 08, 2022 13:29 | Angel Javier Larrosa |
v. 5 | Aug 05, 2022 21:28 | Angel Javier Larrosa |
v. 4 | Apr 08, 2022 19:02 | Angel Javier Larrosa |
v. 3 | Dec 24, 2021 15:07 | Angel Javier Larrosa |
v. 2 | Dec 13, 2021 20:26 | Angel Javier Larrosa |
v. 1 | Dec 13, 2021 20:25 | Angel Javier Larrosa |
There are 5 endpoints available for the implementation of work order integration.
Detail
Uri:
/integration/api/v1/workOrders/{externalId/externalCode/localId}
Method:
GET
Header:
'X-SIMA-APIKEY: {API-KEY}',
'X-SIMA-SYSTEM-ID: {API-SYSTEM-ID}',
'Accept: application/json',
'Content-Type: application/json'
Response example:
List:
Uri:
Method:
Header:
Parameters:
Response example:
Create
Uri:
Method:
Header:
Body example:
Response example:
Edit
Uri:
Method:
Header:
Body example:
Response example:
Delete
Uri:
Method:
Header:
Response example:
Detail of the variables used
{API-KEY
}: Authentication api key.
{externalId/externalCode/localId
}: Unique identifier of the system that integrates with SIMA of the integrated work order (externalId) or the unique identifier in SIMA (localId).
{API-SYSTEM-ID
}: Unique identifier assigned by SIMA to the integrated external entity or if you will integrate as a Third Party you must use the protocol_system_id = 8.
Delete
Uri:
Method:
Header:
Request example:
Response example:
Third Party Structure
For Third Party we are including in extra fields of Header the values of attributes for work orders of type Labour.
Structure Example: