Machinery service with token

Description

Service for obtaining information on machinery by providing the the identifier of the contract to which it belongs. It is mandatory to authenticate using Login-action service to obtain a token to access this service.

URL

The URL of the production service is available at https://iot.nalandaglobal.com/gestiona/obras/remote/maquinaria-token.action.

Operations

Export Machinery

Request:

{
  "request": {
    "matricula": "Matricula",
    "contrataId": "ID_NUMERICO_CONTRATA",
    "idDispositivo": "ID_DISPOSITIVO_ASIGNADO_A_OBRA"
  }
}

Request fields: Parameters inside object called request passed in Json format:

maquinariaId: Machine ID. Higher preference than matricula.
matricula: Machine registration number. Lower preference than Id.
contrataId: Identifier that the contract has in the Obralia system.
idDispositivo: Identifier of the device registered in the system

Response: Receives a collection of elements similar to those obtained at https://iot.nalandaglobal.com/gestiona/obras/remote/maquinaria.action containing the data of all the machinery assigned to the contractors of the requested work.

Machinery assigned to a project with token

Description

Service to obtain information on machinery by providing the identifier of the project to which it is assigned.

URL

The URL of the production service is available at https://iot.nalandaglobal.com/gestiona/obras/remote/maquinaria-en-obra-token.action.

Operations

Machinery assigned to project

Request:

{
  "request": {
    "matricula": "Matricula",
    "idObra": "ID_NUMERICO_OBRA",
    "idDispositivo": "ID_DISPOSITIVO_ASIGNADO_A_OBRA"
  }
}

Request fields: Parameters inside object called request passed in Json format:

matricula: Machinery registration number
idObra: Identifier of the construction site to which the machine is assigned
idDispositivo: Identifier of the device registered in the system

Response: Receives a collection of elements similar to those obtained at https://iot.nalandaglobal.com/gestiona/obras/remote/maquinaria-token.action containing the data of all the machinery assigned to the contractors of the requested work.

Machinery on a project

Description

Service for obtaining information on machinery on a project

URL

The URL of the production service is available at https://iot.nalandaglobal.com/gestiona/obras/remote/maquinaria-de-obra-token.action.

Operations

Machinery assigned to project

Request:

{
  "request": {
    "idObra": "ID_NUMERICO_OBRA",
    "idDispositivo": "ID_DISPOSITIVO_ASIGNADO_A_OBRA"
  }
}

Request fields: Parameters inside object called request passed in Json format:

idObra: Identifier of the construction site to which the machine is assigned
idDispositivo: Identifier of the device registered in the system

LEGACY SERVICES

Machinery service

Description

Service for obtaining information on machinery by providing the the identifier of the contract to which it belongs.

URL

The URL of the production service is available at https://iot.nalandaglobal.com/gestiona/obras/remote/maquinaria.action.

Operations

Export Machinery

Request:

{
  "password": "pwd",
  "request": {
    "contrataId": "493107836",
    "matricula": "0704A"
  },
  "userName": "user"
}

Request fields:

userName: Portal user with permission to access the information.
password: Password.

Parameters inside object called request passed in Json format:

matricula: The machine's id.
contrataId: Identifier of the contract in the system.

Response:

{
  "informacionContrata": {
    "cif": "C12345674",
    "descripcion": "EMPRESA DE TRANSPORTE 3, S.A.D - PRUEBA-",
    "id": 493107836
  },
  "informacionMaquinaria": {
    "informacionDocumental": {
      "documentos": {
        "cerema": [
          {
            "estado": "R",
            "fechaCaducidad": "2024-01-22T00:00:00+0100",
            "nombreDocumento": "Certificado de Revisiones / Mantenimiento",
            "observaciones": "",
            "tipo": "cerema"
          }
        ],
        "fictec": [
          {
            "estado": "G",
            "nombreDocumento": "Ficha tecnica",
            "observaciones": "",
            "tipo": "fictec"
          }
        ],
        "itvjus": [
          {
            "estado": "R",
            "fechaCaducidad": "2024-01-22T00:00:00+0100",
            "nombreDocumento": "ITV",
            "observaciones": "",
            "tipo": "itvjus"
          }
        ],
        "manins": [
          {
            "estado": "G",
            "nombreDocumento": "Manual de instrucciones de\r\n\r\nuso y mantenimiento",
            "observaciones": "",
            "tipo": "manins"
          }
        ],
        "percir": [
          {
            "estado": "G",
            "nombreDocumento": "Permiso de circulacion",
            "observaciones": "",
            "tipo": "percir"
          }
        ],
        "segpol": [
          {
            "estado": "P",
            "nombreDocumento": "Seguro (poliza)",
            "observaciones": "",
            "tipo": "segpol"
          }
        ],
        "segrec": [
          {
            "estado": "R",
            "fechaCaducidad": "1111-11-11T00:00:00+0100",
            "nombreDocumento": "Seguro (recibo)",
            "observaciones": "DOCUMENTO NO PERMITE ABRIR;APORTE DATOS DE LA MÁQUINA",
            "tipo": "segrec"
          }
        ]
      }
    },
    "informacionDocumentalMaquinariaEspecificaContrata": {
      "enAuditoria": true,
      "enVigilanciaEspecial": false,
      "fechaSalidaExpirada": false
    },
    "informacionGeneral": {
      "codigoMaquinaria": 328238,
      "descripcion": "nueva",
      "estadoGeneral": "P",
      "matricula": "0704A"
    }
  },
  "informacionObra": {
    "cif": "C12345674",
    "codigoInterno": "OBR-001",
    "id": 493107078,
    "informacionConstructora": {
      "cif": "C12345674",
      "descripcion": "EMPRESA DE TRANSPORTE 3, S.A.D - PRUEBA-"
    }
  }
}

Machinery assigned to project

Description: Service for obtaining information on machinery by providing the identifier of the identifier of the site to which it is assigned.

Request:

{
  "password": "pwd",
  "request": {
    "idObra": "493107078",
    "matricula": "0704A"
  },
  "userName": "usr"
}

Request fields:

userName: Portal user with permission to access the information.
password: Password.

Parameters inside object called request passed in Json format:

matricula: The machine's code.
idObra: Identifier of the project

Response: Receives a collection of items of the same type of response as https://iot.nalandaglobal.com/gestiona/obras/remote/maquinaria.action

Project's machinery

Description: Service for obtaining information on machinery on a project

Request:

{
  "password": "pwd",
  "request": {
    "idObra": "493107078"
  },
  "userName": "usr"
}

Request fields:

userName: Portal user with permission to access the information.
password: Password.

Parameters inside object called request passed in Json format:

idObra: Identifier of the project

####Relevant information on users and devices

In order for the services related to the access control of workers and machinery to work properly, it is necessary that some correctly, it is necessary that some matching criteria between the user and the device are met.

Thus the company to which the user belongs, who logs in and receives the security token, must be the same company as the owner of the device, must be the same company as the owner of the device used in the rest of the requests.

In the same way, the device, used in the rest of the requests, must be configured with the projects related to the same company of the user, who has logged in and received the security token. The configuration of the device with the related projects must be managed with a valid partner from Nalanda.