/companies

/companies/{companyId} get patch delete

get

Obtener detalle de la compañía.

patch

Actualizar compañía.

delete

Dar de baja una compañía.

Obtener detalle de la compañía.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "creationDate": "2020-09-11T03:20:18Z",
      "lastUpdateDate": "2021-01-14T12:58:29Z",
      "name": "Qaroni EMEA S.L.",
      "tradeName": "Qaroni",
      "email": "contact@qaroni.com",
      "phone": "632899315",
      "document": {
        "documentType": "CIF",
        "documentNumber": "B7019392321Y"
      },
      "address": {
        "alias": "Company",
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "postalCode": "15172",
        "country": "ES",
        "location": {
          "longitude": -8.379264119488226,
          "latitude": 43.333946904210705,
          "altitude": null,
          "relevantText": null
        }
      },
      "logoURL": "https://s3.eu-central-1.amazonaws.com/workards.dev/companies/f563978c-ccb6-4e28-a953-b9407914b34c/logos/062ebdb2-a0cf-49d1-aceb-5b01afeb7020.png",
      "status": "ENABLED",
      "timezone": "Europe/Madrid",
      "billingInformation": {
        "planId": "ba0c158d-4568-4f25-a93d-409cf2758ca9",
        "totalSeats": 5,
        "paymentMethodDescription": "Pago Stripe",
        "paymentMethod": "CREDIT_CARD",
        "taxName": "CIF",
        "taxId": "B7019392321Y",
        "taxAddress": {
          "alias": null,
          "line1": "Rúa Hábitat, 10 Bajo",
          "line2": null,
          "city": "Oleiros",
          "stateProvince": "A Coruña",
          "postalCode": "15172",
          "country": "ES",
          "location": null
        }
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar compañía.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "name": "Qaroni EMEA S.L.",
  "tradeName": "Qaroni",
  "email": "contact@qaroni.com",
  "phone": "632899315",
  "document": {
    "documentType": "CIF",
    "documentNumber": "B7019392321Y"
  },
  "address": {
    "alias": "Company",
    "line1": "Rúa Hábitat, 10 Bajo",
    "line2": null,
    "city": "Oleiros",
    "stateProvince": "A Coruña",
    "postalCode": "15172",
    "country": "ES",
    "location": {
      "longitude": -8.379264119488226,
      "latitude": 43.333946904210705,
      "altitude": null,
      "relevantText": null
    }
  },
  "status": "ENABLED",
  "timezone": "Europe/Madrid",
  "billingInformation": {
    "planId": "ba0c158d-4568-4f25-a93d-409cf2758ca9",
    "totalSeats": 5,
    "paymentMethodDescription": "Pago Stripe",
    "paymentMethod": "CREDIT_CARD",
    "taxName": "CIF",
    "taxId": "B7019392321Y",
    "taxAddress": {
      "line1": "Rúa Hábitat, 10 Bajo",
      "line2": null,
      "city": "Oleiros",
      "stateProvince": "A Coruña",
      "postalCode": "15172",
      "country": "ES"
    }
  }
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "creationDate": "2020-09-11T03:20:18Z",
      "lastUpdateDate": "2021-01-14T12:58:29Z",
      "name": "Qaroni EMEA S.L.",
      "tradeName": "Qaroni",
      "email": "contact@qaroni.com",
      "phone": "632899315",
      "document": {
        "documentType": "CIF",
        "documentNumber": "B7019392321Y"
      },
      "address": {
        "alias": "Company",
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "postalCode": "15172",
        "country": "ES",
        "location": {
          "longitude": -8.379264119488226,
          "latitude": 43.333946904210705,
          "altitude": null,
          "relevantText": null
        }
      },
      "logoURL": "https://s3.eu-central-1.amazonaws.com/workards.dev/companies/f563978c-ccb6-4e28-a953-b9407914b34c/logos/062ebdb2-a0cf-49d1-aceb-5b01afeb7020.png",
      "status": "ENABLED",
      "timezone": "Europe/Madrid",
      "billingInformation": {
        "planId": "ba0c158d-4568-4f25-a93d-409cf2758ca9",
        "totalSeats": 5,
        "paymentMethodDescription": "Pago Stripe",
        "paymentMethod": "CREDIT_CARD",
        "taxName": "CIF",
        "taxId": "B7019392321Y",
        "taxAddress": {
          "alias": null,
          "line1": "Rúa Hábitat, 10 Bajo",
          "line2": null,
          "city": "Oleiros",
          "stateProvince": "A Coruña",
          "postalCode": "15172",
          "country": "ES",
          "location": null
        }
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Dar de baja una compañía.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/checks get

get

Listar los checks que pertenecen a la compañía.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

pagination: (integer)
Cantidad de registros que se desea recibir. Por defecto trae hasta 100 resultados.
Example:
```
2
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1600970047118",
      "creationDate": "2020-09-24T16:54:07Z",
      "lastUpdateDate": "2020-10-09T20:11:47Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "type": "REMOTE",
      "reason": "JOURNEY",
      "action": "EXIT",
      "temperature": null,
      "location": {
        "longitude": -74.8012283,
        "latitude": 10.9918783,
        "altitude": null,
        "relevantText": null
      },
      "photoURL": null,
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/dashboards get

get

Obtener dashboard para la compañía.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "offline": 2,
      "onBreak": 2,
      "online": 12,
      "total": 16
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/employees post get

post

Crear una ficha de empleado.

get

Listar los empleados de una compañía.

Crear una ficha de empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "firstName": "Julio",
  "lastName": "Amaya",
  "email": "atpjulio@yahoo.es",
  "dni": "DH23238281",
  "birthdate": "1985-02-07",
  "gender": "MALE",
  "phone": "693828282",
  "bossId": null,
  "position": "Software Developer",
  "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04"
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-10-16T15:36:44Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": null,
      "bossId": null,
      "walletId": "e26e41e1-5ef8-402f-a600-7516b17b9ac6",
      "firstName": "Julio",
      "lastName": "Amaya",
      "email": "atpjulio@yahoo.es",
      "phone": "693828282",
      "dni": "DH23238281",
      "birthdate": "1985-02-07T05:00:00Z",
      "position": "Software Developer",
      "access": "6abf5892-cea4-40f9-a94d-853dfde3af74",
      "pin": "5415",
      "gender": "MALE",
      "status": "ENABLED",
      "state": "OFFLINE",
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8",
      "employeeCard": "https://s3.eu-central-1.amazonaws.com/qaroni.walletitems.d/e26e41e1-5ef8-402f-a600-7516b17b9ac6.pkpass",
      "timezone": "Europe/Madrid",
      "linkedUser": {
        "email": "atpjulio@yahoo.es",
        "role": "ADMIN",
        "creationDate": "2020-10-17T13:38:22Z"
      },
      "remoteAccess": true
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Listar los empleados de una compañía.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

status: (string)
Filtrar por status de los empleados que pueden ser ENABLED, DISABLED.
Example:
```
ENABLED
```
last: (integer)
Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.
Example:
```
2
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-10-16T15:36:44Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": null,
      "bossId": null,
      "walletId": "e26e41e1-5ef8-402f-a600-7516b17b9ac6",
      "firstName": "Julio",
      "lastName": "Amaya",
      "email": "atpjulio@yahoo.es",
      "phone": "693828282",
      "dni": "DH23238281",
      "birthdate": "1985-02-07T05:00:00Z",
      "position": "Software Developer",
      "access": "6abf5892-cea4-40f9-a94d-853dfde3af74",
      "pin": "5415",
      "gender": "MALE",
      "status": "ENABLED",
      "state": "OFFLINE",
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8",
      "employeeCard": "https://s3.eu-central-1.amazonaws.com/qaroni.walletitems.d/e26e41e1-5ef8-402f-a600-7516b17b9ac6.pkpass",
      "timezone": "Europe/Madrid",
      "linkedUser": {
        "email": "atpjulio@yahoo.es",
        "role": "ADMIN",
        "creationDate": "2020-10-17T13:38:22Z"
      },
      "remoteAccess": true
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/employees/access post

post

Obtener ficha del empleado enviando clave pin o UUID de access, los posibles valores de type son PIN, ACCESS.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "type": "PIN",
  "key": "5415"
}

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-10-16T15:36:44Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": null,
      "bossId": null,
      "walletId": "e26e41e1-5ef8-402f-a600-7516b17b9ac6",
      "firstName": "Julio",
      "lastName": "Amaya",
      "email": "atpjulio@yahoo.es",
      "phone": "693828282",
      "dni": "DH23238281",
      "birthdate": "1985-02-07T05:00:00Z",
      "position": "Software Developer",
      "access": "6abf5892-cea4-40f9-a94d-853dfde3af74",
      "pin": "5415",
      "gender": "MALE",
      "status": "ENABLED",
      "state": "OFFLINE",
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8",
      "employeeCard": "https://s3.eu-central-1.amazonaws.com/qaroni.walletitems.d/e26e41e1-5ef8-402f-a600-7516b17b9ac6.pkpass",
      "timezone": "Europe/Madrid",
      "linkedUser": {
        "email": "atpjulio@yahoo.es",
        "role": "ADMIN",
        "creationDate": "2020-10-17T13:38:22Z"
      },
      "remoteAccess": true
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/employees/{employeeId} get patch delete

get

Detalle de un empleado del centro de trabajo.

patch

Actualizar ficha de empleado.

delete

Dar de baja un empleado.

Detalle de un empleado del centro de trabajo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-10-16T15:36:44Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": null,
      "bossId": null,
      "walletId": "e26e41e1-5ef8-402f-a600-7516b17b9ac6",
      "firstName": "Julio",
      "lastName": "Amaya",
      "email": "atpjulio@yahoo.es",
      "phone": "693828282",
      "dni": "DH23238281",
      "birthdate": "1985-02-07T05:00:00Z",
      "position": "Software Developer",
      "access": "6abf5892-cea4-40f9-a94d-853dfde3af74",
      "pin": "5415",
      "gender": "MALE",
      "status": "ENABLED",
      "state": "OFFLINE",
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8",
      "employeeCard": "https://s3.eu-central-1.amazonaws.com/qaroni.walletitems.d/e26e41e1-5ef8-402f-a600-7516b17b9ac6.pkpass",
      "timezone": "Europe/Madrid",
      "linkedUser": {
        "email": "atpjulio@yahoo.es",
        "role": "ADMIN",
        "creationDate": "2020-10-17T13:38:22Z"
      },
      "remoteAccess": true
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar ficha de empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "firstName": "Julio",
  "lastName": "Amaya",
  "email": "atpjulio@yahoo.es",
  "dni": "DH23238281",
  "birthdate": "1985-02-07",
  "gender": "MALE",
  "phone": "693828282",
  "bossId": null,
  "position": "Software Developer",
  "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04"
}

HTTP status code 200

Se actualiza el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-10-16T15:36:44Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": null,
      "bossId": null,
      "walletId": "e26e41e1-5ef8-402f-a600-7516b17b9ac6",
      "firstName": "Julio",
      "lastName": "Amaya",
      "email": "atpjulio@yahoo.es",
      "phone": "693828282",
      "dni": "DH23238281",
      "birthdate": "1985-02-07T05:00:00Z",
      "position": "Software Developer",
      "access": "6abf5892-cea4-40f9-a94d-853dfde3af74",
      "pin": "5415",
      "gender": "MALE",
      "status": "ENABLED",
      "state": "OFFLINE",
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8",
      "employeeCard": "https://s3.eu-central-1.amazonaws.com/qaroni.walletitems.d/e26e41e1-5ef8-402f-a600-7516b17b9ac6.pkpass",
      "timezone": "Europe/Madrid",
      "linkedUser": {
        "email": "atpjulio@yahoo.es",
        "role": "ADMIN",
        "creationDate": "2020-10-17T13:38:22Z"
      },
      "remoteAccess": true
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Dar de baja un empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.

