Workards API documentation version v1
https://{subdomain}.workards.com/{version}
- subdomain: required(string - default: api.staging)
Subdominio del API
- version: required(v1)
/companies
Obtener detalle de la compañía.
Actualizar compañía.
Dar de baja una compañía.
get /companies/{companyId}
Obtener detalle de la compañía.
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/"
}
}
]
}
patch /companies/{companyId}
Actualizar compañía.
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/"
}
}
]
}
delete /companies/{companyId}
Dar de baja una compañía.
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/"
}
}
]
}
Listar los checks que pertenecen a la compañía.
get /companies/{companyId}/checks
Listar los checks que pertenecen a la compañía.
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/"
}
}
]
}
Obtener dashboard para la compañía.
get /companies/{companyId}/dashboards
Obtener dashboard para la compañía.
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/"
}
}
]
}
Crear una ficha de empleado.
Listar los empleados de una compañía.
post /companies/{companyId}/employees
Crear una ficha de empleado.
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/"
}
}
]
}
get /companies/{companyId}/employees
Listar los empleados de una compañía.
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/"
}
}
]
}
Obtener ficha del empleado enviando clave pin o UUID de access, los posibles valores de type son PIN, ACCESS.
post /companies/{companyId}/employees/access
Obtener ficha del empleado enviando clave pin o UUID de access, los posibles valores de type son PIN, ACCESS.
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/"
}
}
]
}
Detalle de un empleado del centro de trabajo.
Actualizar ficha de empleado.
Dar de baja un empleado.
get /companies/{companyId}/employees/{employeeId}
Detalle de un empleado del centro de trabajo.
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/"
}
}
]
}
patch /companies/{companyId}/employees/{employeeId}
Actualizar ficha de empleado.
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/"
}
}
]
}
delete /companies/{companyId}/employees/{employeeId}
Dar de baja un empleado.
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/"
}
}
]
}
Se envía la tarjeta de trabajo por correo, si no existe la tarjeta, se crea.
post /companies/{companyId}/employees/{employeeId}/cards/emails
Se envía la tarjeta de trabajo por correo, si no existe la tarjeta, se crea.
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/"
}
}
]
}
Hacer un check.
Listar los checks que pertenecen al usuario.
post /companies/{companyId}/employees/{employeeId}/checks
Hacer un check.
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/"
}
}
]
}
get /companies/{companyId}/employees/{employeeId}/checks
Listar los checks que pertenecen al usuario.
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 concreationDate
.Example:
2020-05-02T02:00:00Z
- dateTo: (string)
Filtrar por fecha final (Formato
YYYY-MM-ddThh:mm:ssZ
) comparando concreationDate
.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/"
}
}
]
}
Detalle de check con su array history.
Actualizar check y guardar historia de ello.
get /companies/{companyId}/employees/{employeeId}/checks/{checkId}
Detalle de check con su array history.
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/"
}
}
]
}
patch /companies/{companyId}/employees/{employeeId}/checks/{checkId}
Actualizar check y guardar historia de ello.
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/"
}
}
]
}
Reporte de checks que pertenecen al empleado.
get /companies/{companyId}/employees/{employeeId}/checks/reports
Reporte de checks que pertenecen al empleado.
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/"
}
}
]
}
Generar reporte de checks que pertenecen al empleado.
Reporte de checks que pertenecen al empleado.
post /companies/{companyId}/employees/{employeeId}/checks/reports/{reportId}/months
Generar reporte de checks que pertenecen al empleado.
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/"
}
}
]
}
get /companies/{companyId}/employees/{employeeId}/checks/reports/{reportId}/months
Reporte de checks que pertenecen al empleado.
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/"
}
}
]
}
Reporte de checks que pertenecen al empleado.
get /companies/{companyId}/employees/{employeeId}/checks/reports/months
Reporte de checks que pertenecen al empleado.
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/"
}
}
]
}
Listar los checks que pertenecen a la última jornada del empleado.
get /companies/{companyId}/employees/{employeeId}/checks/shifts
Listar los checks que pertenecen a la última jornada del empleado.
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/"
}
}
]
}
Dar de baja a un empleado indicado si fue voluntaria o despido (VOLUNTARY, FIRED).
patch /companies/{companyId}/employees/{employeeId}/disables
Dar de baja a un empleado indicado si fue voluntaria o despido (VOLUNTARY, FIRED).
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/"
}
}
]
}
Desasociar usuario existente a ficha de empleado.
patch /companies/{companyId}/employees/{employeeId}/dissociates
Desasociar usuario existente a ficha de empleado.
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/"
}
}
]
}
Recuperar a un empleado que fue dado de baja.
patch /companies/{companyId}/employees/{employeeId}/enables
Recuperar a un empleado que fue dado de baja.
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/"
}
}
]
}
Ver invitaciones del empleado.
get /companies/{companyId}/employees/{employeeId}/invitations
Ver invitaciones del empleado.
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/"
}
}
]
}
Crear una invitación.
Listar las invitaciones creadas por la compañía.
post /companies/{companyId}/invitations
Crear una invitación.
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/"
}
}
]
}
get /companies/{companyId}/invitations
Listar las invitaciones creadas por la compañía.
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/"
}
}
]
}
Añade o actualiza logo de la compañía.
Borrar logo de la compañía.
post /companies/{companyId}/logos
Añade o actualiza logo de la compañía.
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/"
}
}
]
}
delete /companies/{companyId}/logos
Borrar logo de la compañía.
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/"
}
}
]
}
Crear una notificación, los campos date e internal por ahora son opcionales.
Listar las plantillas de notificación de la compañía.
post /companies/{companyId}/notifications
Crear una notificación, los campos date e internal por ahora son opcionales.
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/"
}
}
]
}
get /companies/{companyId}/notifications
Listar las plantillas de notificación de la compañía.
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/"
}
}
]
}
Obtener detalle de la notificación.
Actualizar notificación.
Borrar notificación.
get /companies/{companyId}/notifications/{notificationId}
Obtener detalle de la notificación.
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/"
}
}
]
}
patch /companies/{companyId}/notifications/{notificationId}
Actualizar notificación.
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/"
}
}
]
}
delete /companies/{companyId}/notifications/{notificationId}
Borrar notificación.
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/"
}
}
]
}
Enviar notificación a todos los empleados.
post /companies/{companyId}/notifications/{notificationId}/sends
Enviar notificación a todos los empleados.
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/"
}
}
]
}
Enviar notificación a los empleados recibidos del array.
post /companies/{companyId}/notifications/{notificationId}/sends/employees
Enviar notificación a los empleados recibidos del array.
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/"
}
}
]
}
Crear una plantilla de notificación, los posibles valores para status son CREATED, ENABLED, DISABLED
.
Listar las plantillas de notificación de la compañía.
post /companies/{companyId}/notifications/templates
Crear una plantilla de notificación, los posibles valores para status son CREATED, ENABLED, DISABLED
.
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/"
}
}
]
}
get /companies/{companyId}/notifications/templates
Listar las plantillas de notificación de la compañía.
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/"
}
}
]
}
Obtener detalle de la plantilla de notificación.
Actualizar plantilla de notificación.
Borrar plantilla de notificación.
get /companies/{companyId}/notifications/templates/{templateId}
Obtener detalle de la plantilla de notificación.
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/"
}
}
]
}
patch /companies/{companyId}/notifications/templates/{templateId}
Actualizar plantilla de notificación.
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/"
}
}
]
}
delete /companies/{companyId}/notifications/templates/{templateId}
Borrar plantilla de notificación.
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/"
}
}
]
}
Darse de baja del plan suscrito.
delete /companies/{companyId}/plans/{planId}
Darse de baja del plan suscrito.
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/"
}
}
]
}
Crear sesión de pago (Checkout).
post /companies/{companyId}/plans/{planId}/checkouts
Crear sesión de pago (Checkout).
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/"
}
}
]
}
Crear una plantilla de horario. Posibles valores para status ACTIVE, INACTIVE
.
Listar plantillas de horario.
post /companies/{companyId}/schedules
Crear una plantilla de horario. Posibles valores para status ACTIVE, INACTIVE
.
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/"
}
}
]
}
get /companies/{companyId}/schedules
Listar plantillas de horario.
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/"
}
}
]
}
Obtener detalle de una plantilla de horario.
Actualizar una plantilla de horario.
Borrar una plantilla de horario.
get /companies/{companyId}/schedules/{scheduleId}
Obtener detalle de una plantilla de horario.
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/"
}
}
]
}
patch /companies/{companyId}/schedules/{scheduleId}
Actualizar una plantilla de horario.
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/"
}
}
]
}
delete /companies/{companyId}/schedules/{scheduleId}
Borrar una plantilla de horario.
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/"
}
}
]
}
Actualizar status de horario, posibles valores CREATED, ACTIVE, INACTIVE
.
patch /companies/{companyId}/schedules/{scheduleId}/status
Actualizar status de horario, posibles valores CREATED, ACTIVE, INACTIVE
.
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/"
}
}
]
}
Listar los usuarios de una empresa.
get /companies/{companyId}/users
Listar los usuarios de una empresa.
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/"
}
}
]
}
Crear una invitación para usuario.
post /companies/{companyId}/users/invitations
Crear una invitación para usuario.
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/"
}
}
]
}
Obtener detalle del usuario.
Actualizar usuario de empresa, por ahora solo se puede actualizar rol.
Borrar un usuario de empresa.
get /companies/{companyId}/users/{userId}
Obtener detalle del usuario.
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/"
}
}
]
}
patch /companies/{companyId}/users/{userId}
Actualizar usuario de empresa, por ahora solo se puede actualizar rol.
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/"
}
}
]
}
delete /companies/{companyId}/users/{userId}
Borrar un usuario de empresa.
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/"
}
}
]
}
Crear un centro de trabajo.
Listar los centros de trabajo.
post /companies/{companyId}/workplaces
Crear un centro de trabajo.
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/"
}
}
]
}
get /companies/{companyId}/workplaces
Listar los centros de trabajo.
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/"
}
}
]
}
Obtener detalle del centro de trabajo.
Actualizar centro de trabajo.
Borrar un centro de trabajo.
get /companies/{companyId}/workplaces/{workplaceId}
Obtener detalle del centro de trabajo.
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/"
}
}
]
}
patch /companies/{companyId}/workplaces/{workplaceId}
Actualizar centro de trabajo.
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/"
}
}
]
}
delete /companies/{companyId}/workplaces/{workplaceId}
Borrar un centro de trabajo.
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/"
}
}
]
}
Listar los checks que pertenecen al centro de trabajo.
get /companies/{companyId}/workplaces/{workplaceId}/checks
Listar los checks que pertenecen al centro de trabajo.
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/"
}
}
]
}
Obtener dashboard para el centro de trabajo.
get /companies/{companyId}/workplaces/{workplaceId}/dashboards
Obtener dashboard para el centro de trabajo.
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/"
}
}
]
}
Listar los empleados de un centro de trabajo.
get /companies/{companyId}/workplaces/{workplaceId}/employees
Listar los empleados de un centro de trabajo.
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/"
}
}
]
}
Obtener los horarios del empleado.
get /companies/{companyId}/workplaces/{workplaceId}/employees/{employeeId}/schedules
Obtener los horarios del empleado.
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
Asociar un horario custom al empleado.
Desasociar un horario custom del empleado.
post /companies/{companyId}/workplaces/{workplaceId}/employees/{employeeId}/schedules/{scheduleId}
Asociar un horario custom al empleado.
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/"
}
}
]
}
delete /companies/{companyId}/workplaces/{workplaceId}/employees/{employeeId}/schedules/{scheduleId}
Desasociar un horario custom del empleado.
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/"
}
}
]
}
Agregar un festivo para centro de trabajo.
post /companies/{companyId}/workplaces/{workplaceId}/holidays
Agregar un festivo para centro de trabajo.
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/"
}
}
]
}
Agregar varios festivos al workplace por su identificador. Se descartan los no existentes o duplicados.
Desvincular varios festivos al workplace por su identificador. Se descartan los no existentes.
post /companies/{companyId}/workplaces/{workplaceId}/holidays/associates
Agregar varios festivos al workplace por su identificador. Se descartan los no existentes o duplicados.
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/"
}
}
]
}
patch /companies/{companyId}/workplaces/{workplaceId}/holidays/associates
Desvincular varios festivos al workplace por su identificador. Se descartan los no existentes.
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/"
}
}
]
}
Actualizar un festivo para centro de trabajo.
Borrar un festivo del workplace.
patch /companies/{companyId}/workplaces/{workplaceId}/holidays/{holidayId}
Actualizar un festivo para centro de trabajo.
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/"
}
}
]
}
delete /companies/{companyId}/workplaces/{workplaceId}/holidays/{holidayId}
Borrar un festivo del workplace.
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/"
}
}
]
}
Obtener PDF tamaño carta con el QR del centro de trabajo.
get /companies/{companyId}/workplaces/{workplaceId}/pdfs
Obtener PDF tamaño carta con el QR del centro de trabajo.
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
Crear un con el id con el código ISO. Ejemplo para España sería ES y para Venezuela sería VE.
Listar los países.
post /countries
Crear un con el id con el código ISO. Ejemplo para España sería ES y para Venezuela sería VE.
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/"
}
}
]
}
get /countries
Listar los países.
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/"
}
}
]
}
Obtener detalle del país.
Actualizar país.
Borrar un país.
get /countries/{countryId}
Obtener detalle del país.
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/"
}
}
]
}
patch /countries/{countryId}
Actualizar país.
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/"
}
}
]
}
delete /countries/{countryId}
Borrar un país.
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/"
}
}
]
}
Crear un estado, con su código ISO 3166-2, el cual por cierto es opcional.
Listar los estados del país.
post /countries/{countryId}/states
Crear un estado, con su código ISO 3166-2, el cual por cierto es opcional.
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/"
}
}
]
}
get /countries/{countryId}/states
Listar los estados del país.
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/"
}
}
]
}
Obtener detalle del estado.
Actualizar estado.
Borrar un estado.
get /countries/{countryId}/states/{stateId}
Obtener detalle del estado.
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/"
}
}
]
}
patch /countries/{countryId}/states/{stateId}
Actualizar estado.
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/"
}
}
]
}
delete /countries/{countryId}/states/{stateId}
Borrar un estado.
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/"
}
}
]
}
Importa los estados para el país dado.
post /countries/{countryId}/states/excel/imports
Importa los estados para el país dado.
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
Detalle de una ficha de empleado.
get /employees/{employeeId}
Detalle de una ficha de empleado.
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/"
}
}
]
}
Hacer un check.
Listar los checks que pertenecen al usuario.
post /employees/{employeeId}/checks
Hacer un check.
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/"
}
}
]
}
get /employees/{employeeId}/checks
Listar los checks que pertenecen al usuario.
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 concreationDate
.Example:
2020-05-02T02:00:00Z
- dateTo: (string)
Filtrar por fecha final (Formato
YYYY-MM-ddThh:mm:ssZ
) comparando concreationDate
.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/"
}
}
]
}
Detalle de check con su array history.
Actualizar check y guardar historia de ello.
get /employees/{employeeId}/checks/{checkId}
Detalle de check con su array history.
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/"
}
}
]
}
patch /employees/{employeeId}/checks/{checkId}
Actualizar check y guardar historia de ello.
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/"
}
}
]
}
Reporte de checks que pertenecen al empleado.
get /employees/{employeeId}/checks/reports
Reporte de checks que pertenecen al empleado.
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/"
}
}
]
}
Generar reporte de checks que pertenecen al empleado.
Reporte de checks que pertenecen al empleado.
post /employees/{employeeId}/checks/reports/{reportId}/months
Generar reporte de checks que pertenecen al empleado.
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/"
}
}
]
}
get /employees/{employeeId}/checks/reports/{reportId}/months
Reporte de checks que pertenecen al empleado.
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/"
}
}
]
}
Reporte de checks que pertenecen al empleado.
get /employees/{employeeId}/checks/reports/months
Reporte de checks que pertenecen al empleado.
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/"
}
}
]
}
Listar los checks que pertenecen a la última jornada del empleado.
get /employees/{employeeId}/checks/shifts
Listar los checks que pertenecen a la última jornada del empleado.
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/"
}
}
]
}
Listar los checks a la jornada.
get /employees/{employeeId}/checks/shifts/{workday}
Listar los checks a la jornada.
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/"
}
}
]
}
Listar las notificaciones del empleado.
get /employees/{employeeId}/notifications
Listar las notificaciones del empleado.
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/"
}
}
]
}
Obtener detalle de la notificación.
Cambiar status de notificación al enviado, se genera una notificación PUSH de tipo BADGE.
Borrar notificación, se genera una notificación PUSH de tipo BADGE.
get /employees/{employeeId}/notifications/{notificationId}
Obtener detalle de la notificación.
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/"
}
}
]
}
patch /employees/{employeeId}/notifications/{notificationId}
Cambiar status de notificación al enviado, se genera una notificación PUSH de tipo BADGE.
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/"
}
}
]
}
delete /employees/{employeeId}/notifications/{notificationId}
Borrar notificación, se genera una notificación PUSH de tipo BADGE.
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/"
}
}
]
}
Obtener contador actualizado de notificaciones UNREAD
.
get /employees/{employeeId}/notifications/unreads/counts
Obtener contador actualizado de notificaciones UNREAD
.
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/"
}
}
]
}
Obtener los horarios del empleado.
get /employees/{employeeId}/schedules
Obtener los horarios del empleado.
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/"
}
}
]
}
Listar los centros de trabajo.
get /employees/{employeeId}/workplaces
Listar los centros de trabajo.
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
Subir fichero de manera genérica.
post /files/temps/storages
Subir fichero de manera genérica.
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
Crear un festivo, los posibles valores para type son NATIONAL, REGIONAL, LOCAL, PRIVATE. Si es de tipo NATIONAL
, enviar * en stateProvince.
Listar los festivos.
post /holidays
Crear un festivo, los posibles valores para type son NATIONAL, REGIONAL, LOCAL, PRIVATE. Si es de tipo NATIONAL
, enviar * en stateProvince.
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/"
}
}
]
}
get /holidays
Listar los festivos.
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/"
}
}
]
}
Obtener detalle del festivo.
Actualizar festivo.
Borrar un festivo.
get /holidays/{holidayId}
Obtener detalle del festivo.
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/"
}
}
]
}
patch /holidays/{holidayId}
Actualizar festivo.
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/"
}
}
]
}
delete /holidays/{holidayId}
Borrar un festivo.
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/"
}
}
]
}
Importa los festivos.
post /holidays/excel/imports
Importa los festivos.
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
Crear un plan.
Listar los planes.
post /plans
Crear un plan.
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/"
}
}
]
}
get /plans
Listar los planes.
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/"
}
}
]
}
Obtener detalle del plan.
Actualizar plan.
Borrar un plan.
get /plans/{planId}
Obtener detalle del plan.
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/"
}
}
]
}
patch /plans/{planId}
Actualizar plan.
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/"
}
}
]
}
delete /plans/{planId}
Borrar un plan.
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
Crear una compañía (Se crea el workplace y ficha del empleado usuario).
Listar las compañías del usuario.
post /users/companies
Crear una compañía (Se crea el workplace y ficha del empleado usuario).
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/"
}
}
]
}
get /users/companies
Listar las compañías del usuario.
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/"
}
}
]
}
Desasociar usuario existente a ficha de empleado (Solo se modifica el userId en la ficha del empleado).
patch /users/companies/{companyId}/dissociates
Desasociar usuario existente a ficha de empleado (Solo se modifica el userId en la ficha del empleado).
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/"
}
}
]
}
Crear un dispositivo móvil para el usuario, para poder recibir notificaciones. Posibles valores de platform ANDROID, IOS
.
Listar los dispositivos móviles del usuario.
post /users/devices
Crear un dispositivo móvil para el usuario, para poder recibir notificaciones. Posibles valores de platform ANDROID, IOS
.
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/"
}
}
]
}
get /users/devices
Listar los dispositivos móviles del usuario.
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/"
}
}
]
}
Obtener detalle del dispositivo.
Actualizar dispositivo.
Borrar un dispositivo.
get /users/devices/{deviceId}
Obtener detalle del dispositivo.
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/"
}
}
]
}
patch /users/devices/{deviceId}
Actualizar dispositivo.
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/"
}
}
]
}
delete /users/devices/{deviceId}
Borrar un dispositivo.
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/"
}
}
]
}
Ver invitaciones del usuario.
get /users/invitations
Ver invitaciones del usuario.
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/"
}
}
]
}
Aceptar una invitación (Cambiar status a ACCEPTED
).
patch /users/invitations/{invitationId}/accepts
Aceptar una invitación (Cambiar status a ACCEPTED
).
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/"
}
}
]
}
Rechazar una invitación (No la elimina. Solo cambia el status a REJECTED
).
patch /users/invitations/{invitationId}/rejects
Rechazar una invitación (No la elimina. Solo cambia el status a REJECTED
).
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/"
}
}
]
}