logo
API docs by Redocly

ISIncendio Maintenance (0.1.0)

Download OpenAPI specification:

Company Info

/company-info

Authorizations:
firebase

Responses

Response samples

Content type
application/json
{
  • "companyName": "string",
  • "phone": "string",
  • "whatsapp": "string",
  • "email": "user@example.com",
  • "address": { },
  • "mapsUrl": "http://example.com",
  • "businessHours": { },
  • "socialNetworks": { },
  • "config": { },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

/company-info

Authorizations:
firebase
Request Body schema: application/json
required
companyName
required
string
phone
string or null
whatsapp
string or null
email
string or null <email>
required
object
mapsUrl
string or null <uri>
required
object
required
object
object

Responses

Request samples

Content type
application/json
{
  • "companyName": "string",
  • "phone": "string",
  • "whatsapp": "string",
  • "email": "user@example.com",
  • "address": { },
  • "mapsUrl": "http://example.com",
  • "businessHours": { },
  • "socialNetworks": { },
  • "config": { }
}

Subject

/subject

Authorizations:
firebase

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "name": "string",
  • "status": "ACTIVE",
  • "technician": {
    },
  • "employee": {
    }
}

Document Type

/document-types

Authorizations:
firebase
query Parameters
category
string
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/document-types

Authorizations:
firebase
Request Body schema: application/json
required
category
string
Enum: "TECHNICIAN" "COMPANY" "REPORT"
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "category": "TECHNICIAN",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

/document-types/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "category": "TECHNICIAN",
  • "name": "string",
  • "description": "string",
  • "status": "ACTIVE"
}

/document-types/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
category
string
Enum: "TECHNICIAN" "COMPANY" "REPORT"
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "category": "TECHNICIAN",
  • "name": "string",
  • "description": "string"
}

/document-types/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/document-types/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Internal Document

/internal-documents

Authorizations:
firebase
query Parameters
documentTypeId
number
isPublic
boolean
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/internal-documents

Authorizations:
firebase
Request Body schema: application/json
required
documentTypeId
number
title
string
fileName
string
fileSize
number
mimeType
string
isPublic
boolean

Responses

Request samples

Content type
application/json
{
  • "documentTypeId": 0,
  • "title": "string",
  • "fileName": "string",
  • "fileSize": 0,
  • "mimeType": "string",
  • "isPublic": true
}

Response samples

Content type
application/json
{
  • "id": 0
}

/internal-documents/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "url": "string"
}

/internal-documents/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
title
string

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

/internal-documents/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/internal-documents/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Equipment Type

/equipment-types

Authorizations:
firebase
query Parameters
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/equipment-types

Authorizations:
firebase
Request Body schema: application/json
required
parentId
number
name
string
description
string
isMultiple
boolean
configuration
object

Responses

Request samples

Content type
application/json
{
  • "parentId": 0,
  • "name": "string",
  • "description": "string",
  • "isMultiple": true,
  • "configuration": { }
}

Response samples

Content type
application/json
{
  • "id": 0
}

/equipment-types/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "parentId": 0,
  • "name": "string",
  • "description": "string",
  • "isMultiple": true,
  • "configuration": { },
  • "status": "ACTIVE"
}

/equipment-types/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
parentId
number
name
string
description
string
isMultiple
boolean
configuration
object

Responses

Request samples

Content type
application/json
{
  • "parentId": 0,
  • "name": "string",
  • "description": "string",
  • "isMultiple": true,
  • "configuration": { }
}

/equipment-types/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/equipment-types/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Accessory

/accessories

Authorizations:
firebase
query Parameters
equipmentTypeId
number
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/accessories

Authorizations:
firebase
Request Body schema: application/json
required
equipmentTypeId
number
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "equipmentTypeId": 0,
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

/accessories/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "equipmentTypeId": 0,
  • "name": "string",
  • "description": "string",
  • "status": "ACTIVE"
}

