Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Next »

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://simaapi-test.ddns.net

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

You must use the next endpoint to obtain the access_token.

Login uri:

/login/{user}/{password}

Method:

GET

Header:

    'Accept: application/json',
    'Content-Type: application/json'

Response example:

{
    "access_token": "111",
    "refresh_token": "034d7e33-5e5c-4ac9-9caf-746af2d0df14",
    "expiration_datetime": "2017-02-14T16:30:44-0300",
    "minimum_app_version": 130,
    "latest_app_version": 234
}

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

Necessary enpoints 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

  • No labels