Index

Introduction

We have developed a communication protocol to create, edit, delete, consult and list work orders, it has been implemented through a rest api. The body of the message for the endpoints is a json type text described in the format section of this document.

First Steps

In order to access the WorkOrders consumer service, you must first log in.

Test url:

https://api.qa.sima.ag:8060

How to get the user API-KEY (login)?

You must use the next endpoint to obtain the access_token.

Login uri:

/api/v2/login

Method:

POST

Header:

    'Accept: application/json',
    'Content-Type: application/json',
    'X-SIMA-SYSTEM-ID: 8' (ThirdParty) 
    'X-SIMA-SYSTEM-ID: 5' (Albor)

Body:

{
    "email":"{{user_email}}",
    "password":"{{password}}"
}

Response example:

{
    "access_token": "aff6ac1d-b48c-4ea4-aba2-a2753bf2abf5",
    "refresh_token": "20626ffd-1288-4106-ac10-dc5a5f3487bc",
    "expiration_datetime": "2021-06-16T17:38:58-03:00",
    "society": {
        "id": 34,
        "legalName": "User Name",
        "syncCheck": "user@user.com3293547",
        "profile": "Unspecified",
        "monitoringArea": "Unspecified",
        "createdById": 17,
        "dateCreated": "2014-01-01T00:00:00-03:00",
        "deleted": false,
        "country": {
            "id": 1,
            "name": "Argentina",
            "eqCountry": 1,
            "countryLocale": "es_AR",
            "countryCode": "54",
            "minimumAppVersion": 118
        },
        "countryCommercial": {
            "id": 1,
            "name": 1,
            "eqCountry": 1,
            "countryLocale": "es_AR",
            "countryCode": "54",
            "minimumAppVersion": 118
        },
        "licences": [
            {
                "id": 20511,
                "startDate": "2020-04-22T12:26:40-03:00",
                "endDate": "2025-11-30T12:26:40-03:00",
                "licenceType": "SIMA",
                "licencedUsers": 0,
                "licencedPlots": 20,
                "licencedHa": 0,
                "plotPriceUsd": "0.000000",
                "observations": "información de prueba",
                "current": true,
                "daysToRenew": 755,
                "to_renew": false
            }
        ]
    }
}

If we get an Http 200 response, we recommend saving the access_token obtained for future inquiries.

Necessary endpoints to integrate as a third party

Work order endpoints

Workorder endpoints

Format

Work order protocol format

Description of protocol attributes

Description of protocol attributes

Class diagram

Link to class diagram: https://drive.google.com/file/d/1UfsRqjM7wborKcKFlnAaCgVVkrbdwXyb/view?usp=sharing

Scouting EndPoints