Annotations

deprecated
```
"Método a ser removido próximamente."
```

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/employees/{employeeId}/cards/emails post

post

Se envía la tarjeta de trabajo por correo, si no existe la tarjeta, se crea.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se envía correo de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/employees/{employeeId}/checks post get

post

Hacer un check.

get

Listar los checks que pertenecen al usuario.

Hacer un check.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: multipart/form-data

Type: object

Properties

check: required(file)

Example:

{
  "workplaceId": "b7b8653c-d7df-4941-91e6-33c203164939",
  "type": "REMOTE",
  "reason": "Journey",
  "action": "ENTRANCE",
  "location": {
    "latitude": 43.3619312,
    "longitude": -8.4477891
  }
}

photo: (file)
Foto a subir.

HTTP status code 201

Se crea el recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1600970047118",
      "creationDate": "2020-09-24T16:54:07Z",
      "lastUpdateDate": "2020-10-09T20:11:47Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "type": "REMOTE",
      "reason": "JOURNEY",
      "action": "EXIT",
      "temperature": null,
      "location": {
        "longitude": -74.8012283,
        "latitude": 10.9918783,
        "altitude": null,
        "relevantText": null
      },
      "photoURL": null,
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Listar los checks que pertenecen al usuario.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

sortDirection: (string)
Dirección de orden de listado ASC, DESC. Por defecto vendrá DESC.
Example:
```
ASC
```
dateFrom: (string)
Filtrar por fecha inicial (Formato YYYY-MM-ddThh:mm:ssZ) comparando con creationDate.
Example:
```
2020-05-02T02:00:00Z
```
dateTo: (string)
Filtrar por fecha final (Formato YYYY-MM-ddThh:mm:ssZ) comparando con creationDate.
Example:
```
2020-05-09T01:59:59Z
```
last: (integer)
Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.
Example:
```
2
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1600970047118",
      "creationDate": "2020-09-24T16:54:07Z",
      "lastUpdateDate": "2020-10-09T20:11:47Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "type": "REMOTE",
      "reason": "JOURNEY",
      "action": "EXIT",
      "temperature": null,
      "location": {
        "longitude": -74.8012283,
        "latitude": 10.9918783,
        "altitude": null,
        "relevantText": null
      },
      "photoURL": null,
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/employees/{employeeId}/checks/{checkId} get patch

get

Detalle de check con su array history.

patch

Actualizar check y guardar historia de ello.

Detalle de check con su array history.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.
checkId: required(string)
Identificador único del Check.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1600970047118",
      "creationDate": "2020-09-24T16:54:07Z",
      "lastUpdateDate": "2020-10-09T20:11:47Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "type": "REMOTE",
      "reason": "JOURNEY",
      "action": "EXIT",
      "temperature": null,
      "location": {
        "longitude": -74.8012283,
        "latitude": 10.9918783,
        "altitude": null,
        "relevantText": null
      },
      "photoURL": null,
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8",
      "history": [
        {
          "id": "1602274307191",
          "creationDate": "2020-10-09T20:11:47Z",
          "lastUpdateDate": "2020-10-09T20:11:47Z",
          "checkId": "1600970047118",
          "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
          "oldCreationDate": "2020-09-24T17:54:07Z",
          "newCreationDate": "2020-09-24T16:54:07Z",
          "comment": "Se ajusta fecha de salida ya que el empleado olvidó hacer fichaje"
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar check y guardar historia de ello.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.
checkId: required(string)
Identificador único del Check.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "newCreationDate": "2020-09-24T16:54:07Z",
  "comment": "Se ajusta fecha de inicio ya que el empleado olvidó hacer fichaje"
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1600970047118",
      "creationDate": "2020-09-24T16:54:07Z",
      "lastUpdateDate": "2020-10-09T20:11:47Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "type": "REMOTE",
      "reason": "JOURNEY",
      "action": "EXIT",
      "temperature": null,
      "location": {
        "longitude": -74.8012283,
        "latitude": 10.9918783,
        "altitude": null,
        "relevantText": null
      },
      "photoURL": null,
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/employees/{employeeId}/checks/reports get

get

Reporte de checks que pertenecen al empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "regular": 63.11,
      "extra": 0.0,
      "total": 63.11,
      "rest": 16.89,
      "dateFrom": "2019-09-21T00:00:00Z",
      "dateTo": "2020-09-21T23:59:59Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/employees/{employeeId}/checks/reports/{reportId}/months post get

post

Generar reporte de checks que pertenecen al empleado.

get

Reporte de checks que pertenecen al empleado.

Generar reporte de checks que pertenecen al empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.
reportId: required(string)
description

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 201

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "202006",
      "creationDate": "2020-09-21T14:11:29Z",
      "lastUpdateDate": "2020-09-21T14:11:29Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "reportHourcheck": {
        "regular": 15.78,
        "extra": 0.0,
        "total": 15.78,
        "rest": 4.22,
        "dateFrom": "2020-06-01T00:00:00Z",
        "dateTo": "2020-06-30T23:59:59Z"
      },
      "reportURL": "https://s3.eu-central-1.amazonaws.com/workards.dev/companies/f563978c-ccb6-4e28-a953-b9407914b34c/employees/8899ce7c-8792-4a69-9607-95f6a8c19c70/reports/202009.pdf"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Reporte de checks que pertenecen al empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.
reportId: required(string)
description

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "202006",
      "creationDate": "2020-09-21T14:11:29Z",
      "lastUpdateDate": "2020-09-21T14:11:29Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "reportHourcheck": {
        "regular": 15.78,
        "extra": 0.0,
        "total": 15.78,
        "rest": 4.22,
        "dateFrom": "2020-06-01T00:00:00Z",
        "dateTo": "2020-06-30T23:59:59Z"
      },
      "reportURL": "https://s3.eu-central-1.amazonaws.com/workards.dev/companies/f563978c-ccb6-4e28-a953-b9407914b34c/employees/8899ce7c-8792-4a69-9607-95f6a8c19c70/reports/202009.pdf"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/employees/{employeeId}/checks/reports/months get

get

Reporte de checks que pertenecen al empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

last: (integer)
Últimos meses desde el actual.
Example:
```
6
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "202006",
      "creationDate": "2020-09-21T14:11:29Z",
      "lastUpdateDate": "2020-09-21T14:11:29Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "reportHourcheck": {
        "regular": 15.78,
        "extra": 0.0,
        "total": 15.78,
        "rest": 4.22,
        "dateFrom": "2020-06-01T00:00:00Z",
        "dateTo": "2020-06-30T23:59:59Z"
      },
      "reportURL": "https://s3.eu-central-1.amazonaws.com/workards.dev/companies/f563978c-ccb6-4e28-a953-b9407914b34c/employees/8899ce7c-8792-4a69-9607-95f6a8c19c70/reports/202009.pdf"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/employees/{employeeId}/checks/shifts get

get

Listar los checks que pertenecen a la última jornada del empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

last: (integer)
Últimos checks.
Example:
```
6
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1600970047118",
      "creationDate": "2020-09-24T16:54:07Z",
      "lastUpdateDate": "2020-10-09T20:11:47Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "type": "REMOTE",
      "reason": "JOURNEY",
      "action": "EXIT",
      "temperature": null,
      "location": {
        "longitude": -74.8012283,
        "latitude": 10.9918783,
        "altitude": null,
        "relevantText": null
      },
      "photoURL": null,
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/employees/{employeeId}/disables patch

patch

Dar de baja a un empleado indicado si fue voluntaria o despido (VOLUNTARY, FIRED).

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "disableType": "VOLUNTARY",
  "comment": "Se retira por problemas personales"
}

HTTP status code 200

Se actualiza el registro de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-09-18T00:39:13Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": null,
      "linkedUser": null,
      "bossId": null,
      "firstName": "Julio",
      "lastName": "Amaya",
      "email": "atpjulio@yahoo.es",
      "phone": "693828282",
      "dni": "DH23238281",
      "birthdate": "1985-02-07T05:00:00Z",
      "position": "Software Developer",
      "access": "6abf5892-cea4-40f9-a94d-853dfde3af74",
      "gender": "MALE",
      "status": "DISABLED",
      "state": null,
      "workday": null
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/employees/{employeeId}/dissociates patch

patch

Desasociar usuario existente a ficha de empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se actualiza el registro de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-10-16T15:36:44Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": null,
      "bossId": null,
      "walletId": "e26e41e1-5ef8-402f-a600-7516b17b9ac6",
      "firstName": "Julio",
      "lastName": "Amaya",
      "email": "atpjulio@yahoo.es",
      "phone": "693828282",
      "dni": "DH23238281",
      "birthdate": "1985-02-07T05:00:00Z",
      "position": "Software Developer",
      "access": "6abf5892-cea4-40f9-a94d-853dfde3af74",
      "pin": "5415",
      "gender": "MALE",
      "status": "ENABLED",
      "state": "OFFLINE",
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8",
      "employeeCard": "https://s3.eu-central-1.amazonaws.com/qaroni.walletitems.d/e26e41e1-5ef8-402f-a600-7516b17b9ac6.pkpass",
      "timezone": "Europe/Madrid",
      "linkedUser": {
        "email": "atpjulio@yahoo.es",
        "role": "ADMIN",
        "creationDate": "2020-10-17T13:38:22Z"
      },
      "remoteAccess": true
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/employees/{employeeId}/enables patch

patch

Recuperar a un empleado que fue dado de baja.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "comment": "Regresa porque no le fue bien en su emprendimiento y con nosotros siempre se portó bien"
}

HTTP status code 200

Se actualiza el registro de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-10-16T15:36:44Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": null,
      "bossId": null,
      "walletId": "e26e41e1-5ef8-402f-a600-7516b17b9ac6",
      "firstName": "Julio",
      "lastName": "Amaya",
      "email": "atpjulio@yahoo.es",
      "phone": "693828282",
      "dni": "DH23238281",
      "birthdate": "1985-02-07T05:00:00Z",
      "position": "Software Developer",
      "access": "6abf5892-cea4-40f9-a94d-853dfde3af74",
      "pin": "5415",
      "gender": "MALE",
      "status": "ENABLED",
      "state": "OFFLINE",
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8",
      "employeeCard": "https://s3.eu-central-1.amazonaws.com/qaroni.walletitems.d/e26e41e1-5ef8-402f-a600-7516b17b9ac6.pkpass",
      "timezone": "Europe/Madrid",
      "linkedUser": {
        "email": "atpjulio@yahoo.es",
        "role": "ADMIN",
        "creationDate": "2020-10-17T13:38:22Z"
      },
      "remoteAccess": true
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/employees/{employeeId}/invitations get

get

Ver invitaciones del empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
employeeId: required(string)
Identificador único del usuario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "7b8519d3-b6f0-4d46-ba23-4bfac52cce52",
      "creationDate": "2020-09-11T12:14:11Z",
      "lastUpdateDate": "2020-09-11T12:14:11Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "originUserId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "email": "atpjulio@yahoo.es",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "status": "CREATED",
      "role": "ADMIN"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/invitations post get

post

Crear una invitación.

get

Listar las invitaciones creadas por la compañía.

Crear una invitación.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
  "email": "atpjulio@yahoo.es",
  "role": "ADMIN"
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "7b8519d3-b6f0-4d46-ba23-4bfac52cce52",
      "creationDate": "2020-09-11T12:14:11Z",
      "lastUpdateDate": "2020-09-11T12:14:11Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "originUserId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "email": "atpjulio@yahoo.es",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "status": "CREATED",
      "role": "ADMIN"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Listar las invitaciones creadas por la compañía.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

status: (one of CREATED, ACCEPTED, REJECTED)
Status de la invitación. Por defecto trae los CREATED
Example:
```
ACCEPTED
```
last: (integer)
Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.
Example:
```
2
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "7b8519d3-b6f0-4d46-ba23-4bfac52cce52",
      "creationDate": "2020-09-11T12:14:11Z",
      "lastUpdateDate": "2020-09-11T12:14:11Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "originUserId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "email": "atpjulio@yahoo.es",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "status": "CREATED",
      "role": "ADMIN"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/logos post delete