/accessories/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
equipmentTypeId
number
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "equipmentTypeId": 0,
  • "name": "string",
  • "description": "string"
}

/accessories/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/accessories/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Form

/forms

Authorizations:
firebase
query Parameters
equipmentTypeId
number
recurrence
string
Enum: "WEEKLY" "MONTHLY" "QUARTERLY" "SEMIANNUAL" "ANNUAL" "YEARS_3" "YEARS_5" "YEARS_10"
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/forms

Authorizations:
firebase
Request Body schema: application/json
required
equipmentTypeId
number
recurrence
string
Enum: "WEEKLY" "MONTHLY" "QUARTERLY" "SEMIANNUAL" "ANNUAL" "YEARS_3" "YEARS_5" "YEARS_10"
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "equipmentTypeId": 0,
  • "recurrence": "WEEKLY",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

/forms/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "equipmentTypeId": 0,
  • "recurrence": "WEEKLY",
  • "name": "string",
  • "description": "string",
  • "status": "ACTIVE"
}

/forms/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
equipmentTypeId
number
recurrence
string
Enum: "WEEKLY" "MONTHLY" "QUARTERLY" "SEMIANNUAL" "ANNUAL" "YEARS_3" "YEARS_5" "YEARS_10"
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "equipmentTypeId": 0,
  • "recurrence": "WEEKLY",
  • "name": "string",
  • "description": "string"
}

/forms/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/forms/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Form Item

/form-items

Authorizations:
firebase
query Parameters
formId
number
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/form-items

Authorizations:
firebase
Request Body schema: application/json
required
formId
number
contents
string
answers
string
requiresEvidence
boolean
sortIndex
number

Responses

Request samples

Content type
application/json
{
  • "formId": 0,
  • "contents": "string",
  • "answers": "string",
  • "requiresEvidence": true,
  • "sortIndex": 0
}

Response samples

Content type
application/json
{
  • "id": 0
}

/form-items/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "formId": 0,
  • "contents": [
    ],
  • "answers": [
    ],
  • "requiresEvidence": true,
  • "sortIndex": 0,
  • "status": "ACTIVE"
}

/form-items/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
contents
string
answers
string
requiresEvidence
boolean
sortIndex
number

Responses

Request samples

Content type
application/json
{
  • "contents": "string",
  • "answers": "string",
  • "requiresEvidence": true,
  • "sortIndex": 0
}

/form-items/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/form-items/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Technician

/technicians

Authorizations:
firebase
query Parameters
fullName
string
email
string
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/technicians

Authorizations:
firebase
Request Body schema: application/json
required
fullName
string
email
string
password
string

Responses

Request samples

Content type
application/json
{
  • "fullName": "string",
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

/technicians/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "fullName": "string",
  • "email": "string",
  • "status": "ACTIVE"
}

/technicians/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
fullName
string
email
string

Responses

Request samples

Content type
application/json
{
  • "fullName": "string",
  • "email": "string"
}

/technicians/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/technicians/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Change a technician password

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
password
string [ 6 .. 128 ] characters

If omitted or empty, a secure password is generated

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "password": "string"
}

/technicians/{id}/status

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
status
required
string
Enum: "ACTIVE" "INACTIVE"

Responses

Request samples

Content type
application/json
{
  • "status": "ACTIVE"
}

Administrator

/administrators

Authorizations:
firebase
query Parameters
fullName
string
email
string
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/administrators

Authorizations:
firebase
Request Body schema: application/json
required
fullName
required
string
email
required
string <email>
password
required
string [ 6 .. 128 ] characters

Responses

Request samples

Content type
application/json
{
  • "fullName": "string",
  • "email": "user@example.com",
  • "password": "string"
}

/administrators/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "fullName": "string",
  • "email": "user@example.com",
  • "status": "ACTIVE"
}

/administrators/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
fullName
required
string
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "fullName": "string",
  • "email": "user@example.com"
}

/administrators/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/administrators/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Change an administrator password

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
password
string [ 6 .. 128 ] characters

If omitted or empty, a secure password is generated

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

/administrators/{id}/status

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
status
required
string
Enum: "ACTIVE" "INACTIVE"

Responses

Request samples

Content type
application/json
{
  • "status": "ACTIVE"
}

Technician Document

/technician-documents

Authorizations:
firebase
query Parameters
technicianId
number
documentTypeId
number
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/technician-documents

Authorizations:
firebase
Request Body schema: application/json
required
technicianId
number
documentTypeId
number
fileName
string
fileSize
number
mimeType
string

Responses

Request samples

Content type
application/json
{
  • "technicianId": 0,
  • "documentTypeId": 0,
  • "fileName": "string",
  • "fileSize": 0,
  • "mimeType": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

/technician-documents/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/technician-documents/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/technician-documents/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Team

/teams

Authorizations:
firebase
query Parameters
name
string
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/teams

Authorizations:
firebase
Request Body schema: application/json
required
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

/teams/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "status": "ACTIVE"
}

/teams/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

/teams/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/teams/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/teams/{teamId}/equipment-types

Authorizations:
firebase
path Parameters
teamId
number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/teams/{teamId}/equipment-types

Authorizations:
firebase
path Parameters
teamId
number
Request Body schema: application/json
required
equipmentTypeId
number

Responses

Request samples

Content type
application/json
{
  • "equipmentTypeId": 0
}

/teams/{teamId}/equipment-types/{equipmentTypeId}

Authorizations:
firebase
path Parameters
teamId
number
equipmentTypeId
number

Responses

/teams/{teamId}/members

Authorizations:
firebase
path Parameters
teamId
number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/teams/{teamId}/members

Authorizations:
firebase
path Parameters
teamId
number
Request Body schema: application/json
required
technicianId
number
role
string
Enum: "LEADER" "ASSISTANT"

Responses

Request samples

Content type
application/json
{
  • "technicianId": 0,
  • "role": "LEADER"
}

/teams/{teamId}/members/{equipmentTypeId}

Authorizations:
firebase
path Parameters
teamId
number
technicianId
number

Responses

Service Orders

List service orders

Authorizations:
firebase
query Parameters
companyId
integer
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new service order

Authorizations:
firebase
Request Body schema: application/json
required
companyId
integer
type
string
Enum: "INSTALLATION" "DEINSTALLATION" "REPAIR" "WARRANTY" "MAINTENANCE"

Responses

Request samples

Content type
application/json
{
  • "companyId": 0,
  • "type": "INSTALLATION"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Get a service order by ID

Authorizations:
firebase
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "companyId": 0,
  • "type": "INSTALLATION",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "status": "ACTIVE"
}

Update a service order

Authorizations:
firebase
path Parameters
id
required
integer
Request Body schema: application/json
required
companyId
integer
type
string
Enum: "INSTALLATION" "DEINSTALLATION" "REPAIR" "WARRANTY" "MAINTENANCE"

Responses

Request samples

Content type
application/json
{
  • "companyId": 0,
  • "type": "INSTALLATION"
}

Delete a service order

Authorizations:
firebase
path Parameters
id
required
integer

Responses

Reactivate a service order

Authorizations:
firebase
path Parameters
id
required
integer

Responses

ServiceOrderItem

/service-order-items

Authorizations:
firebase
query Parameters
serviceOrderId
number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/service-order-items

Authorizations:
firebase
Request Body schema: application/json
required
serviceOrderId
number
equipmentId
number
recurrence
string
Enum: "WEEKLY" "MONTHLY" "QUARTERLY" "SEMIANNUAL" "ANNUAL" "YEARS_3" "YEARS_5" "YEARS_10"
description
string

Responses

Request samples

Content type
application/json
{
  • "serviceOrderId": 0,
  • "equipmentId": 0,
  • "recurrence": "WEEKLY",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

/service-order-items/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "serviceOrderId": 0,
  • "equipmentId": 0,
  • "recurrence": "WEEKLY"
}