post

Añade o actualiza logo de la compañía.

delete

Borrar logo de la compañía.

Añade o actualiza logo de la compañía.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: multipart/form-data

Type: object

Properties

logo: required(file)
Fichero a subir.

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "creationDate": "2020-09-11T03:20:18Z",
      "lastUpdateDate": "2021-01-14T12:58:29Z",
      "name": "Qaroni EMEA S.L.",
      "tradeName": "Qaroni",
      "email": "contact@qaroni.com",
      "phone": "632899315",
      "document": {
        "documentType": "CIF",
        "documentNumber": "B7019392321Y"
      },
      "address": {
        "alias": "Company",
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "postalCode": "15172",
        "country": "ES",
        "location": {
          "longitude": -8.379264119488226,
          "latitude": 43.333946904210705,
          "altitude": null,
          "relevantText": null
        }
      },
      "logoURL": "https://s3.eu-central-1.amazonaws.com/workards.dev/companies/f563978c-ccb6-4e28-a953-b9407914b34c/logos/062ebdb2-a0cf-49d1-aceb-5b01afeb7020.png",
      "status": "ENABLED",
      "timezone": "Europe/Madrid",
      "billingInformation": {
        "planId": "ba0c158d-4568-4f25-a93d-409cf2758ca9",
        "totalSeats": 5,
        "paymentMethodDescription": "Pago Stripe",
        "paymentMethod": "CREDIT_CARD",
        "taxName": "CIF",
        "taxId": "B7019392321Y",
        "taxAddress": {
          "alias": null,
          "line1": "Rúa Hábitat, 10 Bajo",
          "line2": null,
          "city": "Oleiros",
          "stateProvince": "A Coruña",
          "postalCode": "15172",
          "country": "ES",
          "location": null
        }
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Borrar logo de la compañía.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se elimina logo correctamente.

Body

Media type: application/json

Example:

{
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "d3e843fd-cfd9-40da-851b-4a04cb6d45ff",
      "creationDate": "2020-03-29T03:36:02Z",
      "lastUpdateDate": "2020-03-29T03:36:02Z",
      "name": "Qaroni EMEA SA",
      "email": "contact@qaroni.com",
      "phone": "632899315",
      "document": {
        "documentType": "CIF",
        "documentNumber": "19392321Y"
      },
      "address": {
        "id": "3db1cebc-ea9a-4ff1-aeac-bf819349d3b1",
        "creationDate": "2020-03-29T03:36:02Z",
        "lastUpdateDate": "2020-03-29T03:36:02Z",
        "alias": "Dirección principal",
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": "",
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "postalCode": "15172",
        "country": "ES",
        "latitude": 43.3340781,
        "longitude": -8.3791935
      },
      "logoURL": " "
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/notifications post get

post

Crear una notificación, los campos date e internal por ahora son opcionales.

get

Listar las plantillas de notificación de la compañía.

Crear una notificación, los campos date e internal por ahora son opcionales.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "templateId": "2ee0dde5-b9d3-4fb8-9b5c-68d57b700b93",
  "date": "2021-02-17T07:00:00Z",
  "internal": true,
  "notification": {
    "title": "Titulo que será sobre escrito si llega templateId",
    "message": "El mensaje que será sobre escrito si llega templateId",
    "iconUrl": "",
    "actionUrl": ""
  }
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "87c80bcf-b816-43ee-9e7e-05ace8da6722",
      "creationDate": null,
      "lastUpdateDate": "2021-02-09T17:05:05Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "templateId": "2ee0dde5-b9d3-4fb8-9b5c-68d57b700b93",
      "status": null,
      "date": "2021-02-17T07:00:00Z",
      "internal": true,
      "notification": {
        "title": "Titulo de notificación",
        "message": "El mensaje de la notificación",
        "iconUrl": null,
        "actionUrl": null
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Listar las plantillas de notificación de la compañía.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

status: (string)
Filtrar por status CREATED, SENT.
Example:
```
CREATED
```
search: (string)
Buscar por el título de la plantilla.
Example:
```
Titulo
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "87c80bcf-b816-43ee-9e7e-05ace8da6722",
      "creationDate": null,
      "lastUpdateDate": "2021-02-09T17:05:05Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "templateId": "2ee0dde5-b9d3-4fb8-9b5c-68d57b700b93",
      "status": null,
      "date": "2021-02-17T07:00:00Z",
      "internal": true,
      "notification": {
        "title": "Titulo de notificación",
        "message": "El mensaje de la notificación",
        "iconUrl": null,
        "actionUrl": null
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/notifications/{notificationId} get patch delete

get

Obtener detalle de la notificación.

patch

Actualizar notificación.

delete

Borrar notificación.

Obtener detalle de la notificación.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
notificationId: required(string)
Identificador único de la notificación.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "87c80bcf-b816-43ee-9e7e-05ace8da6722",
      "creationDate": null,
      "lastUpdateDate": "2021-02-09T17:05:05Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "templateId": "2ee0dde5-b9d3-4fb8-9b5c-68d57b700b93",
      "status": null,
      "date": "2021-02-17T07:00:00Z",
      "internal": true,
      "notification": {
        "title": "Titulo de notificación",
        "message": "El mensaje de la notificación",
        "iconUrl": null,
        "actionUrl": null
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar notificación.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
notificationId: required(string)
Identificador único de la notificación.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "templateId": "2ee0dde5-b9d3-4fb8-9b5c-68d57b700b93",
  "date": "2021-02-17T07:00:00Z",
  "internal": true,
  "notification": {
    "title": "Titulo que será sobre escrito si llega templateId",
    "message": "El mensaje que será sobre escrito si llega templateId",
    "iconUrl": "",
    "actionUrl": ""
  }
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "87c80bcf-b816-43ee-9e7e-05ace8da6722",
      "creationDate": null,
      "lastUpdateDate": "2021-02-09T17:05:05Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "templateId": "2ee0dde5-b9d3-4fb8-9b5c-68d57b700b93",
      "status": null,
      "date": "2021-02-17T07:00:00Z",
      "internal": true,
      "notification": {
        "title": "Titulo de notificación",
        "message": "El mensaje de la notificación",
        "iconUrl": null,
        "actionUrl": null
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Borrar notificación.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
notificationId: required(string)
Identificador único de la notificación.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/notifications/{notificationId}/sends post

post

Enviar notificación a todos los empleados.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
notificationId: required(string)
Identificador único de la notificación.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "templateId": "2ee0dde5-b9d3-4fb8-9b5c-68d57b700b93",
  "date": "2021-02-17T07:00:00Z",
  "internal": true,
  "notification": {
    "title": "Titulo que será sobre escrito si llega templateId",
    "message": "El mensaje que será sobre escrito si llega templateId",
    "iconUrl": "",
    "actionUrl": ""
  }
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "87c80bcf-b816-43ee-9e7e-05ace8da6722",
      "creationDate": null,
      "lastUpdateDate": "2021-02-09T17:05:05Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "templateId": "2ee0dde5-b9d3-4fb8-9b5c-68d57b700b93",
      "status": null,
      "date": "2021-02-17T07:00:00Z",
      "internal": true,
      "notification": {
        "title": "Titulo de notificación",
        "message": "El mensaje de la notificación",
        "iconUrl": null,
        "actionUrl": null
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/notifications/{notificationId}/sends/employees post

post

Enviar notificación a los empleados recibidos del array.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
notificationId: required(string)
Identificador único de la notificación.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "employeeIds": [
    "0d4f2b73-8457-44d0-8fc7-7e0491bfd87a",
    "1ee4457a-51fd-4f2c-a73f-b63f2d795be2"
  ]
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "87c80bcf-b816-43ee-9e7e-05ace8da6722",
      "creationDate": null,
      "lastUpdateDate": "2021-02-09T17:05:05Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "templateId": "2ee0dde5-b9d3-4fb8-9b5c-68d57b700b93",
      "status": null,
      "date": "2021-02-17T07:00:00Z",
      "internal": true,
      "notification": {
        "title": "Titulo de notificación",
        "message": "El mensaje de la notificación",
        "iconUrl": null,
        "actionUrl": null
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/notifications/templates post get

post

Crear una plantilla de notificación, los posibles valores para status son CREATED, ENABLED, DISABLED.

get

Listar las plantillas de notificación de la compañía.

Crear una plantilla de notificación, los posibles valores para status son CREATED, ENABLED, DISABLED.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "status": "CREATED",
  "notification": {
    "title": "Titulo de notificación",
    "message": "El mensaje de la notificación",
    "iconUrl": "",
    "actionUrl": ""
  }
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "2ee0dde5-b9d3-4fb8-9b5c-68d57b700b93",
      "creationDate": "2021-02-09T15:10:34Z",
      "lastUpdateDate": "2021-02-09T15:10:34Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "status": "CREATED",
      "notification": {
        "title": "Titulo de notificación",
        "message": "El mensaje de la notificación",
        "iconUrl": "",
        "actionUrl": ""
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Listar las plantillas de notificación de la compañía.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

status: (string)
Filtrar por status CREATED, ENABLED, DISABLED.
Example:
```
CREATED
```
search: (string)
Buscar por el título de la plantilla.
Example:
```
Titulo
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "2ee0dde5-b9d3-4fb8-9b5c-68d57b700b93",
      "creationDate": "2021-02-09T15:10:34Z",
      "lastUpdateDate": "2021-02-09T15:10:34Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "status": "CREATED",
      "notification": {
        "title": "Titulo de notificación",
        "message": "El mensaje de la notificación",
        "iconUrl": "",
        "actionUrl": ""
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/notifications/templates/{templateId} get patch delete

get

Obtener detalle de la plantilla de notificación.

patch

Actualizar plantilla de notificación.

delete

Borrar plantilla de notificación.

Obtener detalle de la plantilla de notificación.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
templateId: required(string)
Identificador único de la plantilla de notificación.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "2ee0dde5-b9d3-4fb8-9b5c-68d57b700b93",
      "creationDate": "2021-02-09T15:10:34Z",
      "lastUpdateDate": "2021-02-09T15:10:34Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "status": "CREATED",
      "notification": {
        "title": "Titulo de notificación",
        "message": "El mensaje de la notificación",
        "iconUrl": "",
        "actionUrl": ""
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar plantilla de notificación.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
templateId: required(string)
Identificador único de la plantilla de notificación.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "status": "CREATED",
  "notification": {
    "title": "Titulo de notificación",
    "message": "El mensaje de la notificación",
    "iconUrl": "",
    "actionUrl": ""
  }
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "2ee0dde5-b9d3-4fb8-9b5c-68d57b700b93",
      "creationDate": "2021-02-09T15:10:34Z",
      "lastUpdateDate": "2021-02-09T15:10:34Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "status": "CREATED",
      "notification": {
        "title": "Titulo de notificación",
        "message": "El mensaje de la notificación",
        "iconUrl": "",
        "actionUrl": ""
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Borrar plantilla de notificación.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
templateId: required(string)
Identificador único de la plantilla de notificación.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/plans/{planId} delete

delete

Darse de baja del plan suscrito.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
planId: required(string)
Identificador único del plan.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/plans/{planId}/checkouts post

post

Crear sesión de pago (Checkout).

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
planId: required(string)
Identificador único del plan.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "paymentMethod": "CREDIT_CARD"
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "sessionId": "cs_test_a1mp4BY4n86Ocu8BiNbootkf6DDsfluDUC3mBLLGohvxyQp5tMv25HOlpP"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/schedules post get

post

Crear una plantilla de horario. Posibles valores para status ACTIVE, INACTIVE.

get

Listar plantillas de horario.

Crear una plantilla de horario. Posibles valores para status ACTIVE, INACTIVE.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "companyId": "db46ada4-ee62-4898-9ac9-5e366fb47629",
  "name": "Horario estándar",
  "monday": [
    {
      "hourFrom": "08:00",
      "hourTo": "17:00"
    }
  ],
  "tuesday": [
    {
      "hourFrom": "08:00",
      "hourTo": "17:00"
    }
  ],
  "wednesday": [
    {
      "hourFrom": "08:00",
      "hourTo": "17:00"
    }
  ],
  "thursday": [
    {
      "hourFrom": "08:00",
      "hourTo": "17:00"
    }
  ],
  "friday": [
    {
      "hourFrom": "08:00",
      "hourTo": "17:00"
    }
  ],
  "saturday": null,
  "sunday": null,
  "status": "ACTIVE"
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1ab12a05-519f-4ec2-9031-41be8af3a403",
      "creationDate": "2020-12-28T23:14:23Z",
      "lastUpdateDate": "2020-12-28T23:14:23Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "name": "Horario estándar",
      "weeklyHour": 45.0,
      "monday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "tuesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "wednesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "thursday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "friday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "saturday": null,
      "sunday": null,
      "status": "ACTIVE"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Listar plantillas de horario.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

search: (string)
Buscar por el nombre de la plantilla.
Example:
```
A Coruña
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1ab12a05-519f-4ec2-9031-41be8af3a403",
      "creationDate": "2020-12-28T23:14:23Z",
      "lastUpdateDate": "2020-12-28T23:14:23Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "name": "Horario estándar",
      "weeklyHour": 45.0,
      "monday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "tuesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "wednesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "thursday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "friday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "saturday": null,
      "sunday": null,
      "status": "ACTIVE"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/schedules/{scheduleId} get patch delete

get

Obtener detalle de una plantilla de horario.

patch

Actualizar una plantilla de horario.

delete

Borrar una plantilla de horario.

Obtener detalle de una plantilla de horario.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
scheduleId: required(string)
Identificador único del horario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1ab12a05-519f-4ec2-9031-41be8af3a403",
      "creationDate": "2020-12-28T23:14:23Z",
      "lastUpdateDate": "2020-12-28T23:14:23Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "name": "Horario estándar",
      "weeklyHour": 45.0,
      "monday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "tuesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "wednesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "thursday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "friday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "saturday": null,
      "sunday": null,
      "status": "ACTIVE"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar una plantilla de horario.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
scheduleId: required(string)
Identificador único del horario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "companyId": "db46ada4-ee62-4898-9ac9-5e366fb47629",
  "name": "Horario estándar",
  "monday": [
    {
      "hourFrom": "08:00",
      "hourTo": "17:00"
    }
  ],
  "tuesday": [
    {
      "hourFrom": "08:00",
      "hourTo": "17:00"
    }
  ],
  "wednesday": [
    {
      "hourFrom": "08:00",
      "hourTo": "17:00"
    }
  ],
  "thursday": [
    {
      "hourFrom": "08:00",
      "hourTo": "17:00"
    }
  ],
  "friday": [
    {
      "hourFrom": "08:00",
      "hourTo": "17:00"
    }
  ],
  "saturday": null,
  "sunday": null,
  "status": "ACTIVE"
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1ab12a05-519f-4ec2-9031-41be8af3a403",
      "creationDate": "2020-12-28T23:14:23Z",
      "lastUpdateDate": "2020-12-28T23:14:23Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "name": "Horario estándar",
      "weeklyHour": 45.0,
      "monday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "tuesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "wednesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "thursday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "friday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "saturday": null,
      "sunday": null,
      "status": "ACTIVE"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Borrar una plantilla de horario.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
scheduleId: required(string)
Identificador único del horario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/schedules/{scheduleId}/status patch

patch

Actualizar status de horario, posibles valores CREATED, ACTIVE, INACTIVE.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
scheduleId: required(string)
Identificador único del horario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "status": "ACTIVE"
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1ab12a05-519f-4ec2-9031-41be8af3a403",
      "creationDate": "2020-12-28T23:14:23Z",
      "lastUpdateDate": "2020-12-28T23:14:23Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "name": "Horario estándar",
      "weeklyHour": 45.0,
      "monday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "tuesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "wednesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "thursday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "friday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "saturday": null,
      "sunday": null,
      "status": "ACTIVE"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/users get

get

Listar los usuarios de una empresa.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "employeeId": "d8cffda6-2103-435b-b4cc-f12a17710154",
      "role": "ADMIN",
      "firstName": "Julio",
      "lastName": "Amaya",
      "email": "atpjulio@yahoo.es",
      "dni": "DH23238281",
      "birthdate": "1985-02-07T00:00:00Z",
      "gender": "MALE",
      "phone": null,
      "creationDate": "2020-10-17T13:38:22Z",
      "lastUpdateDate": "2020-10-17T13:38:22Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/users/invitations post

post

Crear una invitación para usuario.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "email": "atpjulio@yahoo.es"
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "7b8519d3-b6f0-4d46-ba23-4bfac52cce52",
      "creationDate": "2020-09-11T12:14:11Z",
      "lastUpdateDate": "2020-09-11T12:14:11Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "originUserId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "email": "atpjulio@yahoo.es",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "status": "CREATED",
      "role": "ADMIN"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/users/{userId} get patch delete

get

Obtener detalle del usuario.

patch

Actualizar usuario de empresa, por ahora solo se puede actualizar rol.

delete

Borrar un usuario de empresa.

Obtener detalle del usuario.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
userId: required(string)
Identificador único del usuario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "employeeId": "d8cffda6-2103-435b-b4cc-f12a17710154",
      "role": "ADMIN",
      "firstName": "Julio",
      "lastName": "Amaya",
      "email": "atpjulio@yahoo.es",
      "dni": "DH23238281",
      "birthdate": "1985-02-07T00:00:00Z",
      "gender": "MALE",
      "phone": null,
      "creationDate": "2020-10-17T13:38:22Z",
      "lastUpdateDate": "2020-10-17T13:38:22Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar usuario de empresa, por ahora solo se puede actualizar rol.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
userId: required(string)
Identificador único del usuario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "role": "ADMIN"
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "employeeId": "d8cffda6-2103-435b-b4cc-f12a17710154",
      "role": "ADMIN",
      "firstName": "Julio",
      "lastName": "Amaya",
      "email": "atpjulio@yahoo.es",
      "dni": "DH23238281",
      "birthdate": "1985-02-07T00:00:00Z",
      "gender": "MALE",
      "phone": null,
      "creationDate": "2020-10-17T13:38:22Z",
      "lastUpdateDate": "2020-10-17T13:38:22Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un usuario de empresa.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
userId: required(string)
Identificador único del usuario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/workplaces post get

post

Crear un centro de trabajo.

get

Listar los centros de trabajo.

Crear un centro de trabajo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "name": "Qaroni EMEA S.A.",
  "description": "Centro de trabajo principal",
  "email": "contact@qaroni.com",
  "phone": "632899315",
  "remoteAccess": false,
  "radius": 50.0,
  "address": {
    "alias": "Dirección principal",
    "line1": "Rúa Hábitat, 10 Bajo",
    "line2": null,
    "city": "Oleiros",
    "stateProvince": "A Coruña",
    "postalCode": "15172",
    "country": "ES",
    "location": {
      "longitude": -8.3791935,
      "latitude": 43.3340781,
      "altitude": null,
      "relevantText": null
    }
  }
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-12-15T12:40:09Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "name": "Ibiza C. A.",
      "description": "Sucursal Baleares",
      "email": "jdelgado@qaroni.com",
      "phone": "632899315",
      "address": {
        "alias": "Workplace",
        "line1": "Rua Habitat 10",
        "line2": null,
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "postalCode": "15172",
        "country": "ES",
        "location": {
          "longitude": -8.379286699439348,
          "latitude": 43.33389284265928,
          "altitude": null,
          "relevantText": null
        }
      },
      "remoteAccess": true,
      "radius": 99.0,
      "status": "ENABLED",
      "timezone": "Europe/Madrid",
      "holidays": [
        {
          "id": "b3d69423-a88c-4bb2-bd26-6ea9844b550b",
          "creationDate": "2020-12-15T12:40:09Z",
          "lastUpdateDate": "2020-12-15T12:40:09Z",
          "type": "PRIVATE",
          "name": "Descanso por contrato colectivo",
          "stateProvince": "A Coruña",
          "country": "ES",
          "beginDate": "2020-12-28",
          "endDate": "2020-12-28"
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Listar los centros de trabajo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-12-15T12:40:09Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "name": "Ibiza C. A.",
      "description": "Sucursal Baleares",
      "email": "jdelgado@qaroni.com",
      "phone": "632899315",
      "address": {
        "alias": "Workplace",
        "line1": "Rua Habitat 10",
        "line2": null,
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "postalCode": "15172",
        "country": "ES",
        "location": {
          "longitude": -8.379286699439348,
          "latitude": 43.33389284265928,
          "altitude": null,
          "relevantText": null
        }
      },
      "remoteAccess": true,
      "radius": 99.0,
      "status": "ENABLED",
      "timezone": "Europe/Madrid",
      "holidays": [
        {
          "id": "b3d69423-a88c-4bb2-bd26-6ea9844b550b",
          "creationDate": "2020-12-15T12:40:09Z",
          "lastUpdateDate": "2020-12-15T12:40:09Z",
          "type": "PRIVATE",
          "name": "Descanso por contrato colectivo",
          "stateProvince": "A Coruña",
          "country": "ES",
          "beginDate": "2020-12-28",
          "endDate": "2020-12-28"
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/workplaces/{workplaceId} get patch delete

get

Obtener detalle del centro de trabajo.

patch

Actualizar centro de trabajo.

delete

Borrar un centro de trabajo.

Obtener detalle del centro de trabajo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
workplaceId: required(string)
Identificador único del centro de trabajo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-12-15T12:40:09Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "name": "Ibiza C. A.",
      "description": "Sucursal Baleares",
      "email": "jdelgado@qaroni.com",
      "phone": "632899315",
      "address": {
        "alias": "Workplace",
        "line1": "Rua Habitat 10",
        "line2": null,
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "postalCode": "15172",
        "country": "ES",
        "location": {
          "longitude": -8.379286699439348,
          "latitude": 43.33389284265928,
          "altitude": null,
          "relevantText": null
        }
      },
      "remoteAccess": true,
      "radius": 99.0,
      "status": "ENABLED",
      "timezone": "Europe/Madrid",
      "holidays": [
        {
          "id": "b3d69423-a88c-4bb2-bd26-6ea9844b550b",
          "creationDate": "2020-12-15T12:40:09Z",
          "lastUpdateDate": "2020-12-15T12:40:09Z",
          "type": "PRIVATE",
          "name": "Descanso por contrato colectivo",
          "stateProvince": "A Coruña",
          "country": "ES",
          "beginDate": "2020-12-28",
          "endDate": "2020-12-28"
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar centro de trabajo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
workplaceId: required(string)
Identificador único del centro de trabajo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "name": "Qaroni EMEA S.A.",
  "description": "Centro de trabajo principal",
  "email": "contact@qaroni.com",
  "phone": "632899315",
  "remoteAccess": false,
  "radius": 50.0,
  "address": {
    "alias": "Dirección principal",
    "line1": "Rúa Hábitat, 10 Bajo",
    "line2": null,
    "city": "Oleiros",
    "stateProvince": "A Coruña",
    "postalCode": "15172",
    "country": "ES",
    "location": {
      "longitude": -8.3791935,
      "latitude": 43.3340781,
      "altitude": null,
      "relevantText": null
    }
  }
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-12-15T12:40:09Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "name": "Ibiza C. A.",
      "description": "Sucursal Baleares",
      "email": "jdelgado@qaroni.com",
      "phone": "632899315",
      "address": {
        "alias": "Workplace",
        "line1": "Rua Habitat 10",
        "line2": null,
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "postalCode": "15172",
        "country": "ES",
        "location": {
          "longitude": -8.379286699439348,
          "latitude": 43.33389284265928,
          "altitude": null,
          "relevantText": null
        }
      },
      "remoteAccess": true,
      "radius": 99.0,
      "status": "ENABLED",
      "timezone": "Europe/Madrid",
      "holidays": [
        {
          "id": "b3d69423-a88c-4bb2-bd26-6ea9844b550b",
          "creationDate": "2020-12-15T12:40:09Z",
          "lastUpdateDate": "2020-12-15T12:40:09Z",
          "type": "PRIVATE",
          "name": "Descanso por contrato colectivo",
          "stateProvince": "A Coruña",
          "country": "ES",
          "beginDate": "2020-12-28",
          "endDate": "2020-12-28"
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un centro de trabajo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
workplaceId: required(string)
Identificador único del centro de trabajo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/workplaces/{workplaceId}/checks get

get

Listar los checks que pertenecen al centro de trabajo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
workplaceId: required(string)
Identificador único del centro de trabajo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

pagination: (integer)
Cantidad de registros que se desea recibir. Por defecto trae hasta 100 resultados.
Example:
```
2
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1600970047118",
      "creationDate": "2020-09-24T16:54:07Z",
      "lastUpdateDate": "2020-10-09T20:11:47Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "type": "REMOTE",
      "reason": "JOURNEY",
      "action": "EXIT",
      "temperature": null,
      "location": {
        "longitude": -74.8012283,
        "latitude": 10.9918783,
        "altitude": null,
        "relevantText": null
      },
      "photoURL": null,
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/workplaces/{workplaceId}/dashboards get

get

Obtener dashboard para el centro de trabajo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
workplaceId: required(string)
Identificador único del centro de trabajo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "offline": 2,
      "onBreak": 2,
      "online": 12,
      "total": 16
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/workplaces/{workplaceId}/employees get

get

Listar los empleados de un centro de trabajo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
workplaceId: required(string)
Identificador único del centro de trabajo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-10-16T15:36:44Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": null,
      "bossId": null,
      "walletId": "e26e41e1-5ef8-402f-a600-7516b17b9ac6",
      "firstName": "Julio",
      "lastName": "Amaya",
      "email": "atpjulio@yahoo.es",
      "phone": "693828282",
      "dni": "DH23238281",
      "birthdate": "1985-02-07T05:00:00Z",
      "position": "Software Developer",
      "access": "6abf5892-cea4-40f9-a94d-853dfde3af74",
      "pin": "5415",
      "gender": "MALE",
      "status": "ENABLED",
      "state": "OFFLINE",
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8",
      "employeeCard": "https://s3.eu-central-1.amazonaws.com/qaroni.walletitems.d/e26e41e1-5ef8-402f-a600-7516b17b9ac6.pkpass",
      "timezone": "Europe/Madrid",
      "linkedUser": {
        "email": "atpjulio@yahoo.es",
        "role": "ADMIN",
        "creationDate": "2020-10-17T13:38:22Z"
      },
      "remoteAccess": true
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/workplaces/{workplaceId}/employees/{employeeId}/schedules get

get

Obtener los horarios del empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
workplaceId: required(string)
Identificador único del centro de trabajo.
employeeId: required(string)
Identificador único del empleado.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

sortDirection: (string)
Dirección de orden de listado ASC, DESC.
Example:
```
ASC
```
status: (string)
Filtrar por si el horario está vigente o vencido (expirado) CURRENT, EXPIRED.
Example:
```
CURRENT
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1ab12a05-519f-4ec2-9031-41be8af3a403",
      "name": "Horario estándar",
      "weeklyHour": 45.0,
      "dateFrom": "2021-01-01T00:00:00Z",
      "dateTo": "2021-02-28T23:59:59Z",
      "monday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "tuesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "wednesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "thursday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "friday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "saturday": null,
      "sunday": null
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/workplaces/{workplaceId}/employees/{employeeId}/schedules/{scheduleId} post delete

post

Asociar un horario custom al empleado.

delete

Desasociar un horario custom del empleado.

Asociar un horario custom al empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
workplaceId: required(string)
Identificador único del centro de trabajo.
employeeId: required(string)
Identificador único del empleado.
scheduleId: required(string)
Identificador único del horario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{	
  "dateFrom": "2021-01-01T00:00:00Z",
  "dateTo": "2021-02-28T23:59:59Z",
  "sendEmail": true
}

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1ab12a05-519f-4ec2-9031-41be8af3a403",
      "creationDate": "2020-12-28T23:14:23Z",
      "lastUpdateDate": "2020-12-28T23:14:23Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "name": "Horario estándar",
      "weeklyHour": 45.0,
      "monday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "tuesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "wednesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "thursday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "friday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "saturday": null,
      "sunday": null,
      "status": "ACTIVE"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Desasociar un horario custom del empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
workplaceId: required(string)
Identificador único del centro de trabajo.
employeeId: required(string)
Identificador único del empleado.
scheduleId: required(string)
Identificador único del horario.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/workplaces/{workplaceId}/holidays post

post

Agregar un festivo para centro de trabajo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
workplaceId: required(string)
Identificador único del centro de trabajo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "type": "NATIONAL",
  "name": "Día de navidad",
  "date": "2020-12-25"
}

HTTP status code 201

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8b835507-d46c-47f6-baab-636c2b4cdb1b",
      "type": "NATIONAL",
      "name": "Día de navidad",
      "date": "2020-12-25"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/workplaces/{workplaceId}/holidays/associates post patch

post

Agregar varios festivos al workplace por su identificador. Se descartan los no existentes o duplicados.

patch

Desvincular varios festivos al workplace por su identificador. Se descartan los no existentes.

Agregar varios festivos al workplace por su identificador. Se descartan los no existentes o duplicados.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
workplaceId: required(string)
Identificador único del centro de trabajo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "holidayIds": ["0d4f2b73-8457-44d0-8fc7-7e0491bfd87a"]
}

HTTP status code 201

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8b835507-d46c-47f6-baab-636c2b4cdb1b",
      "type": "NATIONAL",
      "name": "Día de navidad",
      "date": "2020-12-25"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Desvincular varios festivos al workplace por su identificador. Se descartan los no existentes.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
workplaceId: required(string)
Identificador único del centro de trabajo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "holidayIds": ["0d4f2b73-8457-44d0-8fc7-7e0491bfd87a"]
}

HTTP status code 201

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8b835507-d46c-47f6-baab-636c2b4cdb1b",
      "type": "NATIONAL",
      "name": "Día de navidad",
      "date": "2020-12-25"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/workplaces/{workplaceId}/holidays/{holidayId} patch delete

patch

Actualizar un festivo para centro de trabajo.

delete

Borrar un festivo del workplace.

Actualizar un festivo para centro de trabajo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
workplaceId: required(string)
Identificador único del centro de trabajo.
holidayId: required(string)
Identificador único del festivo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "type": "NATIONAL",
  "name": "Día de navidad",
  "date": "2020-12-25"
}

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8b835507-d46c-47f6-baab-636c2b4cdb1b",
      "type": "NATIONAL",
      "name": "Día de navidad",
      "date": "2020-12-25"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un festivo del workplace.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.
workplaceId: required(string)
Identificador único del centro de trabajo.
holidayId: required(string)
Identificador único del festivo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8b835507-d46c-47f6-baab-636c2b4cdb1b",
      "type": "NATIONAL",
      "name": "Día de navidad",
      "date": "2020-12-25"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/companies/{companyId}/workplaces/{workplaceId}/pdfs get

get

Obtener PDF tamaño carta con el QR del centro de trabajo.

Request
Response

URI Parameters

companyId: required(string)
Identificador único de la compañía.
workplaceId: required(string)
Identificador único del centro de trabajo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Headers

Content-type: required(string)
Fichero en PDF.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/countries

/countries post get

post

Crear un con el id con el código ISO. Ejemplo para España sería ES y para Venezuela sería VE.

get

Listar los países.

Crear un con el id con el código ISO. Ejemplo para España sería ES y para Venezuela sería VE.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "id": "VE",
  "name": "Venezuela"
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "VE",
      "creationDate": "2020-12-28T20:59:55Z",
      "lastUpdateDate": "2020-12-28T20:59:55Z",
      "name": "Venezuela"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Listar los países.

Request
Response

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "VE",
      "creationDate": "2020-12-28T20:59:55Z",
      "lastUpdateDate": "2020-12-28T20:59:55Z",
      "name": "Venezuela"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/countries/{countryId} get patch delete

get

Obtener detalle del país.

patch

Actualizar país.

delete

Borrar un país.

Obtener detalle del país.

Request
Response

URI Parameters

countryId: required(string)
Identificador único del país.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "VE",
      "creationDate": "2020-12-28T20:59:55Z",
      "lastUpdateDate": "2020-12-28T20:59:55Z",
      "name": "Venezuela"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar país.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

countryId: required(string)
Identificador único del país.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "id": "VE",
  "name": "Venezuela"
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "VE",
      "creationDate": "2020-12-28T20:59:55Z",
      "lastUpdateDate": "2020-12-28T20:59:55Z",
      "name": "Venezuela"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un país.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

countryId: required(string)
Identificador único del país.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/countries/{countryId}/states post get

post

Crear un estado, con su código ISO 3166-2, el cual por cierto es opcional.

get

Listar los estados del país.

Crear un estado, con su código ISO 3166-2, el cual por cierto es opcional.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

countryId: required(string)
Identificador único del país.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "code": "S",
  "name": "Táchira"
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "ee54cdb7-d25d-47d3-9cd7-94632792d986",
      "creationDate": "2020-12-28T21:08:50Z",
      "lastUpdateDate": "2020-12-28T21:08:50Z",
      "countryId": "VE",
      "code": "S",
      "name": "Táchira"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Listar los estados del país.

Request
Response

URI Parameters

countryId: required(string)
Identificador único del país.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "ee54cdb7-d25d-47d3-9cd7-94632792d986",
      "creationDate": "2020-12-28T21:08:50Z",
      "lastUpdateDate": "2020-12-28T21:08:50Z",
      "countryId": "VE",
      "code": "S",
      "name": "Táchira"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/countries/{countryId}/states/{stateId} get patch delete

get

Obtener detalle del estado.

patch

Actualizar estado.

delete

Borrar un estado.

Obtener detalle del estado.

Request
Response

URI Parameters

countryId: required(string)
Identificador único del país.
stateId: required(string)
Identificador único del estado.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "ee54cdb7-d25d-47d3-9cd7-94632792d986",
      "creationDate": "2020-12-28T21:08:50Z",
      "lastUpdateDate": "2020-12-28T21:08:50Z",
      "countryId": "VE",
      "code": "S",
      "name": "Táchira"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar estado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

countryId: required(string)
Identificador único del país.
stateId: required(string)
Identificador único del estado.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "code": "S",
  "name": "Táchira"
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "ee54cdb7-d25d-47d3-9cd7-94632792d986",
      "creationDate": "2020-12-28T21:08:50Z",
      "lastUpdateDate": "2020-12-28T21:08:50Z",
      "countryId": "VE",
      "code": "S",
      "name": "Táchira"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un estado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

countryId: required(string)
Identificador único del país.
stateId: required(string)
Identificador único del estado.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/countries/{countryId}/states/excel/imports post

post

Importa los estados para el país dado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

countryId: required(string)
Identificador único del país.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: multipart/form-data

Type: object

Properties

file: required(file)
Fichero a subir.

HTTP status code 204

Se importa el fichero de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/employees

/employees/{employeeId} get

get

Detalle de una ficha de empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-10-16T15:36:44Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": null,
      "bossId": null,
      "walletId": "e26e41e1-5ef8-402f-a600-7516b17b9ac6",
      "firstName": "Julio",
      "lastName": "Amaya",
      "email": "atpjulio@yahoo.es",
      "phone": "693828282",
      "dni": "DH23238281",
      "birthdate": "1985-02-07T05:00:00Z",
      "position": "Software Developer",
      "access": "6abf5892-cea4-40f9-a94d-853dfde3af74",
      "pin": "5415",
      "gender": "MALE",
      "status": "ENABLED",
      "state": "OFFLINE",
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8",
      "employeeCard": "https://s3.eu-central-1.amazonaws.com/qaroni.walletitems.d/e26e41e1-5ef8-402f-a600-7516b17b9ac6.pkpass",
      "timezone": "Europe/Madrid",
      "linkedUser": {
        "email": "atpjulio@yahoo.es",
        "role": "ADMIN",
        "creationDate": "2020-10-17T13:38:22Z"
      },
      "remoteAccess": true
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/employees/{employeeId}/checks post get

post

Hacer un check.

get

Listar los checks que pertenecen al usuario.

Hacer un check.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: multipart/form-data

Type: object

Properties

check: required(file)

Example:

{
  "workplaceId": "b7b8653c-d7df-4941-91e6-33c203164939",
  "type": "REMOTE",
  "reason": "Journey",
  "action": "ENTRANCE",
  "location": {
    "latitude": 43.3619312,
    "longitude": -8.4477891
  }
}

photo: (file)
Foto a subir.

HTTP status code 201

Se crea el recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1600970047118",
      "creationDate": "2020-09-24T16:54:07Z",
      "lastUpdateDate": "2020-10-09T20:11:47Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "type": "REMOTE",
      "reason": "JOURNEY",
      "action": "EXIT",
      "temperature": null,
      "location": {
        "longitude": -74.8012283,
        "latitude": 10.9918783,
        "altitude": null,
        "relevantText": null
      },
      "photoURL": null,
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Listar los checks que pertenecen al usuario.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

sortDirection: (string)
Dirección de orden de listado ASC, DESC. Por defecto vendrá DESC.
Example:
```
ASC
```
dateFrom: (string)
Filtrar por fecha inicial (Formato YYYY-MM-ddThh:mm:ssZ) comparando con creationDate.
Example:
```
2020-05-02T02:00:00Z
```
dateTo: (string)
Filtrar por fecha final (Formato YYYY-MM-ddThh:mm:ssZ) comparando con creationDate.
Example:
```
2020-05-09T01:59:59Z
```
last: (integer)
Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.
Example:
```
2
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1600970047118",
      "creationDate": "2020-09-24T16:54:07Z",
      "lastUpdateDate": "2020-10-09T20:11:47Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "type": "REMOTE",
      "reason": "JOURNEY",
      "action": "EXIT",
      "temperature": null,
      "location": {
        "longitude": -74.8012283,
        "latitude": 10.9918783,
        "altitude": null,
        "relevantText": null
      },
      "photoURL": null,
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/employees/{employeeId}/checks/{checkId} get patch

get

Detalle de check con su array history.

patch

Actualizar check y guardar historia de ello.

Detalle de check con su array history.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.
checkId: required(string)
Identificador único del Check.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1600970047118",
      "creationDate": "2020-09-24T16:54:07Z",
      "lastUpdateDate": "2020-10-09T20:11:47Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "type": "REMOTE",
      "reason": "JOURNEY",
      "action": "EXIT",
      "temperature": null,
      "location": {
        "longitude": -74.8012283,
        "latitude": 10.9918783,
        "altitude": null,
        "relevantText": null
      },
      "photoURL": null,
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8",
      "history": [
        {
          "id": "1602274307191",
          "creationDate": "2020-10-09T20:11:47Z",
          "lastUpdateDate": "2020-10-09T20:11:47Z",
          "checkId": "1600970047118",
          "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
          "oldCreationDate": "2020-09-24T17:54:07Z",
          "newCreationDate": "2020-09-24T16:54:07Z",
          "comment": "Se ajusta fecha de salida ya que el empleado olvidó hacer fichaje"
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar check y guardar historia de ello.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.
checkId: required(string)
Identificador único del Check.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "newCreationDate": "2020-09-24T16:54:07Z",
  "comment": "Se ajusta fecha de inicio ya que el empleado olvidó hacer fichaje"
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1600970047118",
      "creationDate": "2020-09-24T16:54:07Z",
      "lastUpdateDate": "2020-10-09T20:11:47Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "type": "REMOTE",
      "reason": "JOURNEY",
      "action": "EXIT",
      "temperature": null,
      "location": {
        "longitude": -74.8012283,
        "latitude": 10.9918783,
        "altitude": null,
        "relevantText": null
      },
      "photoURL": null,
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/employees/{employeeId}/checks/reports get

get

Reporte de checks que pertenecen al empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

last: (integer)
Últimos meses desde el actual.
Example:
```
6
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "regular": 63.11,
      "extra": 0.0,
      "total": 63.11,
      "rest": 16.89,
      "dateFrom": "2019-09-21T00:00:00Z",
      "dateTo": "2020-09-21T23:59:59Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/employees/{employeeId}/checks/reports/{reportId}/months post get

post

Generar reporte de checks que pertenecen al empleado.

get

Reporte de checks que pertenecen al empleado.

Generar reporte de checks que pertenecen al empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.
reportId: required(string)
Formato YYYYMM.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 201

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "202006",
      "creationDate": "2020-09-21T14:11:29Z",
      "lastUpdateDate": "2020-09-21T14:11:29Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "reportHourcheck": {
        "regular": 15.78,
        "extra": 0.0,
        "total": 15.78,
        "rest": 4.22,
        "dateFrom": "2020-06-01T00:00:00Z",
        "dateTo": "2020-06-30T23:59:59Z"
      },
      "reportURL": "https://s3.eu-central-1.amazonaws.com/workards.dev/companies/f563978c-ccb6-4e28-a953-b9407914b34c/employees/8899ce7c-8792-4a69-9607-95f6a8c19c70/reports/202009.pdf"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Reporte de checks que pertenecen al empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.
reportId: required(string)
Formato YYYYMM.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "202006",
      "creationDate": "2020-09-21T14:11:29Z",
      "lastUpdateDate": "2020-09-21T14:11:29Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "reportHourcheck": {
        "regular": 15.78,
        "extra": 0.0,
        "total": 15.78,
        "rest": 4.22,
        "dateFrom": "2020-06-01T00:00:00Z",
        "dateTo": "2020-06-30T23:59:59Z"
      },
      "reportURL": "https://s3.eu-central-1.amazonaws.com/workards.dev/companies/f563978c-ccb6-4e28-a953-b9407914b34c/employees/8899ce7c-8792-4a69-9607-95f6a8c19c70/reports/202009.pdf"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/employees/{employeeId}/checks/reports/months get

get

Reporte de checks que pertenecen al empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

last: (integer)
Últimos meses desde el actual.
Example:
```
6
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "202006",
      "creationDate": "2020-09-21T14:11:29Z",
      "lastUpdateDate": "2020-09-21T14:11:29Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "reportHourcheck": {
        "regular": 15.78,
        "extra": 0.0,
        "total": 15.78,
        "rest": 4.22,
        "dateFrom": "2020-06-01T00:00:00Z",
        "dateTo": "2020-06-30T23:59:59Z"
      },
      "reportURL": "https://s3.eu-central-1.amazonaws.com/workards.dev/companies/f563978c-ccb6-4e28-a953-b9407914b34c/employees/8899ce7c-8792-4a69-9607-95f6a8c19c70/reports/202009.pdf"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/employees/{employeeId}/checks/shifts get

get

Listar los checks que pertenecen a la última jornada del empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

last: (integer)
Últimos checks.
Example:
```
6
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1600970047118",
      "creationDate": "2020-09-24T16:54:07Z",
      "lastUpdateDate": "2020-10-09T20:11:47Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "type": "REMOTE",
      "reason": "JOURNEY",
      "action": "EXIT",
      "temperature": null,
      "location": {
        "longitude": -74.8012283,
        "latitude": 10.9918783,
        "altitude": null,
        "relevantText": null
      },
      "photoURL": null,
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/employees/{employeeId}/checks/shifts/{workday} get

get

Listar los checks a la jornada.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.
workday: required(string)
Identificador único de la jornada laboral.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1600970047118",
      "creationDate": "2020-09-24T16:54:07Z",
      "lastUpdateDate": "2020-10-09T20:11:47Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "type": "REMOTE",
      "reason": "JOURNEY",
      "action": "EXIT",
      "temperature": null,
      "location": {
        "longitude": -74.8012283,
        "latitude": 10.9918783,
        "altitude": null,
        "relevantText": null
      },
      "photoURL": null,
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/employees/{employeeId}/notifications get

get

Listar las notificaciones del empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

status: (string)
Filtrar por status UNREAD, READ.
Example:
```
UNREAD
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "48a84c02-6c0e-489d-9d84-631ffc22e011",
      "creationDate": "2021-02-10T13:04:40Z",
      "lastUpdateDate": "2021-02-10T13:04:40Z",
      "employeeId": "20750516-04eb-4a6f-9009-6628e0937d19",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "userId": "8ca2b441056af15c3131bf1718266e46b30e4a2c",
      "status": "READ",
      "notification": {
        "title": "Titulo de notificación editado",
        "message": "El mensaje de la notificación editado",
        "iconUrl": "editado",
        "actionUrl": "editado"
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/employees/{employeeId}/notifications/{notificationId} get patch delete

get

Obtener detalle de la notificación.

patch

Cambiar status de notificación al enviado, se genera una notificación PUSH de tipo BADGE.

delete

Borrar notificación, se genera una notificación PUSH de tipo BADGE.

Obtener detalle de la notificación.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.
notificationId: required(string)
Identificador único de la notificación.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "48a84c02-6c0e-489d-9d84-631ffc22e011",
      "creationDate": "2021-02-10T13:04:40Z",
      "lastUpdateDate": "2021-02-10T13:04:40Z",
      "employeeId": "20750516-04eb-4a6f-9009-6628e0937d19",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "userId": "8ca2b441056af15c3131bf1718266e46b30e4a2c",
      "status": "READ",
      "notification": {
        "title": "Titulo de notificación editado",
        "message": "El mensaje de la notificación editado",
        "iconUrl": "editado",
        "actionUrl": "editado"
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Cambiar status de notificación al enviado, se genera una notificación PUSH de tipo BADGE.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.
notificationId: required(string)
Identificador único de la notificación.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "status": "READ"
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "48a84c02-6c0e-489d-9d84-631ffc22e011",
      "creationDate": "2021-02-10T13:04:40Z",
      "lastUpdateDate": "2021-02-10T13:04:40Z",
      "employeeId": "20750516-04eb-4a6f-9009-6628e0937d19",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "userId": "8ca2b441056af15c3131bf1718266e46b30e4a2c",
      "status": "READ",
      "notification": {
        "title": "Titulo de notificación editado",
        "message": "El mensaje de la notificación editado",
        "iconUrl": "editado",
        "actionUrl": "editado"
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Borrar notificación, se genera una notificación PUSH de tipo BADGE.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.
notificationId: required(string)
Identificador único de la notificación.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/employees/{employeeId}/notifications/unreads/counts get

get

Obtener contador actualizado de notificaciones UNREAD.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "counter": 12
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/employees/{employeeId}/schedules get

get

Obtener los horarios del empleado.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

sortDirection: (string)
Dirección de orden de listado ASC, DESC.
Example:
```
ASC
```
status: (string)
Filtrar por si el horario está vigente o vencido (expirado) CURRENT, EXPIRED.
Example:
```
CURRENT
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "1ab12a05-519f-4ec2-9031-41be8af3a403",
      "name": "Horario estándar",
      "weeklyHour": 45.0,
      "dateFrom": "2021-01-01T00:00:00Z",
      "dateTo": "2021-02-28T23:59:59Z",
      "monday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "tuesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "wednesday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "thursday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "friday": [
        {
          "hourFrom": "08:00",
          "hourTo": "17:00"
        }
      ],
      "saturday": null,
      "sunday": null
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/employees/{employeeId}/workplaces get

get

Listar los centros de trabajo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

employeeId: required(string)
Identificador único del empleado.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

status: (one of ENABLED, DISABLED)
Status del centro de trabajo.
Example:
```
ENABLED
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-12-15T12:40:09Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "name": "Ibiza C. A.",
      "description": "Sucursal Baleares",
      "email": "jdelgado@qaroni.com",
      "phone": "632899315",
      "address": {
        "alias": "Workplace",
        "line1": "Rua Habitat 10",
        "line2": null,
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "postalCode": "15172",
        "country": "ES",
        "location": {
          "longitude": -8.379286699439348,
          "latitude": 43.33389284265928,
          "altitude": null,
          "relevantText": null
        }
      },
      "remoteAccess": true,
      "radius": 99.0,
      "status": "ENABLED",
      "timezone": "Europe/Madrid",
      "holidays": [
        {
          "id": "b3d69423-a88c-4bb2-bd26-6ea9844b550b",
          "creationDate": "2020-12-15T12:40:09Z",
          "lastUpdateDate": "2020-12-15T12:40:09Z",
          "type": "PRIVATE",
          "name": "Descanso por contrato colectivo",
          "stateProvince": "A Coruña",
          "country": "ES",
          "beginDate": "2020-12-28",
          "endDate": "2020-12-28"
        }
      ]
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/files/temps/storages

/files/temps/storages post

post

Subir fichero de manera genérica.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: multipart/form-data

Type: object

Properties

file: required(file)
Fichero a subir.

HTTP status code 200

Se sube el fichero de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "originalName": "20.png",
      "storageId": "36205a88-d218-4251-af41-49b57f605214",
      "fileUrl": "https://s3.eu-central-1.amazonaws.com/workards.dev/uploads/55953a2d-bc6b-4d34-836d-b3bc774aac92.png"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/holidays

/holidays post get

post

Crear un festivo, los posibles valores para type son NATIONAL, REGIONAL, LOCAL, PRIVATE. Si es de tipo NATIONAL, enviar * en stateProvince.

get

Listar los festivos.

Crear un festivo, los posibles valores para type son NATIONAL, REGIONAL, LOCAL, PRIVATE. Si es de tipo NATIONAL, enviar * en stateProvince.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "type": "NATIONAL",
  "name": "Día de navidad",
  "stateProvince": "*",
  "country": "ES",
  "beginDate": "2020-12-25",
  "endDate": "2020-12-25"
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8b835507-d46c-47f6-baab-636c2b4cdb1b",
      "creationDate": "2020-12-09T15:22:12Z",
      "lastUpdateDate": "2020-12-09T15:22:12Z",
      "type": "NATIONAL",
      "name": "Día de navidad",
      "stateProvince": "*",
      "country": "ES",
      "beginDate": "2020-12-25",
      "endDate": "2020-12-25"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Listar los festivos.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

stateProvince: (string)
Filtrar por el stateProvince, recordar que un * envía todos.
Example:
```
A Coruña
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8b835507-d46c-47f6-baab-636c2b4cdb1b",
      "creationDate": "2020-12-09T15:22:12Z",
      "lastUpdateDate": "2020-12-09T15:22:12Z",
      "type": "NATIONAL",
      "name": "Día de navidad",
      "stateProvince": "*",
      "country": "ES",
      "beginDate": "2020-12-25",
      "endDate": "2020-12-25"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/holidays/{holidayId} get patch delete

get

Obtener detalle del festivo.

patch

Actualizar festivo.

delete

Borrar un festivo.

Obtener detalle del festivo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

holidayId: required(string)
Identificador único del festivo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8b835507-d46c-47f6-baab-636c2b4cdb1b",
      "creationDate": "2020-12-09T15:22:12Z",
      "lastUpdateDate": "2020-12-09T15:22:12Z",
      "type": "NATIONAL",
      "name": "Día de navidad",
      "stateProvince": "*",
      "country": "ES",
      "beginDate": "2020-12-25",
      "endDate": "2020-12-25"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar festivo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

holidayId: required(string)
Identificador único del festivo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "type": "NATIONAL",
  "name": "Día de navidad",
  "stateProvince": "*",
  "country": "ES",
  "beginDate": "2020-12-25",
  "endDate": "2020-12-25"
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8b835507-d46c-47f6-baab-636c2b4cdb1b",
      "creationDate": "2020-12-09T15:22:12Z",
      "lastUpdateDate": "2020-12-09T15:22:12Z",
      "type": "NATIONAL",
      "name": "Día de navidad",
      "stateProvince": "*",
      "country": "ES",
      "beginDate": "2020-12-25",
      "endDate": "2020-12-25"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un festivo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

holidayId: required(string)
Identificador único del festivo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/holidays/excel/imports post

post

Importa los festivos.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: multipart/form-data

Type: object

Properties

file: required(file)
Fichero a subir.

HTTP status code 204

Se importa el fichero de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/plans

/plans post get

post

Crear un plan.

get

Listar los planes.

Crear un plan.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "name": "Plan básico",
  "trialDays": 30,
  "seats": 5,
  "locale": {
    "ES": {
      "title": "Plan básico",
      "description": "Lo minimo para comenzar",
      "price": 500,
      "discountPerYear": 12.5,
      "seatAdditionalPrice": 250,
      "currency": "EUR"
    },
    "CO": {
      "title": "Plan primeros pasos",
      "description": "Lo minimo para comenzar en Colombia",
      "price": 2000000,
      "discountPerYear": 12.5,
      "seatAdditionalPrice": 1000000,
      "currency": "EUR"
    }
  },
  "status": "ENABLED"
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "0f2d7736-9653-4aa5-a264-63a0bf093a93",
      "creationDate": "2021-01-08T11:53:37Z",
      "lastUpdateDate": "2021-01-08T11:53:37Z",
      "name": "Plan básico",
      "trialDays": 30,
      "seats": 5,
      "locale": {
        "ES": {
          "title": "Plan básico",
          "description": "Lo minimo para comenzar",
          "price": 500,
          "discountPerYear": 12.5,
          "seatAdditionalPrice": 250,
          "currency": "EUR"
        },
        "CO": {
          "title": "Plan primeros pasos",
          "description": "Lo minimo para comenzar en Colombia",
          "price": 2000000,
          "discountPerYear": 12.5,
          "seatAdditionalPrice": 1000000,
          "currency": "EUR"
        }
      },
      "status": "ENABLED"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Listar los planes.

Request
Response

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

country: (string)
Filtrar por el country en formato ISO alpha 2, por defecto trae todos.
Example:
```
ES
```
status: (one of ENABLED, DISABLED)
Status del plan.
Example:
```
ENABLED
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "0f2d7736-9653-4aa5-a264-63a0bf093a93",
      "creationDate": "2021-01-08T11:53:37Z",
      "lastUpdateDate": "2021-01-08T11:53:37Z",
      "name": "Plan básico",
      "trialDays": 30,
      "seats": 5,
      "locale": {
        "ES": {
          "title": "Plan básico",
          "description": "Lo minimo para comenzar",
          "price": 500,
          "discountPerYear": 12.5,
          "seatAdditionalPrice": 250,
          "currency": "EUR"
        },
        "CO": {
          "title": "Plan primeros pasos",
          "description": "Lo minimo para comenzar en Colombia",
          "price": 2000000,
          "discountPerYear": 12.5,
          "seatAdditionalPrice": 1000000,
          "currency": "EUR"
        }
      },
      "status": "ENABLED"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/plans/{planId} get patch delete

get

Obtener detalle del plan.

patch

Actualizar plan.

delete

Borrar un plan.

Obtener detalle del plan.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

planId: required(string)
Identificador único del plan.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "0f2d7736-9653-4aa5-a264-63a0bf093a93",
      "creationDate": "2021-01-08T11:53:37Z",
      "lastUpdateDate": "2021-01-08T11:53:37Z",
      "name": "Plan básico",
      "trialDays": 30,
      "seats": 5,
      "locale": {
        "ES": {
          "title": "Plan básico",
          "description": "Lo minimo para comenzar",
          "price": 500,
          "discountPerYear": 12.5,
          "seatAdditionalPrice": 250,
          "currency": "EUR"
        },
        "CO": {
          "title": "Plan primeros pasos",
          "description": "Lo minimo para comenzar en Colombia",
          "price": 2000000,
          "discountPerYear": 12.5,
          "seatAdditionalPrice": 1000000,
          "currency": "EUR"
        }
      },
      "status": "ENABLED"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar plan.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

planId: required(string)
Identificador único del plan.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "name": "Plan básico",
  "trialDays": 30,
  "seats": 5,
  "locale": {
    "ES": {
      "title": "Plan básico",
      "description": "Lo minimo para comenzar",
      "price": 500,
      "discountPerYear": 12.5,
      "seatAdditionalPrice": 250,
      "currency": "EUR"
    },
    "CO": {
      "title": "Plan primeros pasos",
      "description": "Lo minimo para comenzar en Colombia",
      "price": 2000000,
      "discountPerYear": 12.5,
      "seatAdditionalPrice": 1000000,
      "currency": "EUR"
    }
  },
  "status": "ENABLED"
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "0f2d7736-9653-4aa5-a264-63a0bf093a93",
      "creationDate": "2021-01-08T11:53:37Z",
      "lastUpdateDate": "2021-01-08T11:53:37Z",
      "name": "Plan básico",
      "trialDays": 30,
      "seats": 5,
      "locale": {
        "ES": {
          "title": "Plan básico",
          "description": "Lo minimo para comenzar",
          "price": 500,
          "discountPerYear": 12.5,
          "seatAdditionalPrice": 250,
          "currency": "EUR"
        },
        "CO": {
          "title": "Plan primeros pasos",
          "description": "Lo minimo para comenzar en Colombia",
          "price": 2000000,
          "discountPerYear": 12.5,
          "seatAdditionalPrice": 1000000,
          "currency": "EUR"
        }
      },
      "status": "ENABLED"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un plan.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

planId: required(string)
Identificador único del plan.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/users

/users/companies post get

post

Crear una compañía (Se crea el workplace y ficha del empleado usuario).

get

Listar las compañías del usuario.

Crear una compañía (Se crea el workplace y ficha del empleado usuario).

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "name": "Qaroni EMEA S.L.",
  "tradeName": "Qaroni",
  "email": "contact@qaroni.com",
  "phone": "632899315",
  "document": {
    "documentType": "CIF",
    "documentNumber": "B7019392321Y"
  },
  "address": {
    "alias": "Company",
    "line1": "Rúa Hábitat, 10 Bajo",
    "line2": null,
    "city": "Oleiros",
    "stateProvince": "A Coruña",
    "postalCode": "15172",
    "country": "ES",
    "location": {
      "longitude": -8.379264119488226,
      "latitude": 43.333946904210705,
      "altitude": null,
      "relevantText": null
    }
  },
  "status": "ENABLED",
  "timezone": "Europe/Madrid",
  "billingInformation": {
    "planId": "ba0c158d-4568-4f25-a93d-409cf2758ca9",
    "totalSeats": 5,
    "paymentMethodDescription": "Pago Stripe",
    "paymentMethod": "CREDIT_CARD",
    "taxName": "CIF",
    "taxId": "B7019392321Y",
    "taxAddress": {
      "line1": "Rúa Hábitat, 10 Bajo",
      "line2": null,
      "city": "Oleiros",
      "stateProvince": "A Coruña",
      "postalCode": "15172",
      "country": "ES"
    }
  }
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "creationDate": "2020-09-11T03:20:18Z",
      "lastUpdateDate": "2021-01-14T12:58:29Z",
      "name": "Qaroni EMEA S.L.",
      "tradeName": "Qaroni",
      "email": "contact@qaroni.com",
      "phone": "632899315",
      "document": {
        "documentType": "CIF",
        "documentNumber": "B7019392321Y"
      },
      "address": {
        "alias": "Company",
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "postalCode": "15172",
        "country": "ES",
        "location": {
          "longitude": -8.379264119488226,
          "latitude": 43.333946904210705,
          "altitude": null,
          "relevantText": null
        }
      },
      "logoURL": "https://s3.eu-central-1.amazonaws.com/workards.dev/companies/f563978c-ccb6-4e28-a953-b9407914b34c/logos/062ebdb2-a0cf-49d1-aceb-5b01afeb7020.png",
      "status": "ENABLED",
      "timezone": "Europe/Madrid",
      "billingInformation": {
        "planId": "ba0c158d-4568-4f25-a93d-409cf2758ca9",
        "totalSeats": 5,
        "paymentMethodDescription": "Pago Stripe",
        "paymentMethod": "CREDIT_CARD",
        "taxName": "CIF",
        "taxId": "B7019392321Y",
        "taxAddress": {
          "alias": null,
          "line1": "Rúa Hábitat, 10 Bajo",
          "line2": null,
          "city": "Oleiros",
          "stateProvince": "A Coruña",
          "postalCode": "15172",
          "country": "ES",
          "location": null
        }
      }
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Listar las compañías del usuario.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Query Parameters

role: (one of OWNER, ADMIN, MANAGER, EMPLOYEE, VISITOR)
Filtrar por el role.
Example:
```
OWNER
```

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "creationDate": "2020-09-11T03:20:18Z",
      "lastUpdateDate": "2020-09-11T11:23:07Z",
      "name": "Qaroni EMEA S.A.",
      "tradeName": null,
      "email": "contact@qaroni.com",
      "phone": "632899315",
      "document": {
        "documentType": "CIF",
        "documentNumber": "19392321Y"
      },
      "address": {
        "alias": "Dirección principal",
        "line1": "Rúa Hábitat, 10 Bajo",
        "line2": null,
        "city": "Oleiros",
        "stateProvince": "A Coruña",
        "postalCode": "15172",
        "country": "ES",
        "location": {
          "longitude": -8.3791935,
          "latitude": 43.3340781,
          "altitude": null,
          "relevantText": null
        }
      },
      "logoURL": "https://s3.eu-central-1.amazonaws.com/workards.dev/companies/f563978c-ccb6-4e28-a953-b9407914b34c/logos/062ebdb2-a0cf-49d1-aceb-5b01afeb7020.png",
      "status": "ENABLED",
      "planId": null,
      "seats": null,
      "trialMonthsRemaining": null,
      "role": "ADMIN",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/users/companies/{companyId}/dissociates patch

patch

Desasociar usuario existente a ficha de empleado (Solo se modifica el userId en la ficha del empleado).

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

companyId: required(string)
Identificador único de la compañía.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se actualiza el registro de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "creationDate": "2020-09-11T03:20:19Z",
      "lastUpdateDate": "2020-10-16T15:36:44Z",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "userId": null,
      "bossId": null,
      "walletId": "e26e41e1-5ef8-402f-a600-7516b17b9ac6",
      "firstName": "Julio",
      "lastName": "Amaya",
      "email": "atpjulio@yahoo.es",
      "phone": "693828282",
      "dni": "DH23238281",
      "birthdate": "1985-02-07T05:00:00Z",
      "position": "Software Developer",
      "access": "6abf5892-cea4-40f9-a94d-853dfde3af74",
      "pin": "5415",
      "gender": "MALE",
      "status": "ENABLED",
      "state": "OFFLINE",
      "workday": "59f75d7d-df92-44e2-9df6-41b7574b7ed8",
      "employeeCard": "https://s3.eu-central-1.amazonaws.com/qaroni.walletitems.d/e26e41e1-5ef8-402f-a600-7516b17b9ac6.pkpass",
      "timezone": "Europe/Madrid",
      "linkedUser": {
        "email": "atpjulio@yahoo.es",
        "role": "ADMIN",
        "creationDate": "2020-10-17T13:38:22Z"
      },
      "remoteAccess": true
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/users/devices post get

post

Crear un dispositivo móvil para el usuario, para poder recibir notificaciones. Posibles valores de platform ANDROID, IOS.

get

Listar los dispositivos móviles del usuario.

Crear un dispositivo móvil para el usuario, para poder recibir notificaciones. Posibles valores de platform ANDROID, IOS.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "id": "ANDROID_CODE_129102192",
  "notifications": true,
  "version": "10.1",
  "platform": "ANDROID"
}

HTTP status code 201

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "ANDROID_CODE_129102192",
      "creationDate": "2021-02-03T21:00:27Z",
      "lastUpdateDate": "2021-02-03T21:00:27Z",
      "userId": "8ca2b441056af15c3131bf1718266e46b30e4a2c",
      "version": "10.1",
      "platform": "ANDROID",
      "notifications": true
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Listar los dispositivos móviles del usuario.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "ANDROID_CODE_129102192",
      "creationDate": "2021-02-03T21:00:27Z",
      "lastUpdateDate": "2021-02-03T21:00:27Z",
      "userId": "8ca2b441056af15c3131bf1718266e46b30e4a2c",
      "version": "10.1",
      "platform": "ANDROID",
      "notifications": true
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/users/devices/{deviceId} get patch delete

get

Obtener detalle del dispositivo.

patch

Actualizar dispositivo.

delete

Borrar un dispositivo.

Obtener detalle del dispositivo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

deviceId: required(string)
Identificador único del dispositivo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "ANDROID_CODE_129102192",
      "creationDate": "2021-02-03T21:00:27Z",
      "lastUpdateDate": "2021-02-03T21:00:27Z",
      "userId": "8ca2b441056af15c3131bf1718266e46b30e4a2c",
      "version": "10.1",
      "platform": "ANDROID",
      "notifications": true
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Actualizar dispositivo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

deviceId: required(string)
Identificador único del dispositivo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

Body

Media type: application/json

Example:

{
  "id": "ANDROID_CODE_129102192",
  "notifications": true,
  "version": "10.1",
  "platform": "ANDROID"
}

HTTP status code 200

Se actualiza recurso correctamente.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "ANDROID_CODE_129102192",
      "creationDate": "2021-02-03T21:00:27Z",
      "lastUpdateDate": "2021-02-03T21:00:27Z",
      "userId": "8ca2b441056af15c3131bf1718266e46b30e4a2c",
      "version": "10.1",
      "platform": "ANDROID",
      "notifications": true
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Borrar un dispositivo.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

deviceId: required(string)
Identificador único del dispositivo.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 204

Se elimina recurso de forma correcta.

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/users/invitations get

get

Ver invitaciones del usuario.

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se crea el recurso de manera correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "id": "7b8519d3-b6f0-4d46-ba23-4bfac52cce52",
      "creationDate": "2020-09-11T12:14:11Z",
      "lastUpdateDate": "2020-09-11T12:14:11Z",
      "employeeId": "8899ce7c-8792-4a69-9607-95f6a8c19c70",
      "companyId": "f563978c-ccb6-4e28-a953-b9407914b34c",
      "workplaceId": "cb80159a-8403-4964-821f-5aebcd9a2c04",
      "originUserId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "email": "atpjulio@yahoo.es",
      "userId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "status": "CREATED",
      "role": "ADMIN"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/users/invitations/{invitationId}/accepts patch

patch

Aceptar una invitación (Cambiar status a ACCEPTED).

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

invitationId: required(string)
Identificador único de la invitación.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "companyId": "d3e843fd-cfd9-40da-851b-4a04cb6d45ff",
      "workplaceId": "b7b8653c-d7df-4941-91e6-33c203164939",
      "originUserId": "8ca2b441056af15c3131bf1718266e46b30e4a2c",
      "destinationUserId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "status": "ACCEPTED",
      "role": "EMPLOYEE",
      "creationDate": "2020-05-10T23:42:15Z",
      "lastUpdateDate": "2020-05-10T23:42:15Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

/users/invitations/{invitationId}/rejects patch

patch

Rechazar una invitación (No la elimina. Solo cambia el status a REJECTED).

Secured by oauth_2_0

Qaroni supports OAuth 2.0 for authenticating all API requests.

URI Parameters

invitationId: required(string)
Identificador único de la invitación.

Headers

Authorization: required(string)
Bearer token authorization
Application: required(string)
Application ID
Content-type: required(string)
JSON

HTTP status code 200

Se obtiene el recurso de forma correcta.

Body

Media type: application/json

Example:

{
  "count": 1,
  "input": "VERBO: /recurso",
  "result": [
    {
      "companyId": "d3e843fd-cfd9-40da-851b-4a04cb6d45ff",
      "workplaceId": "b7b8653c-d7df-4941-91e6-33c203164939",
      "originUserId": "8ca2b441056af15c3131bf1718266e46b30e4a2c",
      "destinationUserId": "f6e382893ede357ff8161ef46726c2680054eeb4",
      "status": "REJECTED",
      "role": "EMPLOYEE",
      "creationDate": "2020-05-10T23:42:15Z",
      "lastUpdateDate": "2020-05-10T23:42:15Z"
    }
  ],
  "links": null
}

HTTP status code 400

La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.

Body

Media type: application/json

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.

Query Parameters

access_token
Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.

HTTP status code 401

Bad or expired token. This can happen if the user or Administrator revoked or expired an access token. To fix, re-authenticate the user.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "code": "E0004",
      "title": "A required field is missing.",
      "detail": "Validation error",
      "source": {
        "pointer": "VERBO: /recurso",
        "parameter": null
      },
      "links": {
        "about": "https://workards.docs.qaroni.com/"
      }
    }
  ]
}

Workards API documentation version v1

/companies

/companies/{companyId} get patch delete

get /companies/{companyId}

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 400

Body

Secured by oauth_2_0

Headers

Query Parameters

HTTP status code 401

Body

HTTP status code 403

Body

patch /companies/{companyId}

URI Parameters

Headers

Body

HTTP status code 200

Body

HTTP status code 400

Body

Secured by oauth_2_0

Headers

Query Parameters

HTTP status code 401

Body

HTTP status code 403

Body

delete /companies/{companyId}

URI Parameters

Headers

HTTP status code 204

HTTP status code 400

Body

Secured by oauth_2_0

Headers

Query Parameters

HTTP status code 401

Body

HTTP status code 403

Body

/companies/{companyId}/checks get

get /companies/{companyId}/checks

URI Parameters

Headers

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Body

Secured by oauth_2_0

Headers

Query Parameters

HTTP status code 401

Body

HTTP status code 403

Body

/companies/{companyId}/dashboards get

get /companies/{companyId}/dashboards

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 400

Body

Secured by oauth_2_0

Headers

Query Parameters

HTTP status code 401

Body

HTTP status code 403

Body

/companies/{companyId}/employees post get

post /companies/{companyId}/employees

URI Parameters

Headers