/service-order-items/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
serviceOrderId
number
equipmentId
number
recurrence
string
Enum: "WEEKLY" "MONTHLY" "QUARTERLY" "SEMIANNUAL" "ANNUAL" "YEARS_3" "YEARS_5" "YEARS_10"
description
string

Responses

Request samples

Content type
application/json
{
  • "serviceOrderId": 0,
  • "equipmentId": 0,
  • "recurrence": "WEEKLY",
  • "description": "string"
}

/service-order-items/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Appointment

/appointments

Authorizations:
firebase
query Parameters
locationId
number
fromDate
string <date-time>
toDate
string <date-time>
dateType
string
Default: "SCHEDULED"
Enum: "SCHEDULED" "CONFIRMATION" "CANCELLATION" "FINISH"
status
string
Enum: "PENDING" "ACTIVE" "FINISHED" "CANCELLED"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/appointments

Authorizations:
firebase
Request Body schema: application/json
required
locationId
number
employeeId
number
scheduledDate
string <date-time>
scheduledEndDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "locationId": 0,
  • "employeeId": 0,
  • "scheduledDate": "2019-08-24T14:15:22Z",
  • "scheduledEndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0
}

/appointments/daily

Authorizations:
firebase
query Parameters
string or string

An ISO date or an ISO instant. If omitted, the current date in the selected time zone is assumed

timeZone
string

An IANA time zone. If omitted, the server's TZ setting is used

period
string
Default: "day"
Enum: "day" "week" "history"

day returns the selected day; week returns seven days starting on the selected date; history returns the number of previous calendar days configured by the server

status
Array of strings
Items Enum: "PENDING" "ACTIVE" "FINISHED" "CANCELLED"

If omitted, ACTIVE is assumed

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/appointments/calendar

Authorizations:
firebase
query Parameters
companyId
number
startDate
string <date-time>

If omitted, the start of the current month (UTC) is assumed

endDate
string <date-time>

If omitted, the end of the current month (UTC) is assumed

status
Array of strings
Items Enum: "PENDING" "ACTIVE" "FINISHED" "CANCELLED"

If omitted, any status will match

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/appointments/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "locationId": 0,
  • "employeeId": 0,
  • "scheduledDate": "2019-08-24T14:15:22Z",
  • "scheduledEndDate": "2019-08-24T14:15:22Z",
  • "confirmationDate": "2019-08-24T14:15:22Z",
  • "cancellationDate": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "status": "PENDING"
}

/appointments/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
locationId
number
employeeId
number
scheduledDate
string <date-time>
scheduledEndDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "locationId": 0,
  • "employeeId": 0,
  • "scheduledDate": "2019-08-24T14:15:22Z",
  • "scheduledEndDate": "2019-08-24T14:15:22Z"
}

/appointments/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/appointments/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
action
string
Enum: "CONFIRM" "FINISH"

Responses

Request samples

Content type
application/json
{
  • "action": "CONFIRM"
}

Gets the complete appointment detail for navigation

Authorizations:
firebase
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "locationId": 0,
  • "employeeId": 0,
  • "scheduledDate": "2019-08-24T14:15:22Z",
  • "scheduledEndDate": "2019-08-24T14:15:22Z",
  • "confirmationDate": "2019-08-24T14:15:22Z",
  • "cancellationDate": "2019-08-24T14:15:22Z",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "status": "PENDING"
}

/appointments/{id}/findings

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "appointmentId": 0,
  • "count": 0,
  • "findings": [
    ]
}

Starts or resumes the server-controlled signature wait

Authorizations:
firebase
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "startedAt": "2019-08-24T14:15:22Z",
  • "deadline": "2019-08-24T14:15:22Z",
  • "serverTime": "2019-08-24T14:15:22Z",
  • "waitTimeMinutes": 0,
  • "remainingSeconds": 0
}

/appointments/{id}/service-orders

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/appointments/{id}/service-orders

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
serviceOrderId
number

Responses

Request samples

Content type
application/json
{
  • "serviceOrderId": 0
}

/appointments/{appointmentId}/service-orders/{serviceOrderId}

Authorizations:
firebase
path Parameters
appointmentId
required
number
serviceOrderId
required
number

Responses

/appointments/{id}/technicians

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/appointments/{id}/technicians

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
technicianId
number

Responses

Request samples

Content type
application/json
{
  • "technicianId": 0
}

/appointments/{id}/technicians/documents

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/appointments/{appointmentId}/technicians/{technicianId}

Authorizations:
firebase
path Parameters
appointmentId
required
number
technicianId
required
number

Responses

Finding

/appointments/{id}/findings

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "appointmentId": 0,
  • "count": 0,
  • "findings": [
    ]
}

/findings

Authorizations:
firebase
query Parameters
reportAnswerId
number
companyId
number

Company filter. Client users are always restricted to their own company.

startDate
string <date-time>
endDate
string <date-time>
severity
string
Enum: "CRITICAL" "NON_CRITICAL" "DEACTIVATION"
status
string
Enum: "ACTIVE" "FINISHED" "INACTIVE" "DELETED"

Defaults to ACTIVE.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/findings

Authorizations:
firebase
Request Body schema: application/json
required
reportAnswerId
required
number
comments
required
string
severity
required
string
Enum: "CRITICAL" "NON_CRITICAL" "DEACTIVATION"

Responses

Request samples

Content type
application/json
{
  • "reportAnswerId": 0,
  • "comments": "string",
  • "severity": "CRITICAL"
}

Response samples

Content type
application/json
{
  • "id": 0
}

/findings/reports/{reportId}

Authorizations:
firebase
path Parameters
reportId
required
number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/findings/companies/{companyId}

Authorizations:
firebase
path Parameters
companyId
required
number
query Parameters
view
string
Default: "full"
Enum: "count" "full"

Use count for the notification badge or full for complete findings. Defaults to full.

Responses

Response samples

Content type
application/json
Example
{
  • "count": 0
}

/findings/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
comments
required
string
severity
required
string
Enum: "CRITICAL" "NON_CRITICAL" "DEACTIVATION"

Responses

Request samples

Content type
application/json
{
  • "comments": "string",
  • "severity": "CRITICAL"
}

/findings/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/findings/{id}/close

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
comment
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

/findings/{id}/attachments

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
reportDocumentId
required
number

Responses

Request samples

Content type
application/json
{
  • "reportDocumentId": 0
}

/findings/{findingId}/attachments/{reportDocumentId}

Authorizations:
firebase
path Parameters
findingId
required
number
reportDocumentId
required
number

Responses

Report

/reports

Authorizations:
firebase
query Parameters
serviceOrderItemId
number
serviceOrderId
number
companyId
number
locationId
number
buildingId
number
equipmentId
number
technicianId
number
fromDate
string <date-time>
toDate
string <date-time>
status
string
Enum: "ACTIVE" "FINISHED"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/reports

Authorizations:
firebase
Request Body schema: application/json
required
serviceOrderItemId
number
technicianId
number

Responses

Request samples

Content type
application/json
{
  • "serviceOrderItemId": 0,
  • "technicianId": 0
}

Response samples

Content type
application/json
{
  • "id": 0
}

/reports/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "serviceOrderItemId": 0,
  • "technicianId": 0,
  • "notes": "string",
  • "finishDate": "2019-08-24T14:15:22Z",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "status": "ACTIVE"
}

/reports/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
notes
string

Responses

Request samples

Content type
application/json
{
  • "notes": "string"
}

/reports/{id}/values

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "reportId": 0,
  • "serviceOrderItemId": 0,
  • "serviceOrderId": 0,
  • "equipmentId": 0,
  • "equipmentTypeId": 0,
  • "recurrence": "WEEKLY",
  • "formId": 0,
  • "formItemId": 0,
  • "sortIndex": 0,
  • "contents": [
    ],
  • "answers": [
    ],
  • "requiresEvidence": true,
  • "reportAnswerId": 0,
  • "values": [
    ],
  • "failedExpectations": 0,
  • "reportDocumentIds": [
    ],
  • "creationDate": "2019-08-24T14:15:22Z"
}

ReportDocument

/report-documents

Authorizations:
firebase
query Parameters
reportId
number
documentTypeId
number
status
string
Enum: "PENDING" "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/report-documents

Authorizations:
firebase
Request Body schema: application/json
required
reportId
number
documentTypeId
number
fileName
string
fileSize
number
mimeType
string

Responses

Request samples

Content type
application/json
{
  • "reportId": 0,
  • "documentTypeId": 0,
  • "fileName": "string",
  • "fileSize": 0,
  • "mimeType": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "url": "string"
}

/report-documents/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/report-documents/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/report-documents/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

ReportAnswer

/report-answers

Authorizations:
firebase
query Parameters
reportId
number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/report-answers

Authorizations:
firebase
Request Body schema: application/json
required
reportId
number
Array of objects
formItemId
number
Deprecated

Use the answers array instead

values
object
Deprecated

Use the answers array instead

Responses

Request samples

Content type
application/json
{
  • "reportId": 0,
  • "answers": [
    ],
  • "formItemId": 0,
  • "values": { }
}

Response samples

Content type
application/json
{
  • "id": 0
}

/report-answers/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "reportId": 0,
  • "formItemId": 0,
  • "values": [
    ],
  • "failedExpectations": 0,
  • "creationDate": "2019-08-24T14:15:22Z"
}

/report-answers/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
values
object

Responses

Request samples

Content type
application/json
{
  • "values": { }
}

/report-answers/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Evidence

/evidences

Authorizations:
firebase
query Parameters
reportId
number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/evidences

Authorizations:
firebase
Request Body schema: application/json
required
reportAnswerId
number
reportDocumentId
number

Responses

Request samples

Content type
application/json
{
  • "reportAnswerId": 0,
  • "reportDocumentId": 0
}

/evidences

Authorizations:
firebase
query Parameters
reportAnswerId
required
number
reportDocumentId
required
number

Responses

Building

/buildings

Authorizations:
firebase
query Parameters
locationId
number
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/buildings

Authorizations:
firebase
Request Body schema: application/json
required
locationId
number
name
string

Responses

Request samples

Content type
application/json
{
  • "locationId": 0,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

/buildings/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "locationId": 0,
  • "name": "string",
  • "status": "ACTIVE"
}

/buildings/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

/buildings/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/buildings/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Company

/companies

Authorizations:
firebase
query Parameters
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/companies

Authorizations:
firebase
Request Body schema: application/json
required
name
required
string
billingInfo
object
contractDate
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "billingInfo": { },
  • "contractDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": 0
}

/companies/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "billingInfo": { },
  • "contractDate": "2019-08-24",
  • "status": "ACTIVE"
}

/companies/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
name
required
string
billingInfo
object
contractDate
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "billingInfo": { },
  • "contractDate": "2019-08-24"
}

/companies/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/companies/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Company Document

/company-documents

Authorizations:
firebase
query Parameters
companyId
number
documentTypeId
number
status
string
Enum: "ACTIVE" "INACTIVE" "PENDING"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/company-documents

Authorizations:
firebase
Request Body schema: application/json
required
companyId
number
documentTypeId
number
fileName
string
fileSize
number
mimeType
string

Responses

Request samples

Content type
application/json
{
  • "companyId": 0,
  • "documentTypeId": 0,
  • "fileName": "string",
  • "fileSize": 0,
  • "mimeType": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "url": "string"
}

/company-documents/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}

/company-documents/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/company-documents/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Employee

/employees

Authorizations:
firebase
query Parameters
companyId
number
fullName
string
email
string
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/employees

Authorizations:
firebase
Request Body schema: application/json
required
companyId
number
fullName
string
email
string
password
string
position
string
contactInfo
object

Responses

Request samples

Content type
application/json
{
  • "companyId": 0,
  • "fullName": "string",
  • "email": "string",
  • "password": "string",
  • "position": "string",
  • "contactInfo": { }
}

Response samples

Content type
application/json
{
  • "id": 0
}

/employees/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "companyId": 0,
  • "fullName": "string",
  • "email": "string",
  • "position": "string",
  • "contactInfo": { },
  • "status": "ACTIVE"
}

/employees/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
fullName
string
email
string
position
string
contactInfo
object

Responses

Request samples

Content type
application/json
{
  • "fullName": "string",
  • "email": "string",
  • "position": "string",
  • "contactInfo": { }
}

/employees/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/employees/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/employees/{id}/status

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
status
required
string
Enum: "ACTIVE" "INACTIVE"

Responses

Request samples

Content type
application/json
{
  • "status": "ACTIVE"
}

Equipment

/equipments

Authorizations:
firebase
query Parameters
buildingId
number
equipmentTypeId
number
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/equipments

Authorizations:
firebase
Request Body schema: application/json
required
buildingId
number
equipmentTypeId
number
name
string
details
object

Responses

Request samples

Content type
application/json
{
  • "buildingId": 0,
  • "equipmentTypeId": 0,
  • "name": "string",
  • "details": { }
}

Response samples

Content type
application/json
{
  • "id": 0
}

/equipments/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "buildingId": 0,
  • "equipmentTypeId": 0,
  • "name": "string",
  • "details": { },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "lastScheduledDate": "2019-08-24T14:15:22Z",
  • "status": "ACTIVE"
}

/equipments/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
name
string
details
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "details": { }
}

/equipments/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/equipments/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/equipments/{id}/history

Authorizations:
firebase
path Parameters
id
required
number
query Parameters
recurrence
string
Enum: "WEEKLY" "MONTHLY" "QUARTERLY" "SEMIANNUAL" "ANNUAL" "YEARS_3" "YEARS_5" "YEARS_10"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/equipments/{id}/history

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
recurrence
string
Enum: "WEEKLY" "MONTHLY" "QUARTERLY" "SEMIANNUAL" "ANNUAL" "YEARS_3" "YEARS_5" "YEARS_10"
lastMaintenanceDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "recurrence": "WEEKLY",
  • "lastMaintenanceDate": "2019-08-24T14:15:22Z"
}

/equipments/{id}/maintenance-history

Authorizations:
firebase
path Parameters
id
required
number
query Parameters
startDate
string <date>
endDate
string <date>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Layout

/layouts

Authorizations:
firebase
query Parameters
locationId
number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/layouts

Authorizations:
firebase
Request Body schema: application/json
required
buildingId
number
companyDocumentId
number

Responses

Request samples

Content type
application/json
{
  • "buildingId": 0,
  • "companyDocumentId": 0
}

/layouts

Authorizations:
firebase
query Parameters
buildingId
required
number
companyDocumentId
required
number

Responses

Location

/locations

Authorizations:
firebase
query Parameters
companyId
number
status
string
Enum: "ACTIVE" "INACTIVE"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/locations

Authorizations:
firebase
Request Body schema: application/json
required
companyId
number
name
string
address
string
mapUrl
string

Responses

Request samples

Content type
application/json
{
  • "companyId": 0,
  • "name": "string",
  • "address": "string",
  • "mapUrl": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

/locations/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "companyId": 0,
  • "name": "string",
  • "address": "string",
  • "mapUrl": "string",
  • "status": "ACTIVE"
}

/locations/{id}

Authorizations:
firebase
path Parameters
id
required
number
Request Body schema: application/json
required
name
string
address
string
mapUrl
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "mapUrl": "string"
}

/locations/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses

/locations/{id}

Authorizations:
firebase
path Parameters
id
required
number

Responses