Plaam version v1
https://{subdomain}.plaam.com/{version}
- subdomain: required(string - default: plaam.docs)
Subdominio del API
- version: required(v1)
/accounts
Listar los accounts.
get /accounts
Listar los accounts.
Qaroni supports OAuth 2.0 for authenticating all API requests.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- last: (integer)
Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.
Example:
2
- status: (one of CREATED, ENABLED, DISABLED)
Estado del account.
Example:
ENABLED
HTTP status code 200
Se obtiene el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"input": "VERBO/recurso",
"result": [
{
"accountId": 8,
"email": "atpjulio@gmail.com",
"phone": "640233822",
"firstName": "Julio",
"lastName": "Amaya",
"documentType": "PASSPORT",
"document": "134545343221",
"birthday": "1985-02-07",
"gender": "MALE",
"language": "es",
"image": null,
"creationDate": "2020-04-07T16:37:06Z",
"lastUpdateDate": "2020-04-07T16:37:06Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Login de acceso para account.
post /accounts/logins
Login de acceso para account.
Body
Media type: application/json
Example:
{
"username": "atpjulio@gmail.com",
"password": "1234"
}
HTTP status code 200
Se obtiene el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"input": "VERBO/recurso",
"result": [
{
"accountId": 8,
"access_token": "eyJpdiI6InVVK1FwTWlSOWhZNG1KYkRWU0hCQXc9PSIsInZhbHVlIjoiQm4yeml0QU1DYVoxNEpacGVEdFVuWHhGbE1LcWcySE9zalhMTWYzZmJ2cldUOU1tOEc3NjNReXhHeTNjcGRHMyIsIm1hYyI6IjBjMTA3OWZiNWRkOGE5Mzc5ODJhMjQ4NWQ5YmUyMDNjMmM3ZjhlNTNjNWE4MmFiMTEyODBhZjE4MDgwNzliOTQifQ==",
"issued": "2020-04-07T17:12:00Z",
"expires": "2020-04-08T17:12:00Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Detalle de un account.
get /accounts/{accountId}
Detalle de un account.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- accountId: required(integer)
Identificador único del account.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"input": "VERBO/recurso",
"result": [
{
"accountId": 8,
"email": "atpjulio@gmail.com",
"phone": "640233822",
"firstName": "Julio",
"lastName": "Amaya",
"documentType": "PASSPORT",
"document": "134545343221",
"birthday": "1985-02-07",
"gender": "MALE",
"language": "es",
"image": null,
"creationDate": "2020-04-07T16:37:06Z",
"lastUpdateDate": "2020-04-07T16:37:06Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Listar las empresas a las que tiene acceso el account.
get /accounts/{accountId}/merchants
Listar las empresas a las que tiene acceso el account.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- accountId: required(integer)
Identificador único del account.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- 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:
{
"input": "GET/merchants",
"result": [
{
"merchantId": 114,
"name": "Labrax Soluciones S.L",
"tradeName": "Labrax",
"state": "ENABLED",
"logoImageUrl": "https://www.labraxsoluciones.com/images/logo.png",
"web": "www.labraxsoluciones.com",
"phone": "+34111111111",
"email": " acliente@labraxsoluciones.com",
"document": "B11117282",
"address":{
"line1":"Calle Emilio González López 51 Bajo",
"line2":"",
"city":"A Coruña",
"stateProvince":"A Coruña",
"postalCode":"15011",
"country":"ES"
},
"language": "es",
"creationDate": "2020-01-19T21:16:50Z",
"lastUpdateDate": "2020-01-19T21:16:50Z"
},
{
"merchantId": 124,
"name": "Qaroni Emea S.L",
"tradeName": "Qaroní",
"state": "ENABLED",
"logoImageUrl": "https://s3.amazonaws.com/www.qaroni.com/qaroni.png",
"web": "www.qaroni.com",
"phone": "+34111111111",
"email": "contact@qaroni.com",
"document": "B52387282",
"address":{
"line1":"Rúa Hábitat, 10 Bajo",
"line2":"",
"city":"Oleiros",
"stateProvince":"A Coruña",
"postalCode":"15172",
"country":"ES"
},
"language": "es",
"creationDate": "2020-01-19T21:16:50Z",
"lastUpdateDate": "2020-01-19T21:16:50Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
/buckets/uploads
Subir fichero al bucket de S3.
post /buckets/uploads
Subir fichero al bucket de S3.
Application-Token for API requests.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: multipart/form-data
Type: object
Properties- path: required(string)
Example:
/imagenes/subidas
- file: required(file)
Fichero a subir.
HTTP status code 200
Se sube el fichero de forma correcta.
Body
Media type: application/json
Example:
{
"input": "GET/merchants/{merchantId}/news/{newId}",
"result": [
{
"information": "File uploaded successfully",
"url": "https://s3.eu-central-1.amazonaws.com/plaam.dev/subidos/portadas/849237a5-54ec-4971-89d8-1233c7422ea0.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
/files/temps/storages
Subir fichero de manera genérica.
post /files/temps/storages
Subir fichero de manera genérica.
Application-Token for API requests.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
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,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"originalName": "22.png",
"storageId": "699dd381-6131-4baf-88c2-d723fb40d004",
"fileUrl": "http://plaam-api.test/storage/uploads/699dd381-6131-4baf-88c2-d723fb40d004.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
/merchants
Listar las empresas.
get /merchants
Listar las empresas.
Query Parameters
- last: (integer)
Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.
Example:
2
- language: (string)
Idioma de la solicitud en formato ISO, si no se usa toma un default.
Example:
es
HTTP status code 200
Se obtiene el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"input": "GET/merchants",
"result": [
{
"merchantId": 114,
"name": "Labrax Soluciones S.L",
"tradeName": "Labrax",
"state": "ENABLED",
"logoImageUrl": "https://www.labraxsoluciones.com/images/logo.png",
"web": "www.labraxsoluciones.com",
"phone": "+34111111111",
"email": " acliente@labraxsoluciones.com",
"document": "B11117282",
"address":{
"line1":"Calle Emilio González López 51 Bajo",
"line2":"",
"city":"A Coruña",
"stateProvince":"A Coruña",
"postalCode":"15011",
"country":"ES"
},
"language": "es",
"creationDate": "2020-01-19T21:16:50Z",
"lastUpdateDate": "2020-01-19T21:16:50Z"
},
{
"merchantId": 124,
"name": "Qaroni Emea S.L",
"tradeName": "Qaroní",
"state": "ENABLED",
"logoImageUrl": "https://s3.amazonaws.com/www.qaroni.com/qaroni.png",
"web": "www.qaroni.com",
"phone": "+34111111111",
"email": "contact@qaroni.com",
"document": "B52387282",
"address":{
"line1":"Rúa Hábitat, 10 Bajo",
"line2":"",
"city":"Oleiros",
"stateProvince":"A Coruña",
"postalCode":"15172",
"country":"ES"
},
"language": "es",
"creationDate": "2020-01-19T21:16:50Z",
"lastUpdateDate": "2020-01-19T21:16:50Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Detalle de una empresa.
get /merchants/{merchantId}
Detalle de una empresa.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Query Parameters
- language: (string)
Idioma de la solicitud en formato ISO, si no se usa toma un default.
Example:
es
HTTP status code 200
Se obtiene el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"input": "GET/merchants/{merchantId}",
"result": [
{
"merchantId": 114,
"name": "Qaroni Emea S.L",
"tradeName": "Qaroní",
"state": "ENABLED",
"logoImageUrl": "https://s3.amazonaws.com/www.qaroni.com/qaroni.png",
"web": "www.qaroni.com",
"phone": "+34111111111",
"email": "contact@qaroni.com",
"document": "B52387282",
"address":{
"line1":"Rúa Hábitat, 10 Bajo",
"line2":"",
"city":"Oleiros",
"stateProvince":"A Coruña",
"postalCode":"15172",
"country":"ES"
},
"language": "es",
"creationDate": "2020-01-19T21:16:50Z",
"lastUpdateDate": "2020-01-19T21:16:50Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener las categorías de titulaciones.
Crea una nueva categoría de titulación.
get /merchants/{merchantId}/academics/degrees/categories
Obtener las categorías de titulaciones.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- search: (string)
Buscar por
name
.Example:
categoría nueva
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 119,
"status": "CREATED",
"name": "CATEGORÍA",
"creationDate": "2023-03-09T14:55:03Z",
"lastUpdateDate": "2023-03-09T14:55:03Z",
"categoryId": 2
}
],
"links": {
"total": 2,
"first": "http://localhost:8000/v1/merchants/119/academics/degrees/categories?page=1",
"last": "http://localhost:8000/v1/merchants/119/academics/degrees/categories?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
post /merchants/{merchantId}/academics/degrees/categories
Crea una nueva categoría de titulación.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Categoria",
"status": "CREATED"
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 119,
"status": "CREATED",
"name": "CATEGORÍA",
"creationDate": "2023-03-09T14:55:03Z",
"lastUpdateDate": "2023-03-09T14:55:03Z",
"categoryId": 2
}
],
"links": {
"total": 2,
"first": "http://localhost:8000/v1/merchants/119/academics/degrees/categories?page=1",
"last": "http://localhost:8000/v1/merchants/119/academics/degrees/categories?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de categoría de la titulación.
Actualizar categoría.
Borrar categoría.
get /merchants/{merchantId}/academics/degrees/categories/{categoryId}
Obtener detalle de categoría de la titulación.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría de la titulación.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 119,
"status": "CREATED",
"name": "CATEGORÍA",
"creationDate": "2023-03-09T14:55:03Z",
"lastUpdateDate": "2023-03-09T14:55:03Z",
"categoryId": 2
}
],
"links": {
"total": 2,
"first": "http://localhost:8000/v1/merchants/119/academics/degrees/categories?page=1",
"last": "http://localhost:8000/v1/merchants/119/academics/degrees/categories?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/academics/degrees/categories/{categoryId}
Actualizar categoría.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría de la titulación.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Categoria",
"status": "CREATED"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 119,
"status": "CREATED",
"name": "CATEGORÍA",
"creationDate": "2023-03-09T14:55:03Z",
"lastUpdateDate": "2023-03-09T14:55:03Z",
"categoryId": 2
}
],
"links": {
"total": 2,
"first": "http://localhost:8000/v1/merchants/119/academics/degrees/categories?page=1",
"last": "http://localhost:8000/v1/merchants/119/academics/degrees/categories?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/academics/degrees/categories/{categoryId}
Borrar categoría.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría de la titulación.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea una especialidad.
Obtener las especialidades.
post /merchants/{merchantId}/academics/degrees
Crea una especialidad.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Machine learning",
"categoryId": 2
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"categoryId": null,
"merchantId": 119,
"name": "Machine learning",
"categoryName": null,
"creationDate": "2023-04-12T16:00:33Z",
"lastUpdateDate": "2023-04-12T16:00:34Z",
"degreeId": 13
}
],
"links": {
"total": 1,
"first": "http://localhost:8000/v1/merchants/119/academics/degrees?page=1",
"last": "http://localhost:8000/v1/merchants/119/academics/degrees?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/academics/degrees
Obtener las especialidades.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- search: (string)
Buscar por
name
.Example:
Machine
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"categoryId": null,
"merchantId": 119,
"name": "Machine learning",
"categoryName": null,
"creationDate": "2023-04-12T16:00:33Z",
"lastUpdateDate": "2023-04-12T16:00:34Z",
"degreeId": 13
}
],
"links": {
"total": 1,
"first": "http://localhost:8000/v1/merchants/119/academics/degrees?page=1",
"last": "http://localhost:8000/v1/merchants/119/academics/degrees?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de especialidad.
Actualizar especialidad.
Borrar especialidad.
get /merchants/{merchantId}/academics/degrees/{degreeId}
Obtener detalle de especialidad.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- degreeId: required(string)
- specialtyId: required(integer)
Identificador único de la especialidad.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"categoryId": null,
"merchantId": 119,
"name": "Machine learning",
"categoryName": null,
"creationDate": "2023-04-12T16:00:33Z",
"lastUpdateDate": "2023-04-12T16:00:34Z",
"degreeId": 13
}
],
"links": {
"total": 1,
"first": "http://localhost:8000/v1/merchants/119/academics/degrees?page=1",
"last": "http://localhost:8000/v1/merchants/119/academics/degrees?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/academics/degrees/{degreeId}
Actualizar especialidad.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- degreeId: required(string)
- specialtyId: required(integer)
Identificador único de la especialidad.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Machine learning",
"categoryId": 2
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"categoryId": null,
"merchantId": 119,
"name": "Machine learning",
"categoryName": null,
"creationDate": "2023-04-12T16:00:33Z",
"lastUpdateDate": "2023-04-12T16:00:34Z",
"degreeId": 13
}
],
"links": {
"total": 1,
"first": "http://localhost:8000/v1/merchants/119/academics/degrees?page=1",
"last": "http://localhost:8000/v1/merchants/119/academics/degrees?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/academics/degrees/{degreeId}
Borrar especialidad.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- degreeId: required(string)
- specialtyId: required(integer)
Identificador único de la especialidad.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea una universidad.
Obtener las universidades.
post /merchants/{merchantId}/academics/universities
Crea una universidad.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"acronym": "UNET",
"name": "Universidad Nacional Experimental del Táchira",
"email": "info@unet.com",
"phone": "23842727222",
"rector": "Dr. Frank Sánchez",
"line1": "Av Principal Plaza de Toros",
"line2": "",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "15838333",
"country": "ES"
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"status": "ACTIVE",
"acronym": "UNET",
"name": "Universidad Nacional Experimental del Táchira",
"email": "info@unet.com",
"phone": "23842727222",
"rector": "Dr. Frank Sánchez",
"line1": "Av Principal Plaza de Toros",
"line2": null,
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "15838333",
"country": "ES",
"merchantId": "80",
"creationDate": "2021-10-19T18:28:52Z",
"lastUpdateDate": "2021-10-19T18:28:52Z",
"universityId": 1,
"imageUrl": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/academics/universities
Obtener las universidades.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- status: (one of ACTIVE, INACTIVE)
Status.
Example:
ACTIVE
- search: (string)
Buscar por
name, email, rector, phone
.Example:
Javier Oviedo
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"status": "ACTIVE",
"acronym": "UNET",
"name": "Universidad Nacional Experimental del Táchira",
"email": "info@unet.com",
"phone": "23842727222",
"rector": "Dr. Frank Sánchez",
"line1": "Av Principal Plaza de Toros",
"line2": null,
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "15838333",
"country": "ES",
"merchantId": "80",
"creationDate": "2021-10-19T18:28:52Z",
"lastUpdateDate": "2021-10-19T18:28:52Z",
"universityId": 1,
"imageUrl": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de universidad.
Actualizar universidad.
Borrar universidad.
get /merchants/{merchantId}/academics/universities/{universityId}
Obtener detalle de universidad.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"status": "ACTIVE",
"acronym": "UNET",
"name": "Universidad Nacional Experimental del Táchira",
"email": "info@unet.com",
"phone": "23842727222",
"rector": "Dr. Frank Sánchez",
"line1": "Av Principal Plaza de Toros",
"line2": null,
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "15838333",
"country": "ES",
"merchantId": "80",
"creationDate": "2021-10-19T18:28:52Z",
"lastUpdateDate": "2021-10-19T18:28:52Z",
"universityId": 1,
"imageUrl": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/academics/universities/{universityId}
Actualizar universidad.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"acronym": "UNET",
"name": "Universidad Nacional Experimental del Táchira",
"email": "info@unet.com",
"phone": "23842727222",
"rector": "Dr. Frank Sánchez",
"line1": "Av Principal Plaza de Toros",
"line2": "",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "15838333",
"country": "ES"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"status": "ACTIVE",
"acronym": "UNET",
"name": "Universidad Nacional Experimental del Táchira",
"email": "info@unet.com",
"phone": "23842727222",
"rector": "Dr. Frank Sánchez",
"line1": "Av Principal Plaza de Toros",
"line2": null,
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "15838333",
"country": "ES",
"merchantId": "80",
"creationDate": "2021-10-19T18:28:52Z",
"lastUpdateDate": "2021-10-19T18:28:52Z",
"universityId": 1,
"imageUrl": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/academics/universities/{universityId}
Borrar universidad.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea una escuela.
Obtener las escuelas.
post /merchants/{merchantId}/academics/universities/{universityId}/schools
Crea una escuela.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Instituto Cristóbal Colón",
"email": "info@ccolon.com",
"phone": "36242727222",
"line1": "Av Principal Escolar",
"line2": "",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "14040333",
"country": "ES"
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"universityId": 1,
"name": "Instituto Cristóbal Colón",
"email": "info@ccolon.com",
"phone": "36242727222",
"line1": "Av Principal Escolar",
"line2": null,
"postalCode": "14040333",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"country": "ES",
"creationDate": "2021-10-20T14:20:55Z",
"lastUpdateDate": "2021-10-20T14:20:55Z",
"schoolId": 1
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/academics/universities/{universityId}/schools
Obtener las escuelas.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- search: (string)
Buscar por
name, email
.Example:
Instituto
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"universityId": 1,
"name": "Instituto Cristóbal Colón",
"email": "info@ccolon.com",
"phone": "36242727222",
"line1": "Av Principal Escolar",
"line2": null,
"postalCode": "14040333",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"country": "ES",
"creationDate": "2021-10-20T14:20:55Z",
"lastUpdateDate": "2021-10-20T14:20:55Z",
"schoolId": 1
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de escuela.
Actualizar escuela.
Borrar escuela.
get /merchants/{merchantId}/academics/universities/{universityId}/schools/{schoolId}
Obtener detalle de escuela.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
- schoolId: required(integer)
Identificador único de la escuela.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"universityId": 1,
"name": "Instituto Cristóbal Colón",
"email": "info@ccolon.com",
"phone": "36242727222",
"line1": "Av Principal Escolar",
"line2": null,
"postalCode": "14040333",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"country": "ES",
"creationDate": "2021-10-20T14:20:55Z",
"lastUpdateDate": "2021-10-20T14:20:55Z",
"schoolId": 1
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/academics/universities/{universityId}/schools/{schoolId}
Actualizar escuela.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
- schoolId: required(integer)
Identificador único de la escuela.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Instituto Cristóbal Colón",
"email": "info@ccolon.com",
"phone": "36242727222",
"line1": "Av Principal Escolar",
"line2": "",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"postalCode": "14040333",
"country": "ES"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"universityId": 1,
"name": "Instituto Cristóbal Colón",
"email": "info@ccolon.com",
"phone": "36242727222",
"line1": "Av Principal Escolar",
"line2": null,
"postalCode": "14040333",
"city": "San Cristóbal",
"stateProvince": "Táchira",
"country": "ES",
"creationDate": "2021-10-20T14:20:55Z",
"lastUpdateDate": "2021-10-20T14:20:55Z",
"schoolId": 1
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/academics/universities/{universityId}/schools/{schoolId}
Borrar escuela.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- universityId: required(integer)
Identificador único de la universidad.
- schoolId: required(integer)
Identificador único de la escuela.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Recuperación de contraseña de account.
patch /merchants/{merchantId}/accounts/forgots
Recuperación de contraseña de account.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Body
Media type: application/json
Example:
{
"username": "atpjulio@gmail.com"
}
HTTP status code 200
Se envia un email al account con Link para el cambio de password.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Login de acceso para account.
post /merchants/{merchantId}/accounts/logins
Login de acceso para account.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Body
Media type: application/json
Example:
{
"username": "atpjulio@gmail.com",
"password": "1234"
}
HTTP status code 200
Se obtiene el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"input": "VERBO/recurso",
"result": [
{
"accountId": 8,
"access_token": "eyJpdiI6InVVK1FwTWlSOWhZNG1KYkRWU0hCQXc9PSIsInZhbHVlIjoiQm4yeml0QU1DYVoxNEpacGVEdFVuWHhGbE1LcWcySE9zalhMTWYzZmJ2cldUOU1tOEc3NjNReXhHeTNjcGRHMyIsIm1hYyI6IjBjMTA3OWZiNWRkOGE5Mzc5ODJhMjQ4NWQ5YmUyMDNjMmM3ZjhlNTNjNWE4MmFiMTEyODBhZjE4MDgwNzliOTQifQ==",
"issued": "2020-04-07T17:12:00Z",
"expires": "2020-04-08T17:12:00Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Registro de account.
post /merchants/{merchantId}/accounts/registers
Registro de account.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Body
Media type: application/json
Example:
{
"username": "atpjulio@gmail.com",
"password": "1234",
"language": "es"
}
HTTP status code 200
Se obtiene el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"input": "POST/merchants/{merchantId}/accounts/registers",
"result": [
{
"username": "atpjulio@gmail.com",
"status": "CREATED",
"otp": null,
"creationDate": "2020-04-07T15:40:38Z",
"lastUpdateDate": "2020-04-07T15:40:38Z",
"accountId": 1,
"image": 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
Activar account (Pasar el status de CREATED a ACTIVE).
patch /merchants/{merchantId}/accounts/{accountId}/validates
Activar account (Pasar el status de CREATED a ACTIVE).
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- accountId: required(integer)
Identificador único del account.
Body
Media type: application/json
Example:
{
"otp": 4545
}
HTTP status code 200
Se obtiene el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"input": "VERBO/recurso",
"result": [
{
"accountId": 8,
"access_token": "eyJpdiI6InVVK1FwTWlSOWhZNG1KYkRWU0hCQXc9PSIsInZhbHVlIjoiQm4yeml0QU1DYVoxNEpacGVEdFVuWHhGbE1LcWcySE9zalhMTWYzZmJ2cldUOU1tOEc3NjNReXhHeTNjcGRHMyIsIm1hYyI6IjBjMTA3OWZiNWRkOGE5Mzc5ODJhMjQ4NWQ5YmUyMDNjMmM3ZjhlNTNjNWE4MmFiMTEyODBhZjE4MDgwNzliOTQifQ==",
"issued": "2020-04-07T17:12:00Z",
"expires": "2020-04-08T17:12:00Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener los cargos bancarios del comercio.
get /merchants/{merchantId}/banks/charges
Obtener los cargos bancarios del comercio.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- sortField: (string)
Posibles valores permitidos -> id, orderDate, name, creationDate.
Example:
date
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
- search: (string)
Búsqueda por concept, name.
Example:
bienestar
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- last: (integer)
Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.
Example:
2
- status: (one of ACTIVE, CREATED, SENT)
Status del cargo bancario.
Example:
ACTIVE
- dateFrom: (string)
Filtrar por fecha en formato Y-m-d H:i:s (DESDE).
Example:
2021-11-12 10:30:00
- dateTo: (string)
Filtrar por fecha en formato Y-m-d H:i:s (HASTA).
Example:
2021-11-14 23:59:59
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [{
"merchantId": 80,
"clientId": 179752,
"orderId": 3055,
"orderDate": "2022-08-11",
"amount": 1400,
"status": "RETURN",
"type": "ASSOCIATION",
"name": "Mario Contreras",
"bic": "BICGALXXXX",
"iban": "ES0012255555555555555",
"concept": "Devolución desde la plataforma",
"creationDate": "2022-08-11T13:08:02Z",
"lastUpdateDate": "2022-08-11T16:23:32Z",
"chargeId": 284,
"lastConsignmentId": 90
}],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Pasa cargos bancarios a status CANCELLED.
patch /merchants/{merchantId}/banks/charges/cancels
Pasa cargos bancarios a status CANCELLED.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"chargeIds": [1, 2, 23]
}
HTTP status code 204
Se actualiza 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Pasa cargos bancarios a status PAID.
patch /merchants/{merchantId}/banks/charges/pays
Pasa cargos bancarios a status PAID.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"chargeIds": [1, 2, 23]
}
HTTP status code 204
Se actualiza 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Pasa cargos bancarios a status RETURN.
patch /merchants/{merchantId}/banks/charges/returns
Pasa cargos bancarios a status RETURN.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"chargeIds": [1, 2, 23]
}
HTTP status code 204
Se actualiza 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de un cargo bancario.
Actualizar cargo bancario.
get /merchants/{merchantId}/banks/charges/{chargeId}
Obtener detalle de un cargo bancario.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- chargeId: required(integer)
Identificador único del cargo bancario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [{
"merchantId": 80,
"clientId": 179752,
"orderId": 3055,
"orderDate": "2022-08-11",
"amount": 1400,
"status": "RETURN",
"type": "ASSOCIATION",
"name": "Mario Contreras",
"bic": "BICGALXXXX",
"iban": "ES0012255555555555555",
"concept": "Devolución desde la plataforma",
"creationDate": "2022-08-11T13:08:02Z",
"lastUpdateDate": "2022-08-11T16:23:32Z",
"chargeId": 284,
"lastConsignmentId": 90
}],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/banks/charges/{chargeId}
Actualizar cargo bancario.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- chargeId: required(integer)
Identificador único del cargo bancario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"amount": 18000,
"bic": null,
"iban": "BE33138948239023339",
"concept": "Pago ordinario"
}
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [{
"merchantId": 80,
"clientId": 179752,
"orderId": 3055,
"orderDate": "2022-08-11",
"amount": 1400,
"status": "RETURN",
"type": "ASSOCIATION",
"name": "Mario Contreras",
"bic": "BICGALXXXX",
"iban": "ES0012255555555555555",
"concept": "Devolución desde la plataforma",
"creationDate": "2022-08-11T13:08:02Z",
"lastUpdateDate": "2022-08-11T16:23:32Z",
"chargeId": 284,
"lastConsignmentId": 90
}],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener remesas de un cargo bancario.
get /merchants/{merchantId}/banks/charges/{chargeId}/consignments
Obtener remesas de un cargo bancario.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- chargeId: required(integer)
Identificador único del cargo bancario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 2,
"included": null,
"input": "VERBO/recurso",
"result": [{
"chargeId": 16,
"consignmentId": 16,
"status": "PAID",
"creationDate": "2020-08-25T13:00:52Z",
"lastUpdateDate": "2020-08-25T13:02:22Z",
"consignment": {
"merchantId": 71,
"number": 12,
"amount": 5000,
"status": "SENT",
"sentDate": "2020-08-25",
"paymentDate": "2020-08-27",
"creationDate": "2020-08-25T12:59:34Z",
"lastUpdateDate": "2020-08-25T13:01:55Z",
"consignmentId": 16,
"fileUrl": null
}
},
{
"chargeId": 16,
"consignmentId": 15,
"status": "RETURN",
"creationDate": "2020-08-25T12:50:47Z",
"lastUpdateDate": "2020-08-25T12:58:58Z",
"consignment": {
"merchantId": 71,
"number": 11,
"amount": 3900,
"status": "SENT",
"sentDate": "2020-08-25",
"paymentDate": "2020-08-28",
"creationDate": "2020-08-25T12:45:07Z",
"lastUpdateDate": "2020-08-25T12:52:42Z",
"consignmentId": 15,
"fileUrl": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea un autor de blog.
Obtener los autores.
post /merchants/{merchantId}/blogs/authors
Crea un autor de blog.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"firstName": "Nelson",
"lastName": "Avendaño",
"position": "Periodista Deportivo",
"description": "Encargado de todo lo relacionado al deporte en la región",
"storageId": "0328aafc-ebb9-461f-9f6d-83d1762c2fc0"
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 114,
"status": "ACTIVE",
"firstName": "Nelson",
"lastName": "Avendaño",
"position": "Periodista Deportivo",
"description": "Encargado de todo lo relacionado al deporte en la región",
"creationDate": "2022-08-20T22:28:21Z",
"lastUpdateDate": "2022-08-20T22:28:21Z",
"authorId": 20,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/114/blogs/authors/20/images/tony.jpg",
"socials": []
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/blogs/authors
Obtener los autores.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- last: (integer)
Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.
Example:
2
- status: (one of ACTIVE, INACTIVE)
Status.
Example:
ACTIVE
- sortField: (string)
Posibles valores permitidos -> id, firstName, status.
Example:
date
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 114,
"status": "ACTIVE",
"firstName": "Nelson",
"lastName": "Avendaño",
"position": "Periodista Deportivo",
"description": "Encargado de todo lo relacionado al deporte en la región",
"creationDate": "2022-08-20T22:28:21Z",
"lastUpdateDate": "2022-08-20T22:28:21Z",
"authorId": 20,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/114/blogs/authors/20/images/tony.jpg",
"socials": []
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de un autor.
Actualizar un autor.
Borrar un autor.
get /merchants/{merchantId}/blogs/authors/{authorId}
Obtener detalle de un autor.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 114,
"status": "ACTIVE",
"firstName": "Nelson",
"lastName": "Avendaño",
"position": "Periodista Deportivo",
"description": "Encargado de todo lo relacionado al deporte en la región",
"creationDate": "2022-08-20T22:28:21Z",
"lastUpdateDate": "2022-08-20T22:28:21Z",
"authorId": 20,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/114/blogs/authors/20/images/tony.jpg",
"socials": []
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/blogs/authors/{authorId}
Actualizar un autor.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"firstName": "Nelson",
"lastName": "Avendaño",
"position": "Periodista Deportivo",
"description": "Encargado de todo lo relacionado al deporte en la región",
"storageId": "0328aafc-ebb9-461f-9f6d-83d1762c2fc0"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 114,
"status": "ACTIVE",
"firstName": "Nelson",
"lastName": "Avendaño",
"position": "Periodista Deportivo",
"description": "Encargado de todo lo relacionado al deporte en la región",
"creationDate": "2022-08-20T22:28:21Z",
"lastUpdateDate": "2022-08-20T22:28:21Z",
"authorId": 20,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/114/blogs/authors/20/images/tony.jpg",
"socials": []
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/blogs/authors/{authorId}
Borrar un autor.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Borrar imagen del autor.
delete /merchants/{merchantId}/blogs/authors/{authorId}/images
Borrar imagen del autor.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
HTTP status code 200
Se elimina registro correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 114,
"status": "ACTIVE",
"firstName": "Nelson",
"lastName": "Avendaño",
"position": "Periodista Deportivo",
"description": "Encargado de todo lo relacionado al deporte en la región",
"creationDate": "2022-08-20T22:28:21Z",
"lastUpdateDate": "2022-08-20T22:28:21Z",
"authorId": 20,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/114/blogs/authors/20/images/tony.jpg",
"socials": []
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crear red social para autor de blog.
Listar las redes sociales de autor de blog.
post /merchants/{merchantId}/blogs/authors/{authorId}/socials/networks
Crear red social para autor de blog.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"name": "Facebook",
"icon": "fa-facebook",
"url": "https://www.facebook.com",
"iconBackground": "#CCC",
"iconColor": "#EEE",
"theme": "DARK"
}
HTTP status code 201
Se crea el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"status": "ACTIVE",
"icon": "fa-facebook",
"iconBackground": "#CCC",
"iconColor": "#EEE",
"theme": "DARK",
"name": "Facebook",
"url": "https://www.facebook.com",
"creationDate": "2022-08-20T23:23:09Z",
"lastUpdateDate": "2022-08-20T23:23:09Z",
"networkId": 118
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/blogs/authors/{authorId}/socials/networks
Listar las redes sociales de autor de blog.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
Query Parameters
- last: (integer)
Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.
Example:
2
- status: (one of CREATED, ACTIVE, INACTIVE)
Status.
Example:
ACTIVE
HTTP status code 200
Se obtiene el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"status": "ACTIVE",
"icon": "fa-facebook",
"iconBackground": "#CCC",
"iconColor": "#EEE",
"theme": "DARK",
"name": "Facebook",
"url": "https://www.facebook.com",
"creationDate": "2022-08-20T23:23:09Z",
"lastUpdateDate": "2022-08-20T23:23:09Z",
"networkId": 118
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de la red social.
Actualizar red social.
Borrar una red social.
get /merchants/{merchantId}/blogs/authors/{authorId}/socials/networks/{networkId}
Obtener detalle de la red social.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
- networkId: required(integer)
Identificador único de la red social.
HTTP status code 200
Se obtiene el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"status": "ACTIVE",
"icon": "fa-facebook",
"iconBackground": "#CCC",
"iconColor": "#EEE",
"theme": "DARK",
"name": "Facebook",
"url": "https://www.facebook.com",
"creationDate": "2022-08-20T23:23:09Z",
"lastUpdateDate": "2022-08-20T23:23:09Z",
"networkId": 118
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/blogs/authors/{authorId}/socials/networks/{networkId}
Actualizar red social.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
- networkId: required(integer)
Identificador único de la red social.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"name": "Facebook",
"icon": "fa-facebook",
"url": "https://www.facebook.com",
"iconBackground": "#CCC",
"iconColor": "#EEE",
"theme": "DARK"
}
HTTP status code 201
Se crea el recurso de forma correcta y se realiza el envío al correo registrado para la empresa.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"status": "ACTIVE",
"icon": "fa-facebook",
"iconBackground": "#CCC",
"iconColor": "#EEE",
"theme": "DARK",
"name": "Facebook",
"url": "https://www.facebook.com",
"creationDate": "2022-08-20T23:23:09Z",
"lastUpdateDate": "2022-08-20T23:23:09Z",
"networkId": 118
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/blogs/authors/{authorId}/socials/networks/{networkId}
Borrar una red social.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- authorId: required(integer)
Identificador único del autor.
- networkId: required(integer)
Identificador único de la red social.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
HTTP status code 204
Se elimina recurso de manera 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea una categoría de blog.
Obtener las categorías de blog.
post /merchants/{merchantId}/blogs/categories
Crea una categoría de blog.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Nombre interno",
"descriptions": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación"
}
]
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Nombre interno",
"merchantId": "57",
"status": "ACTIVE",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z",
"categoryId": 6,
"descriptions": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z"
}
]
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/blogs/categories
Obtener las categorías de blog.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- last: (integer)
Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.
Example:
2
- countPosts: (boolean)
Cuentas los posts que tiene asociado en el lenguaje enviado o por defecto
es
.Example:
true
- status: (one of ACTIVE, INACTIVE)
Status.
Example:
ACTIVE
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Nombre interno",
"merchantId": "57",
"status": "ACTIVE",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z",
"categoryId": 6,
"descriptions": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z"
}
]
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de una categoría de blog.
Actualizar una categoría.
Borrar una categoría.
get /merchants/{merchantId}/blogs/categories/{categoryId}
Obtener detalle de una categoría de blog.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Nombre interno",
"merchantId": "57",
"status": "ACTIVE",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z",
"categoryId": 6,
"descriptions": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z"
}
]
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/blogs/categories/{categoryId}
Actualizar una categoría.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Nombre interno",
"status": "ACTIVE"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Nombre interno",
"merchantId": "57",
"status": "ACTIVE",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z",
"categoryId": 6,
"descriptions": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación",
"creationDate": "2021-03-16T21:12:52Z",
"lastUpdateDate": "2021-03-16T21:12:52Z"
}
]
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/blogs/categories/{categoryId}
Borrar una categoría.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea una nueva descripción asociada a la categoría.
Se obtienen las descripciones en múltiples idiomas.
post /merchants/{merchantId}/blogs/categories/{categoryId}/descriptions
Crea una nueva descripción asociada a la categoría.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación"
}
HTTP status code 201
Se crea el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación",
"creationDate": "2022-08-21T00:23:19Z",
"lastUpdateDate": "2022-08-21T00:23:19Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/blogs/categories/{categoryId}/descriptions
Se obtienen las descripciones en múltiples idiomas.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación",
"creationDate": "2022-08-21T00:23:19Z",
"lastUpdateDate": "2022-08-21T00:23:19Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Actualizar una descripción dado el idioma.
Eliminar registro en el idioma enviado.
patch /merchants/{merchantId}/blogs/categories/{categoryId}/descriptions/{language}
Actualizar una descripción dado el idioma.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
- language: required(string)
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación"
}
HTTP status code 200
Se crea el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"language": "es",
"slug": "lenguajes-de-programacion",
"name": "Lenguajes de programación",
"description": "Esta categoría va relacionada a los lenguajes de programación",
"creationDate": "2022-08-21T00:23:19Z",
"lastUpdateDate": "2022-08-21T00:23:19Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/blogs/categories/{categoryId}/descriptions/{language}
Eliminar registro en el idioma enviado.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
- language: required(string)
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
HTTP status code 204
Se elimina el 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea un post.
Obtener los posts.
post /merchants/{merchantId}/blogs/posts
Crea un post.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Nombre interno",
"featured": true,
"storageId": "0328aafc-ebb9-461f-9f6d-83d1762c2fc0",
"descriptions": [
{
"language": "es",
"slug": "titulo-del-post",
"title": "Título del post",
"subtitle": "Subtítulo del post",
"shortDescription": "Es la descripción corta",
"largeDescription": "Es la descripción larga donde normalmente van tags HTML"
}
]
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"metatags": [{
"merchantId": 71,
"status": "ACTIVE",
"type": "BLOG",
"typeId": 209,
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T12:11:32Z",
"metatagId": 34472,
"typeName": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"descriptions": [{
"language": "es",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "en",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "gl",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
}
]
}],
"authors": [{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}],
"categories": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04: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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/blogs/posts
Obtener los posts.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- last: (integer)
Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.
Example:
2
- status: (one of ACTIVE, INACTIVE)
Status.
Example:
ACTIVE
- search: (string)
Búsqueda por title.
Example:
bienestar
- authors: (number)
Id del autor o autores separados por coma.
Example:
89
- categories: (number)
Id de la categoría o categorías separados por coma.
Example:
13
- tags: (number)
Id del tag o tags separados por coma.
Example:
56
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"metatags": [{
"merchantId": 71,
"status": "ACTIVE",
"type": "BLOG",
"typeId": 209,
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T12:11:32Z",
"metatagId": 34472,
"typeName": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"descriptions": [{
"language": "es",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "en",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "gl",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
}
]
}],
"authors": [{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}],
"categories": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04: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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de un post.
Actualizar un post.
Borrar un post.
get /merchants/{merchantId}/blogs/posts/{postId}
Obtener detalle de un post.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"metatags": [{
"merchantId": 71,
"status": "ACTIVE",
"type": "BLOG",
"typeId": 209,
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T12:11:32Z",
"metatagId": 34472,
"typeName": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"descriptions": [{
"language": "es",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "en",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "gl",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
}
]
}],
"authors": [{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}],
"categories": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04: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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/blogs/posts/{postId}
Actualizar un post.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"name": "Nombre interno",
"featured": true,
"date": "2020-11-20",
"storageId": "0328aafc-ebb9-461f-9f6d-83d1762c2fc0"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"metatags": [{
"merchantId": 71,
"status": "ACTIVE",
"type": "BLOG",
"typeId": 209,
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T12:11:32Z",
"metatagId": 34472,
"typeName": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"descriptions": [{
"language": "es",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "en",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "gl",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
}
]
}],
"authors": [{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}],
"categories": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04: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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/blogs/posts/{postId}
Borrar un post.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea/actualiza un registro de asociación de un post con un autor.
Borrar un registro de asociación de un post con un autor.
post /merchants/{merchantId}/blogs/posts/{postId}/authors/{authorId}
Crea/actualiza un registro de asociación de un post con un autor.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- authorId: required(integer)
Identificador único del autor.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
HTTP status code 200
Se crea el registro de manera correcta.
Body
Media type: application/json
Type: any
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"metatags": [{
"merchantId": 71,
"status": "ACTIVE",
"type": "BLOG",
"typeId": 209,
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T12:11:32Z",
"metatagId": 34472,
"typeName": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"descriptions": [{
"language": "es",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "en",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "gl",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
}
]
}],
"authors": [{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}],
"categories": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04: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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/blogs/posts/{postId}/authors/{authorId}
Borrar un registro de asociación de un post con un autor.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- authorId: required(integer)
Identificador único del autor.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea/actualiza un registro de asociación de un post con una categoría.
Borrar un registro de asociación de un post con una categoría.
post /merchants/{merchantId}/blogs/posts/{postId}/categories/{categoryId}
Crea/actualiza un registro de asociación de un post con una categoría.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- categoryId: required(integer)
Identificador único de la categoría.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
HTTP status code 200
Se crea el registro de manera correcta.
Body
Media type: application/json
Type: any
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"metatags": [{
"merchantId": 71,
"status": "ACTIVE",
"type": "BLOG",
"typeId": 209,
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T12:11:32Z",
"metatagId": 34472,
"typeName": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"descriptions": [{
"language": "es",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "en",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "gl",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
}
]
}],
"authors": [{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}],
"categories": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04: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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/blogs/posts/{postId}/categories/{categoryId}
Borrar un registro de asociación de un post con una categoría.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- categoryId: required(integer)
Identificador único de la categoría.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea una nueva descripción asociada al post.
Se obtienen las descripciones en múltiples idiomas.
post /merchants/{merchantId}/blogs/posts/{postId}/descriptions
Crea una nueva descripción asociada al post.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"language": "es",
"slug": "titulo-del-post",
"title": "Título del post",
"subtitle": "Subtítulo del post",
"shortDescription": "Es la descripción corta",
"largeDescription": "Es la descripción larga donde normalmente van tags HTML"
}
HTTP status code 201
Se crea el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"metatags": [{
"merchantId": 71,
"status": "ACTIVE",
"type": "BLOG",
"typeId": 209,
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T12:11:32Z",
"metatagId": 34472,
"typeName": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"descriptions": [{
"language": "es",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "en",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "gl",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
}
]
}],
"authors": [{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}],
"categories": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04: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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/blogs/posts/{postId}/descriptions
Se obtienen las descripciones en múltiples idiomas.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04: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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Actualizar una descripción dado el idioma.
Eliminar registro en el idioma enviado.
patch /merchants/{merchantId}/blogs/posts/{postId}/descriptions/{language}
Actualizar una descripción dado el idioma.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- language: required(string)
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
Body
Media type: application/json
Example:
{
"slug": "titulo-del-post",
"title": "Título del post",
"subtitle": "Subtítulo del post",
"shortDescription": "Es la descripción corta",
"largeDescription": "Es la descripción larga donde normalmente van tags HTML"
}
HTTP status code 200
Se crea el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"metatags": [{
"merchantId": 71,
"status": "ACTIVE",
"type": "BLOG",
"typeId": 209,
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T12:11:32Z",
"metatagId": 34472,
"typeName": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"descriptions": [{
"language": "es",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "en",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "gl",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
}
]
}],
"authors": [{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}],
"categories": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04: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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/blogs/posts/{postId}/descriptions/{language}
Eliminar registro en el idioma enviado.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- language: required(string)
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
HTTP status code 204
Se elimina el 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Duplicar post.
post /merchants/{merchantId}/blogs/posts/{postId}/duplicates
Duplicar post.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
HTTP status code 201
Se crea el recurso de forma correcta.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 220,
"status": "CREATED",
"name": "[COPIA] test",
"featured": false,
"date": "2021-02-25",
"creationDate": "2022-07-14T17:56:24Z",
"lastUpdateDate": "2022-07-14T17:56:24Z",
"postId": 68,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/220/posts/68/images/20.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Borrar imagen del autor.
delete /merchants/{merchantId}/blogs/posts/{postId}/images
Borrar imagen del autor.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
HTTP status code 200
Se elimina registro correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"metatags": [{
"merchantId": 71,
"status": "ACTIVE",
"type": "BLOG",
"typeId": 209,
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T12:11:32Z",
"metatagId": 34472,
"typeName": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"descriptions": [{
"language": "es",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "en",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "gl",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
}
]
}],
"authors": [{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}],
"categories": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04: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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea/actualiza un registro de asociación de un post con un tag.
Borrar un registro de asociación de un post con un tag.
post /merchants/{merchantId}/blogs/posts/{postId}/tags/{tagId}
Crea/actualiza un registro de asociación de un post con un tag.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- tagId: required(integer)
Identificador único del tag.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
HTTP status code 200
Se crea el registro de manera correcta.
Body
Media type: application/json
Type: any
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Nombre interno",
"featured": false,
"date": "2021-01-13",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:05:00Z",
"postId": 13,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/71/posts/13/images/surftoo.png",
"metatags": [{
"merchantId": 71,
"status": "ACTIVE",
"type": "BLOG",
"typeId": 209,
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T12:11:32Z",
"metatagId": 34472,
"typeName": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"descriptions": [{
"language": "es",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "en",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
},
{
"language": "gl",
"title": "ESCOLA DE FÚTBOL DENIS SUÁREZ",
"description": "",
"keywords": "ESCOLA,DE,FÚTBOL,DENIS,SUÁREZ",
"creationDate": "2022-08-01T12:11:32Z",
"lastUpdateDate": "2022-08-01T14:27:43Z"
}
]
}],
"authors": [{
"merchantId": 71,
"status": "ACTIVE",
"firstName": "Alonso",
"lastName": "Quijano",
"position": "Escritor",
"description": "Escritor de deportes",
"creationDate": "2021-01-13T12:59:40Z",
"lastUpdateDate": "2021-01-13T12:59:40Z",
"authorId": 5,
"imageUrl": null
}],
"categories": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "Playas",
"creationDate": "2021-01-13T12:25:23Z",
"lastUpdateDate": "2021-01-13T12:25:23Z",
"categoryId": 8
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "Surf",
"creationDate": "2021-01-13T12:24:38Z",
"lastUpdateDate": "2021-01-13T12:24:38Z",
"categoryId": 7
}
],
"tags": [{
"merchantId": 71,
"status": "ACTIVE",
"name": "beach",
"creationDate": "2021-01-13T12:54:54Z",
"lastUpdateDate": "2021-01-13T12:54:54Z",
"tagId": 9
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "competition",
"creationDate": "2021-01-13T12:56:38Z",
"lastUpdateDate": "2021-01-13T12:56:38Z",
"tagId": 12
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "fesurfing",
"creationDate": "2021-01-13T12:53:47Z",
"lastUpdateDate": "2021-01-13T12:53:47Z",
"tagId": 7
},
{
"merchantId": 71,
"status": "ACTIVE",
"name": "sport",
"creationDate": "2021-01-13T12:54:16Z",
"lastUpdateDate": "2021-01-13T12:54:16Z",
"tagId": 8
}
],
"descriptions": [{
"language": "es",
"slug": "el-surf-es-un-deporte",
"title": "El surf es un deporte",
"subtitle": "aprovechando la fuerza de una ola, sobre una tabla.",
"shortDescription": "El surf es un deporte acuático que consiste en realizar amplios giros y maniobras aprovechando la fuerza de una ola, sobre una tabla. Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.",
"largeDescription": "Se tiene constancia de la presencia del surf desde hace más de 500 años en las islas de Polinesia. El explorador inglés James Cook llegó a Hawái en 1778, donde conoció el Bodysurfing (similar a este deporte pero sin tabla) y el Bodyboard.\r\n\r\nPor otro lado en el norte de Perú, los habitantes locales dejaron evidencias que muestran personas practicando dicho deporte. Los huacos son cerámicas preincaicas y en uno de ellos se muestra claramente a un hombre sobre algo similar a un trozo de madera deslizándose sobre las olas.4 Esto sitúa los orígenes de este deporte en América del Sur, pero fueron los polinesios los que siglos más tarde llevaron el gusto por el surf hasta lugares como Hawái.\r\n\r\nTiempo después, las culturas autóctonas fueron reprimidas y el surf cayó en decadencia. Además James Cook fue asesinado por los nativos. Fue entonces en el siglo XX cuando el surf se recuperó y con la llegada de turistas y militares estadounidenses en Hawái y la fama del hawaiano olímpico Duke Kahanamoku, el surf empezó a popularizarse en las costas de California y Australia, extendiéndose luego a otros países.\r\nHuaco chimú representando un caballito de totora.\r\n\r\nEsto ocurrió durante los años 50 y 60. Entonces las tablas se tallaban en madera maciza volviendo al surf una práctica muy sencilla debido a la facilidad de elaborar las tablas. Más tarde fue evolucionando hasta convertirse en un deporte completo. Así fueron creados acrobacias, movimientos, diversos diseños y materiales que permitieran masificar el surf volviéndolo multidisciplinario y polivalente.\r\n\r\nEl surf se popularizó en los años 60 en muchos continentes. Pasando a ser practicado en casi todo el mundo. Entre los destinos más solicitados por los viajeros practicantes están Australia y el Sudeste Asiático. El surf es un deporte importante también en Latinoamérica especialmente Perú, Chile, México o Brasil, con una gran cantidad de playas aptas para este deporte.\r\n\r\nActualmente el surf de competición está basado en:\r\nLa corriente de evolución australiana del estilo (movimientos amplios y enérgicos).\r\nLas influencias de los movimientos del monopatinaje y la tabla sobre nieve.",
"creationDate": "2021-01-13T13:04:59Z",
"lastUpdateDate": "2021-01-13T13:04: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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/blogs/posts/{postId}/tags/{tagId}
Borrar un registro de asociación de un post con un tag.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- postId: required(integer)
Identificador único del post.
- tagId: required(integer)
Identificador único del tag.
Headers
- Application-Token: required(string)
Token de aplicación para poder acceder a los recursos
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea un tag de blog.
Obtener los tags.
post /merchants/{merchantId}/blogs/tags
Crea un tag de blog.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Deportes"
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Deportes",
"merchantId": "71",
"status": "ACTIVE",
"creationDate": "2020-11-20T04:13:36Z",
"lastUpdateDate": "2020-11-20T04:13:36Z",
"tagId": 1
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/blogs/tags
Obtener los tags.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- last: (integer)
Cantidad de registros que se desea recibir. Por defecto trae todos los resultados.
Example:
2
- inUse: (boolean)
Filtrar por las que están en uso en algún post, true para las que si, false para las que no.
Example:
true
- status: (one of ACTIVE, INACTIVE)
Status.
Example:
ACTIVE
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Deportes",
"merchantId": "71",
"status": "ACTIVE",
"creationDate": "2020-11-20T04:13:36Z",
"lastUpdateDate": "2020-11-20T04:13:36Z",
"tagId": 1
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de un tag.
Actualizar un tag.
Borrar un tag.
get /merchants/{merchantId}/blogs/tags/{tagId}
Obtener detalle de un tag.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- tagId: required(integer)
Identificador único del tag.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Deportes",
"merchantId": "71",
"status": "ACTIVE",
"creationDate": "2020-11-20T04:13:36Z",
"lastUpdateDate": "2020-11-20T04:13:36Z",
"tagId": 1
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/blogs/tags/{tagId}
Actualizar un tag.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- tagId: required(integer)
Identificador único del tag.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"name": "Deportes"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"name": "Deportes",
"merchantId": "71",
"status": "ACTIVE",
"creationDate": "2020-11-20T04:13:36Z",
"lastUpdateDate": "2020-11-20T04:13:36Z",
"tagId": 1
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/blogs/tags/{tagId}
Borrar un tag.
Qaroni supports OAuth 2.0 for authenticating all API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- tagId: required(integer)
Identificador único del tag.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea una reserva.
Obtener las reservas.
post /merchants/{merchantId}/bookings
Crea una reserva.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"clientId": 23,
"formId": 154,
"orderId": 16,
"status": "APPROVED",
"startDate": "2022-08-04 14:00:00",
"finishDate": "2022-08-04 16:00:00",
"formJson": "{\"pasatiempo\":\"Futboll\"}",
"observation": "",
"items": [
{
"itemId": 13,
"quantity": 2
},
{
"itemId": 2
},
{
"itemId": 42
},
{
"itemId": 5
}
]
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"clientId": 23,
"formId": 154,
"orderId": 16,
"status": "APPROVED",
"startDate": "2022-08-04 14:00:00",
"finishDate": "2022-08-04 16:00:00",
"formJson": "{\"pasatiempo\":\"Futboll\"}",
"observation": "",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"facilities": [
{
"merchantId": 80,
"facilityId": 50,
"categoryId": 20,
"capacity": 10,
"status": "ACTIVE",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/facilities/50_sala_de_masajes.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"slug": "sala-de-masajes",
"name": "Sala de Masajes",
"shortDescription": "Sala de masajes",
"largeDescription": "Sala de masajes 1"
}
]
}
],
"persons": [
{
"merchantId": 80,
"personId": 58,
"firstName": "Jorge",
"lastName": "Samaniego",
"email": "jiniguez@qaroni.com",
"phone": "+593978766761",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/persons/58_person.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z"
}
],
"resources": [
{
"merchantId": 80,
"resourceId": 58,
"categoryId": 25,
"status": "ACTIVE",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/resources/58_cama_de_masajes.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"slug": "cama-de-masajes",
"name": "Cama de masajes",
"shortDescription": "Cama de masajes",
"largeDescription": "Cama de masajes"
}
]
}
],
"services": [
{
"merchantId": 80,
"serviceId": 50,
"categoryId": 20,
"status": "ACTIVE",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/services/50_masaje.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"slug": "masaje",
"name": "Masaje",
"shortDescription": "masaje",
"largeDescription": "masaje descripción larga"
}
]
}
],
"workspaces": [
{
"merchantId": 80,
"workspaceId": 50,
"code": "ANA-DOLORES",
"name": "Ana Dolores",
"description": "Ana Dolores Descripción",
"email": "jiniguez@qaroni.com",
"phone": "+593 978766763",
"timezone": "UTC/GMT +2 hours",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/workspaces/50_ana_dolores.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"address": {
"line1": "Av Principal Plaza de Toros",
"line2": null,
"postalCode": "15838333",
"country": "ES",
"stateProvince": "Táchira",
"city": "San Cristóbal",
"latitude": "90.21324352",
"longitude": "65.2232352"
}
}
]
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/bookings
Obtener las reservas.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- dateFrom: (string)
Filtrar por fecha en formato Y-m-d (DESDE).
Example:
2022-08-04
- dateTo: (string)
Filtrar por fecha en formato Y-m-d (HASTA).
Example:
2021-08-08
- status: (string)
Filtra las reservas por estado [CREATED, ACTIVE, APPROVED, CANCELLED].
Example:
APPROVED
- sortField: (string)
Posibles valores permitidos -> id, startDate, finishDate, creationDate.
Example:
creationDate
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
- userId: (array)
Filtro de usuario, cuando se aplique este filtro ya no estará disponible el de "personIds".
Example:
9
- personIds: (array)
Filtro de Personas.
Example:
9
- serviceIds: (array)
Filtro de servicios.
Example:
9
- workspaceIds: (array)
Filtro de espacios de trabajo.
Example:
9
- facilityIds: (array)
Filtro de Salas.
Example:
9
- resourceIds: (array)
Filtro de recursos.
Example:
9
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"clientId": 23,
"formId": 154,
"orderId": 16,
"status": "APPROVED",
"startDate": "2022-08-04 14:00:00",
"finishDate": "2022-08-04 16:00:00",
"formJson": "{\"pasatiempo\":\"Futboll\"}",
"observation": "",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z"
}
],
"links": {
"total": 2,
"first": "http://localhost:8000/v1/merchants/80/bookings?page=1",
"last": "http://localhost:8000/v1/merchants/80/bookings?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de una reserva.
Actualizar una reserva.
Borrar una reserva.
get /merchants/{merchantId}/bookings/{bookingId}
Obtener detalle de una reserva.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- bookingId: required(integer)
Identificador único de la reserva.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"clientId": 23,
"formId": 154,
"orderId": 16,
"status": "APPROVED",
"startDate": "2022-08-04 14:00:00",
"finishDate": "2022-08-04 16:00:00",
"formJson": "{\"pasatiempo\":\"Futboll\"}",
"observation": "",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"facilities": [
{
"merchantId": 80,
"facilityId": 50,
"categoryId": 20,
"capacity": 10,
"status": "ACTIVE",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/facilities/50_sala_de_masajes.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"slug": "sala-de-masajes",
"name": "Sala de Masajes",
"shortDescription": "Sala de masajes",
"largeDescription": "Sala de masajes 1"
}
]
}
],
"persons": [
{
"merchantId": 80,
"personId": 58,
"firstName": "Jorge",
"lastName": "Samaniego",
"email": "jiniguez@qaroni.com",
"phone": "+593978766761",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/persons/58_person.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z"
}
],
"resources": [
{
"merchantId": 80,
"resourceId": 58,
"categoryId": 25,
"status": "ACTIVE",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/resources/58_cama_de_masajes.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"slug": "cama-de-masajes",
"name": "Cama de masajes",
"shortDescription": "Cama de masajes",
"largeDescription": "Cama de masajes"
}
]
}
],
"services": [
{
"merchantId": 80,
"serviceId": 50,
"categoryId": 20,
"status": "ACTIVE",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/services/50_masaje.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"slug": "masaje",
"name": "Masaje",
"shortDescription": "masaje",
"largeDescription": "masaje descripción larga"
}
]
}
],
"workspaces": [
{
"merchantId": 80,
"workspaceId": 50,
"code": "ANA-DOLORES",
"name": "Ana Dolores",
"description": "Ana Dolores Descripción",
"email": "jiniguez@qaroni.com",
"phone": "+593 978766763",
"timezone": "UTC/GMT +2 hours",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/workspaces/50_ana_dolores.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"address": {
"line1": "Av Principal Plaza de Toros",
"line2": null,
"postalCode": "15838333",
"country": "ES",
"stateProvince": "Táchira",
"city": "San Cristóbal",
"latitude": "90.21324352",
"longitude": "65.2232352"
}
}
]
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/bookings/{bookingId}
Actualizar una reserva.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- bookingId: required(integer)
Identificador único de la reserva.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"clientId": 23,
"formId": 154,
"orderId": 16,
"status": "APPROVED",
"startDate": "2022-08-04 14:00:00",
"finishDate": "2022-08-04 16:00:00",
"formJson": "{\"pasatiempo\":\"Futboll\"}",
"observation": "",
"items": [
{
"itemId": 13,
"quantity": 2
},
{
"itemId": 2
},
{
"itemId": 42
},
{
"itemId": 5
}
]
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"clientId": 23,
"formId": 154,
"orderId": 16,
"status": "APPROVED",
"startDate": "2022-08-04 14:00:00",
"finishDate": "2022-08-04 16:00:00",
"formJson": "{\"pasatiempo\":\"Futboll\"}",
"observation": "",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"facilities": [
{
"merchantId": 80,
"facilityId": 50,
"categoryId": 20,
"capacity": 10,
"status": "ACTIVE",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/facilities/50_sala_de_masajes.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"slug": "sala-de-masajes",
"name": "Sala de Masajes",
"shortDescription": "Sala de masajes",
"largeDescription": "Sala de masajes 1"
}
]
}
],
"persons": [
{
"merchantId": 80,
"personId": 58,
"firstName": "Jorge",
"lastName": "Samaniego",
"email": "jiniguez@qaroni.com",
"phone": "+593978766761",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/persons/58_person.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z"
}
],
"resources": [
{
"merchantId": 80,
"resourceId": 58,
"categoryId": 25,
"status": "ACTIVE",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/resources/58_cama_de_masajes.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"slug": "cama-de-masajes",
"name": "Cama de masajes",
"shortDescription": "Cama de masajes",
"largeDescription": "Cama de masajes"
}
]
}
],
"services": [
{
"merchantId": 80,
"serviceId": 50,
"categoryId": 20,
"status": "ACTIVE",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/services/50_masaje.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"slug": "masaje",
"name": "Masaje",
"shortDescription": "masaje",
"largeDescription": "masaje descripción larga"
}
]
}
],
"workspaces": [
{
"merchantId": 80,
"workspaceId": 50,
"code": "ANA-DOLORES",
"name": "Ana Dolores",
"description": "Ana Dolores Descripción",
"email": "jiniguez@qaroni.com",
"phone": "+593 978766763",
"timezone": "UTC/GMT +2 hours",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/workspaces/50_ana_dolores.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"address": {
"line1": "Av Principal Plaza de Toros",
"line2": null,
"postalCode": "15838333",
"country": "ES",
"stateProvince": "Táchira",
"city": "San Cristóbal",
"latitude": "90.21324352",
"longitude": "65.2232352"
}
}
]
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/bookings/{bookingId}
Borrar una reserva.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- bookingId: required(integer)
Identificador único de la reserva.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Valida la disponibilidad de la reserva y genera una orden con el valor que va a cancelar.
post /merchants/{merchantId}/bookings/{bookingId}/confirmations
Valida la disponibilidad de la reserva y genera una orden con el valor que va a cancelar.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- bookingId: required(integer)
Identificador único de la reserva.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se ha confirmado exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Verifica si es posible eliminar la reserva, y si se necesita un valor para la cancelación generará una orden.
post /merchants/{merchantId}/bookings/{bookingId}/cancellations
Verifica si es posible eliminar la reserva, y si se necesita un valor para la cancelación generará una orden.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- bookingId: required(integer)
Identificador único de la reserva.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se ha cancelado exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Verifica si es posible reagendar, y si se necesita un valor para la reagendación generará una orden.
post /merchants/{merchantId}/bookings/{bookingId}/reschedules
Verifica si es posible reagendar, y si se necesita un valor para la reagendación generará una orden.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- bookingId: required(integer)
Identificador único de la reserva.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se ha confirmado exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea una categoría.
Obtener las categorías.
post /merchants/{merchantId}/bookings/categories
Crea una categoría.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"name": "Masaje",
"descriptions": [
{
"language": "es",
"name": "Masaje"
}
]
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"categoryId": 25,
"status": "ACTIVE",
"name": "Masaje",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"name": "Masaje"
}
]
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/bookings/categories
Obtener las categorías.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- search: (string)
Búsqueda por name.
Example:
Masaje
- status: (string)
Filtra los recursos por estado.
Example:
ACTIVE
- sortField: (string)
Posibles valores permitidos -> id, name, creationDate.
Example:
creationDate
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"categoryId": 25,
"status": "ACTIVE",
"name": "Masaje",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"name": "Masaje"
}
]
}
],
"links": {
"total": 1,
"first": "http://localhost:8000/v1/merchants/80/bookings/categories?page=1",
"last": "http://localhost:8000/v1/merchants/80/bookings/categories?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de una categoría.
Actualizar una categoría.
Borrar una categoría.
get /merchants/{merchantId}/bookings/categories/{categoryId}
Obtener detalle de una categoría.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"categoryId": 25,
"status": "ACTIVE",
"name": "Masaje",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"name": "Masaje"
}
]
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/bookings/categories/{categoryId}
Actualizar una categoría.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"name": "Masaje",
"descriptions": [
{
"language": "es",
"name": "Masaje"
}
]
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"categoryId": 25,
"status": "ACTIVE",
"name": "Masaje",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"name": "Masaje"
}
]
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/bookings/categories/{categoryId}
Borrar una categoría.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Listar las descripciones de la categoría.
Añade una nueva descripción/actualiza si ya existe el idioma.
get /merchants/{merchantId}/bookings/categories/{categoryId}/descriptions
Listar las descripciones de la categoría.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtienen el listado de las descripciones del recurso.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"language": "es",
"name": "Masajes"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
post /merchants/{merchantId}/bookings/categories/{categoryId}/descriptions
Añade una nueva descripción/actualiza si ya existe el idioma.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"language": "es",
"name": "Masaje"
}
HTTP status code 201
Se crea el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"language": "es",
"name": "Masajes"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Actualiza un descripción.
Borrar un registro.
patch /merchants/{merchantId}/bookings/categories/{categoryId}/descriptions/{language}
Actualiza un descripción.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
- language: required(string)
Identificador único de la descripción de la categoría.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"language": "es",
"name": "Masaje"
}
HTTP status code 201
Se crea el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"language": "es",
"name": "Masajes"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/bookings/categories/{categoryId}/descriptions/{language}
Borrar un registro.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- categoryId: required(integer)
Identificador único de la categoría.
- language: required(string)
Identificador único de la descripción de la categoría.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea una configuración de reserva.
Obtener las configuraciones para reservas.
post /merchants/{merchantId}/bookings/configurations
Crea una configuración de reserva.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"formId": 1,
"smtpConfigId": 25,
"isOnline": true,
"isUniquePerson": true,
"isUniqueService": true,
"isUniqueResource": true,
"isUniqueWorkspace": true,
"maxCapacity": 1,
"hasApproval": true,
"amount": 15.95,
"minAmount": 7.80,
"cancellationAmount": true,
"reshedulingAmount": true,
"onlineCancellation": true,
"onlineResheduling": true,
"startDate": "2022-08-03",
"finishDate": null,
"duration": 30,
"durationType": "MINUTE",
"storageId": "5696a131-de58-46bd-bdbf-8d051ef65f31",
"status": "ACTIVE",
"iva": 0.00,
"name": "Nombre interno de la configuración"
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/resource",
"result": [
{
"merchantId": 119,
"formId": null,
"smtpConfigId": null,
"templateId": null,
"status": "ACTIVE",
"name": "Estiramiento Muscular",
"isOnline": 1,
"isUniquePerson": 1,
"isUniqueService": 1,
"isUniqueResource": 1,
"isUniqueWorkspace": 1,
"maxCapacity": 1,
"hasApproval": 0,
"amount": 0,
"iva": "0.00",
"minAmount": 0,
"cancellationAmount": 0,
"reschedulingAmount": 0,
"onlineCancellation": 0,
"onlineRescheduling": 0,
"startDate": "2022-11-16 00:00:00",
"finishDate": "2023-10-14 00:00:00",
"duration": 30,
"durationType": "MINUTE",
"creationDate": "2022-11-18T19:45:30Z",
"lastUpdateDate": "2022-11-18T19:47:51Z",
"configId": 22,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modules/merchant/119/bookings/configs/22_descarga%282%29.jpeg",
"templateUUID": null,
"items": [
{
"merchantId": 119,
"configId": 22,
"typeId": 9,
"type": "SERVICE",
"color": "#fafbaf",
"stock": null,
"creationDate": "2022-12-01T19:46:05Z",
"lastUpdateDate": "2022-12-01T19:46:05Z",
"itemId": 68,
"typeName": "Servicio de Estiramiento Muscular Básico"
}
],
"form": null,
"store_config": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/bookings/configurations
Obtener las configuraciones para reservas.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- dateFrom: (string)
Filtrar por fecha en formato Y-m-d H:i:s (DESDE).
Example:
2022-08-04 10:30:00
- dateTo: (string)
Filtrar por fecha en formato Y-m-d H:i:s (HASTA).
Example:
2021-08-08 23:59:59
- status: (string)
Filtra los recursos por estado.
Example:
ACTIVE
- sortField: (string)
Posibles valores permitidos -> id, startDate, finishDate, isOnline, creationDate.
Example:
creationDate
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 2,
"included": null,
"input": "VERBO/resource",
"result": [
{
"merchantId": 119,
"formId": null,
"smtpConfigId": null,
"templateId": null,
"status": "ACTIVE",
"name": "Estiramiento Muscular",
"isOnline": 1,
"isUniquePerson": 1,
"isUniqueService": 1,
"isUniqueResource": 1,
"isUniqueWorkspace": 1,
"maxCapacity": 1,
"hasApproval": 0,
"amount": 0,
"iva": "0.00",
"minAmount": 0,
"cancellationAmount": 0,
"reschedulingAmount": 0,
"onlineCancellation": 0,
"onlineRescheduling": 0,
"startDate": "2022-11-16 00:00:00",
"finishDate": "2023-10-14 00:00:00",
"duration": 30,
"durationType": "MINUTE",
"creationDate": "2022-11-18T19:45:30Z",
"lastUpdateDate": "2022-11-18T19:47:51Z",
"configId": 22,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modules/merchant/119/bookings/configs/22_descarga%282%29.jpeg",
"templateUUID": null,
"items": [
{
"merchantId": 119,
"configId": 22,
"typeId": 9,
"type": "SERVICE",
"color": "#fafbaf",
"stock": null,
"creationDate": "2022-12-01T19:46:05Z",
"lastUpdateDate": "2022-12-01T19:46:05Z",
"itemId": 68,
"typeName": "Servicio de Estiramiento Muscular Básico"
}
],
"form": null,
"store_config": null
},
{
"merchantId": 119,
"formId": 104,
"smtpConfigId": null,
"templateId": null,
"status": "ACTIVE",
"name": "Masaje Completo",
"isOnline": 1,
"isUniquePerson": 1,
"isUniqueService": 1,
"isUniqueResource": 1,
"isUniqueWorkspace": 1,
"maxCapacity": 2,
"hasApproval": 1,
"amount": 150,
"iva": "12.00",
"minAmount": 5,
"cancellationAmount": 12,
"reschedulingAmount": 23,
"onlineCancellation": 1,
"onlineRescheduling": 1,
"startDate": "2022-11-16 00:00:00",
"finishDate": null,
"duration": 30,
"durationType": "MINUTE",
"creationDate": "2022-11-17T17:06:06Z",
"lastUpdateDate": "2022-11-18T16:02:42Z",
"configId": 21,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modules/merchant/119/bookings/configs/21_descarga%281%29.jpeg",
"templateUUID": null,
"items": [
{
"merchantId": 119,
"configId": 21,
"typeId": 9,
"type": "SERVICE",
"color": "#faf",
"stock": null,
"creationDate": "2022-11-21T18:10:57Z",
"lastUpdateDate": "2022-11-21T18:10:57Z",
"itemId": 55,
"typeName": "Servicio de Estiramiento Muscular Básico"
},
{
"merchantId": 119,
"configId": 21,
"typeId": 10,
"type": "SERVICE",
"color": "#aaa",
"stock": null,
"creationDate": "2022-11-21T18:10:57Z",
"lastUpdateDate": "2022-11-21T18:10:57Z",
"itemId": 59,
"typeName": "Masajes de Pies"
},
{
"merchantId": 119,
"configId": 21,
"typeId": 21,
"type": "RESOURCE",
"color": "#fafafa",
"stock": 15,
"creationDate": "2022-11-28T18:10:28Z",
"lastUpdateDate": "2022-11-28T18:10:28Z",
"itemId": 60,
"typeName": "Crema de Masaje"
},
{
"merchantId": 119,
"configId": 21,
"typeId": 22,
"type": "RESOURCE",
"color": "#ffffff",
"stock": 1,
"creationDate": "2022-11-28T18:15:05Z",
"lastUpdateDate": "2022-11-28T18:15:05Z",
"itemId": 61,
"typeName": "Toalla"
},
{
"merchantId": 119,
"configId": 21,
"typeId": 23,
"type": "RESOURCE",
"color": "#000",
"stock": 2,
"creationDate": "2022-11-28T18:34:35Z",
"lastUpdateDate": "2022-11-28T18:34:35Z",
"itemId": 62,
"typeName": "Champu Johnson baby"
},
{
"merchantId": 119,
"configId": 21,
"typeId": 19,
"type": "WORKSPACE",
"color": "#000",
"stock": null,
"creationDate": "2022-11-28T19:24:06Z",
"lastUpdateDate": "2022-11-28T19:24:06Z",
"itemId": 63,
"typeName": "ANA"
},
{
"merchantId": 119,
"configId": 21,
"typeId": 10,
"type": "PERSON",
"color": "#fafbaf",
"stock": null,
"creationDate": "2022-11-29T14:43:24Z",
"lastUpdateDate": "2022-11-29T14:43:24Z",
"itemId": 64,
"typeName": "Espinoza Perez Juan Arnold"
},
{
"merchantId": 119,
"configId": 21,
"typeId": 9,
"type": "FACILITY",
"color": "#fafbaf",
"stock": null,
"creationDate": "2022-11-29T14:44:07Z",
"lastUpdateDate": "2022-11-29T14:44:07Z",
"itemId": 65,
"typeName": "Sala de masajes 1"
},
{
"merchantId": 119,
"configId": 21,
"typeId": 10,
"type": "FACILITY",
"color": "#fafbaf",
"stock": null,
"creationDate": "2022-11-29T14:44:11Z",
"lastUpdateDate": "2022-11-29T14:44:11Z",
"itemId": 66,
"typeName": "Sala de masajes 2"
},
{
"merchantId": 119,
"configId": 21,
"typeId": 11,
"type": "FACILITY",
"color": "#fafbaf",
"stock": null,
"creationDate": "2022-11-29T14:44:13Z",
"lastUpdateDate": "2022-11-29T14:44:13Z",
"itemId": 67,
"typeName": "Sala de masajes 3"
},
{
"merchantId": 119,
"configId": 21,
"typeId": 11,
"type": "PERSON",
"color": "#fafbaf",
"stock": null,
"creationDate": "2022-11-29T14:43:24Z",
"lastUpdateDate": "2022-11-29T14:43:24Z",
"itemId": 69,
"typeName": "Samaniego Jorge"
}
],
"form": {
"name": "Formulario 3 campos",
"creationDate": "",
"lastUpdateDate": "",
"formId": 104
},
"store_config": null
}
],
"links": {
"total": 2,
"first": "http://localhost:8000/v1/merchants/119/bookings/configurations?page=1",
"last": "http://localhost:8000/v1/merchants/119/bookings/configurations?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de una configuración.
Actualizar una configuración.
Borrar una configuración.
get /merchants/{merchantId}/bookings/configurations/{configurationId}
Obtener detalle de una configuración.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/resource",
"result": [
{
"merchantId": 119,
"formId": null,
"smtpConfigId": null,
"templateId": null,
"status": "ACTIVE",
"name": "Estiramiento Muscular",
"isOnline": 1,
"isUniquePerson": 1,
"isUniqueService": 1,
"isUniqueResource": 1,
"isUniqueWorkspace": 1,
"maxCapacity": 1,
"hasApproval": 0,
"amount": 0,
"iva": "0.00",
"minAmount": 0,
"cancellationAmount": 0,
"reschedulingAmount": 0,
"onlineCancellation": 0,
"onlineRescheduling": 0,
"startDate": "2022-11-16 00:00:00",
"finishDate": "2023-10-14 00:00:00",
"duration": 30,
"durationType": "MINUTE",
"creationDate": "2022-11-18T19:45:30Z",
"lastUpdateDate": "2022-11-18T19:47:51Z",
"configId": 22,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modules/merchant/119/bookings/configs/22_descarga%282%29.jpeg",
"templateUUID": null,
"items": [
{
"merchantId": 119,
"configId": 22,
"typeId": 9,
"type": "SERVICE",
"color": "#fafbaf",
"stock": null,
"creationDate": "2022-12-01T19:46:05Z",
"lastUpdateDate": "2022-12-01T19:46:05Z",
"itemId": 68,
"typeName": "Servicio de Estiramiento Muscular Básico"
}
],
"form": null,
"store_config": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/bookings/configurations/{configurationId}
Actualizar una configuración.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"formId": 1,
"smtpConfigId": 25,
"isOnline": true,
"isUniquePerson": true,
"isUniqueService": true,
"isUniqueResource": true,
"isUniqueWorkspace": true,
"maxCapacity": 1,
"hasApproval": true,
"amount": 15.95,
"minAmount": 7.80,
"cancellationAmount": true,
"reshedulingAmount": true,
"onlineCancellation": true,
"onlineResheduling": true,
"startDate": "2022-08-03",
"finishDate": null,
"duration": 30,
"durationType": "MINUTE",
"storageId": "5696a131-de58-46bd-bdbf-8d051ef65f31",
"status": "ACTIVE",
"iva": 0.00,
"name": "Nombre interno de la configuración"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/resource",
"result": [
{
"merchantId": 119,
"formId": null,
"smtpConfigId": null,
"templateId": null,
"status": "ACTIVE",
"name": "Estiramiento Muscular",
"isOnline": 1,
"isUniquePerson": 1,
"isUniqueService": 1,
"isUniqueResource": 1,
"isUniqueWorkspace": 1,
"maxCapacity": 1,
"hasApproval": 0,
"amount": 0,
"iva": "0.00",
"minAmount": 0,
"cancellationAmount": 0,
"reschedulingAmount": 0,
"onlineCancellation": 0,
"onlineRescheduling": 0,
"startDate": "2022-11-16 00:00:00",
"finishDate": "2023-10-14 00:00:00",
"duration": 30,
"durationType": "MINUTE",
"creationDate": "2022-11-18T19:45:30Z",
"lastUpdateDate": "2022-11-18T19:47:51Z",
"configId": 22,
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modules/merchant/119/bookings/configs/22_descarga%282%29.jpeg",
"templateUUID": null,
"items": [
{
"merchantId": 119,
"configId": 22,
"typeId": 9,
"type": "SERVICE",
"color": "#fafbaf",
"stock": null,
"creationDate": "2022-12-01T19:46:05Z",
"lastUpdateDate": "2022-12-01T19:46:05Z",
"itemId": 68,
"typeName": "Servicio de Estiramiento Muscular Básico"
}
],
"form": null,
"store_config": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/bookings/configurations/{configurationId}
Borrar una configuración.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea una configuración de comunicaciones de reserva.
Obtener las configuraciones de comunicaciones para reservas.
post /merchants/{merchantId}/bookings/configurations/{configurationId}/communications
Crea una configuración de comunicaciones de reserva.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"templateId": 1,
"advanceTime": 60,
"subject": "texto de asunto",
"body": "texto de cuerpo del correo",
"type": "REMINDER",
"status": "ACTIVE"
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"configurationId": 58,
"communicationId": 5,
"templateId": 1,
"advanceTime": "60",
"subject": "Envío del recordatorio de la reserva",
"body": "Hola, {{firstName}}. <br> Le recordamos que tiene una cita pendiente para las 18:30 en 1 hora aproximadamente. Gracias.",
"type": "REMINDER",
"status": "ACTIVE",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/bookings/configurations/{configurationId}/communications
Obtener las configuraciones de comunicaciones para reservas.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- status: (string)
Filtra los recursos por estado.
Example:
ACTIVE
- sortField: (string)
Posibles valores permitidos -> id, creationDate.
Example:
creationDate
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"configurationId": 58,
"communicationId": 5,
"templateId": 1,
"advanceTime": "60",
"subject": "Envío del recordatorio de la reserva",
"body": "Hola, {{firstName}}. <br> Le recordamos que tiene una cita pendiente para las 18:30 en 1 hora aproximadamente. Gracias.",
"type": "REMINDER",
"status": "ACTIVE",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z"
}
],
"links": {
"total": 1,
"first": "http://localhost:8000/v1/merchants/80/bookings/configurations/58/communications?page=1",
"last": "http://localhost:8000/v1/merchants/80/bookings/configurations/58/communications?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
/merchants/{merchantId}/bookings/configurations/{configurationId}/communications/{communicationId} get patch delete
Obtener detalle de la configuración de comunicación.
Actualizar la configuración de comunicación.
Borrar la configuración de comunicación.
get /merchants/{merchantId}/bookings/configurations/{configurationId}/communications/{communicationId}
Obtener detalle de la configuración de comunicación.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
- communicationId: required(integer)
Identificador único de la configuración de comunicaciones.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"configurationId": 58,
"communicationId": 5,
"templateId": 1,
"advanceTime": "60",
"subject": "Envío del recordatorio de la reserva",
"body": "Hola, {{firstName}}. <br> Le recordamos que tiene una cita pendiente para las 18:30 en 1 hora aproximadamente. Gracias.",
"type": "REMINDER",
"status": "ACTIVE",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/bookings/configurations/{configurationId}/communications/{communicationId}
Actualizar la configuración de comunicación.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
- communicationId: required(integer)
Identificador único de la configuración de comunicaciones.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"templateId": 1,
"advanceTime": 60,
"subject": "texto de asunto",
"body": "texto de cuerpo del correo",
"type": "REMINDER",
"status": "ACTIVE"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"configurationId": 58,
"communicationId": 5,
"templateId": 1,
"advanceTime": "60",
"subject": "Envío del recordatorio de la reserva",
"body": "Hola, {{firstName}}. <br> Le recordamos que tiene una cita pendiente para las 18:30 en 1 hora aproximadamente. Gracias.",
"type": "REMINDER",
"status": "ACTIVE",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/bookings/configurations/{configurationId}/communications/{communicationId}
Borrar la configuración de comunicación.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
- communicationId: required(integer)
Identificador único de la configuración de comunicaciones.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/bookings/configurations/{configurationId}/slots
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- 200: required(string)
Se obtiene el recurso exitosamente.
- 400: required(string)
La solicitud contiene algún error sintáctico. Se usará para todos los errores “gramaticales” en las peticiones.
- dateFrom: required(string)
Fecha inicial en formato Y-m-d.
Example:
2022-08-04
- dateTo: required(string)
Fecha de finalización en formato Y-m-d.
Example:
2022-08-10
- workspaceIds: (string)
Filtro por espacios de trabajo
Example:
1,3,4
- personIds: required(Filtro por persona description)
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Borrar imagen.
delete /merchants/{merchantId}/bookings/configurations/{configurationId}/images
Borrar imagen.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina la imagen exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea un item para la configuración de reserva.
Obtener los items para configuraciones para reservas.
post /merchants/{merchantId}/bookings/configurations/{configurationId}/items
Crea un item para la configuración de reserva.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"type": "RESOURCE",
"typeId": 21,
"color": "#A521D1",
"stock": 5
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"configurationId": 58,
"type": "CONFIGURATION",
"typeId": 21,
"color": "#A521D1",
"stock": 5,
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/bookings/configurations/{configurationId}/items
Obtener los items para configuraciones para reservas.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- sortField: (string)
Posibles valores permitidos -> id, type, color, creationDate.
Example:
creationDate
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"configurationId": 58,
"type": "CONFIGURATION",
"typeId": 21,
"color": "#A521D1",
"stock": 5,
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z"
}
],
"links": {
"total": 1,
"first": "http://localhost:8000/v1/merchants/80/bookings/configurations/58/items?page=1",
"last": "http://localhost:8000/v1/merchants/80/bookings/configurations/58/items?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle del item de la configuración.
Actualizar el item de la configuración.
Borrar un item de la configuración.
get /merchants/{merchantId}/bookings/configurations/{configurationId}/items/{itemId}
Obtener detalle del item de la configuración.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
- itemId: required(integer)
Identificador único del item de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"configurationId": 58,
"type": "CONFIGURATION",
"typeId": 21,
"color": "#A521D1",
"stock": 5,
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/bookings/configurations/{configurationId}/items/{itemId}
Actualizar el item de la configuración.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
- itemId: required(integer)
Identificador único del item de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"type": "RESOURCE",
"typeId": 21,
"color": "#A521D1",
"stock": 5
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"configurationId": 58,
"type": "CONFIGURATION",
"typeId": 21,
"color": "#A521D1",
"stock": 5,
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/bookings/configurations/{configurationId}/items/{itemId}
Borrar un item de la configuración.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
- itemId: required(integer)
Identificador único del item de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea un horario para la configuración de reserva.
Obtener los horarios del recurso.
post /merchants/{merchantId}/bookings/configurations/{configurationId}/schedules
Crea un horario para la configuración de reserva.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"typeId": 15,
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00"
}
HTTP status code 200
Se crea el horario del recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"scheduleId": 12,
"status": "ACTIVE",
"type": "CONFIGURATION",
"typeId": 15,
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/bookings/configurations/{configurationId}/schedules
Obtener los horarios del recurso.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- status: (string)
Filtra los recursos por estado ('ACTIVE', 'INACTIVE').
Example:
ACTIVE
- sortField: (string)
Posibles valores permitidos -> id, weekDay, creationDate.
Example:
creationDate
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
- weekDay: (string)
Filtro por día de la semana "weekDay" -> "MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY".
Example:
MONDAY
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 4,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"scheduleId": 2,
"status": "ACTIVE",
"type": "CONFIGURATION",
"typeId": 15,
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
/merchants/{merchantId}/bookings/configurations/{configurationId}/schedules/{scheduleId} get patch delete
Obtener detalle del horario.
Actualizar el horario.
Borrar el horario.
get /merchants/{merchantId}/bookings/configurations/{configurationId}/schedules/{scheduleId}
Obtener detalle del horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
- scheduleId: required(integer)
Identificador único del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el horario exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"scheduleId": 12,
"status": "ACTIVE",
"type": "CONFIGURATION",
"typeId": 15,
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/bookings/configurations/{configurationId}/schedules/{scheduleId}
Actualizar el horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
- scheduleId: required(integer)
Identificador único del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"typeId": 15,
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"scheduleId": 12,
"status": "ACTIVE",
"type": "CONFIGURATION",
"typeId": 15,
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/bookings/configurations/{configurationId}/schedules/{scheduleId}
Borrar el horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
- scheduleId: required(integer)
Identificador único del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina el horario exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea una excepción para el horario.
Obtener las excepciones de horario.
post /merchants/{merchantId}/bookings/configurations/{configurationId}/schedules/exceptions
Crea una excepción para el horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"typeId": 15,
"startDate": "2022-08-02",
"finishDate": "2022-08-10",
"startTime": "00:00",
"finishTime": "23:59"
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"exceptionId": 2,
"status": "ACTIVE",
"type": "CONFIGURATION",
"typeId": 15,
"startDate": "2022-08-02",
"finishDate": "2022-08-02",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/bookings/configurations/{configurationId}/schedules/exceptions
Obtener las excepciones de horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- status: (string)
Filtra los recursos por estado ('ACTIVE', 'INACTIVE').
Example:
ACTIVE
- sortField: (string)
Posibles valores permitidos -> id, startDate, finishDate, creationDate.
Example:
creationDate
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 4,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"exceptionId": 2,
"status": "ACTIVE",
"type": "CONFIGURATION",
"typeId": 20,
"startDate": "2022-08-02",
"finishDate": "2022-08-02",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
},
{
"merchantId": 50,
"exceptionId": 3,
"status": "ACTIVE",
"type": "CONFIGURATION",
"typeId": 20,
"startDate": "2022-08-05",
"finishDate": "2022-08-10",
"startTime": "00:00",
"finishTime": "23:59",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
},
{
"merchantId": 50,
"exceptionId": 4,
"status": "ACTIVE",
"type": "CONFIGURATION",
"typeId": 20,
"startDate": "2022-08-15",
"finishDate": "2022-08-15",
"startTime": "00:00",
"finishTime": "23:59",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
},
{
"merchantId": 50,
"exceptionId": 5,
"status": "ACTIVE",
"type": "CONFIGURATION",
"typeId": 20,
"startDate": "2022-08-02",
"finishDate": "2022-08-02",
"startTime": "00:00",
"finishTime": "23:59",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"links": {
"total": 4,
"first": "http://localhost:8000/v1/merchants/50/bookings/configurations/20/schedules/exceptions?page=1",
"last": "http://localhost:8000/v1/merchants/50/bookings/configurations/20/schedules/exceptions?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
/merchants/{merchantId}/bookings/configurations/{configurationId}/schedules/exceptions/{exceptionId} get patch delete
Obtener detalle de la excepción del horario.
Actualizar la excepción del horario.
Borrar la excepción del horario.
get /merchants/{merchantId}/bookings/configurations/{configurationId}/schedules/exceptions/{exceptionId}
Obtener detalle de la excepción del horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
- exceptionId: required(integer)
Identificador único de la excepción del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"exceptionId": 2,
"status": "ACTIVE",
"type": "CONFIGURATION",
"typeId": 15,
"startDate": "2022-08-02",
"finishDate": "2022-08-02",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/bookings/configurations/{configurationId}/schedules/exceptions/{exceptionId}
Actualizar la excepción del horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
- exceptionId: required(integer)
Identificador único de la excepción del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"typeId": 15,
"startDate": "2022-08-02",
"finishDate": "2022-08-10",
"startTime": "00:00",
"finishTime": "23:59"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"exceptionId": 2,
"status": "ACTIVE",
"type": "CONFIGURATION",
"typeId": 15,
"startDate": "2022-08-02",
"finishDate": "2022-08-02",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/bookings/configurations/{configurationId}/schedules/exceptions/{exceptionId}
Borrar la excepción del horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- configurationId: required(integer)
Identificador único de la configuración.
- exceptionId: required(integer)
Identificador único de la excepción del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina el recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea una instalación/sala para reserva.
Obtener las instalaciones/salas para reservas.
post /merchants/{merchantId}/bookings/facilities
Crea una instalación/sala para reserva.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"categoryId": 12,
"capacity": 10,
"storageId": "5696a131-de58-46bd-bdbf-8d051ef65f31",
"descriptions": [
{
"language": "es",
"name": "Sala de Masaje",
"shortDescription": "Sala de masajes",
"largeDescription": "Sala de masajes 1"
}
]
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"facilityId": 50,
"categoryId": 20,
"capacity": 10,
"status": "ACTIVE",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/facilities/50_sala_de_masajes.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"slug": "sala-de-masajes",
"name": "Sala de Masajes",
"shortDescription": "Sala de masajes",
"largeDescription": "Sala de masajes 1"
}
]
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/bookings/facilities
Obtener las instalaciones/salas para reservas.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- search: (string)
Búsqueda por name.
Example:
Sala de Masajes
- status: (string)
Filtra los recursos por estado.
Example:
ACTIVE
- sortField: (string)
Posibles valores permitidos -> id, name, categoryId, creationDate.
Example:
creationDate
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
- categoryId: (string)
Filtro por categoryId, se puede añadir "7" ó "7,3,5".
Example:
7,3
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"facilityId": 50,
"categoryId": 20,
"capacity": 10,
"status": "ACTIVE",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/facilities/50_sala_de_masajes.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"slug": "sala-de-masajes",
"name": "Sala de Masajes",
"shortDescription": "Sala de masajes",
"largeDescription": "Sala de masajes 1"
}
]
}
],
"links": {
"total": 1,
"first": "http://localhost:8000/v1/merchants/80/bookings/facilities?page=1",
"last": "http://localhost:8000/v1/merchants/80/bookings/facilities?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de una instalación/sala.
Actualizar una instalación/sala.
Borrar una instalación/sala.
get /merchants/{merchantId}/bookings/facilities/{facilityId}
Obtener detalle de una instalación/sala.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"facilityId": 50,
"categoryId": 20,
"capacity": 10,
"status": "ACTIVE",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/facilities/50_sala_de_masajes.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"slug": "sala-de-masajes",
"name": "Sala de Masajes",
"shortDescription": "Sala de masajes",
"largeDescription": "Sala de masajes 1"
}
]
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/bookings/facilities/{facilityId}
Actualizar una instalación/sala.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"categoryId": 12,
"capacity": 10,
"storageId": "5696a131-de58-46bd-bdbf-8d051ef65f31",
"descriptions": [
{
"language": "es",
"name": "Sala de Masaje",
"shortDescription": "Sala de masajes",
"largeDescription": "Sala de masajes 1"
}
]
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 80,
"facilityId": 50,
"categoryId": 20,
"capacity": 10,
"status": "ACTIVE",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/plaam.dev/modulos/merchant/80/bookings/facilities/50_sala_de_masajes.jpg",
"creationDate": "2022-02-04T21:10:54Z",
"lastUpdateDate": "2022-02-04T21:10:54Z",
"descriptions": [
{
"language": "es",
"slug": "sala-de-masajes",
"name": "Sala de Masajes",
"shortDescription": "Sala de masajes",
"largeDescription": "Sala de masajes 1"
}
]
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/bookings/facilities/{facilityId}
Borrar una instalación/sala.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Listar las descripciones de la instalación/sala.
Añade una nueva descripción/actualiza si ya existe el idioma.
get /merchants/{merchantId}/bookings/facilities/{facilityId}/descriptions
Listar las descripciones de la instalación/sala.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtienen el listado de las descripciones del recurso.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"language": "es",
"slug": "sala-de-masajes",
"name": "Sala de Masajes",
"shortDescription": "Sala de Masajes 1",
"largeDescription": "Sala de Masajes 1"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
post /merchants/{merchantId}/bookings/facilities/{facilityId}/descriptions
Añade una nueva descripción/actualiza si ya existe el idioma.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"language": "es",
"name": "Sala de Masajes",
"shortDescription": "Sala de Masajes 1",
"largeDescription": "Sala de Masajes 1"
}
HTTP status code 201
Se crea el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 2,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"language": "es",
"slug": "sala-de-masajes",
"name": "Sala de Masajes",
"shortDescription": "Sala de Masajes 1",
"largeDescription": "Sala de Masajes 1"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Actualiza un descripción.
Borrar un registro.
patch /merchants/{merchantId}/bookings/facilities/{facilityId}/descriptions/{language}
Actualiza un descripción.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
- language: required(string)
Identificador único de la descripción de un recurso.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"language": "es",
"name": "Sala de Masajes",
"shortDescription": "Sala de Masajes 1",
"largeDescription": "Sala de Masajes 1"
}
HTTP status code 201
Se crea el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 2,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"language": "es",
"slug": "sala-de-masajes",
"name": "Sala de Masajes",
"shortDescription": "Sala de Masajes 1",
"largeDescription": "Sala de Masajes 1"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/bookings/facilities/{facilityId}/descriptions/{language}
Borrar un registro.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
- language: required(string)
Identificador único de la descripción de un recurso.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Borrar imagen.
delete /merchants/{merchantId}/bookings/facilities/{facilityId}/images
Borrar imagen.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina la imagen exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea un horario para la instalación/sala de reserva.
Obtener los horarios del recurso.
post /merchants/{merchantId}/bookings/facilities/{facilityId}/schedules
Crea un horario para la instalación/sala de reserva.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00"
}
HTTP status code 200
Se crea el horario del recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"scheduleId": 12,
"status": "ACTIVE",
"type": "FACILITY",
"typeId": 15,
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/bookings/facilities/{facilityId}/schedules
Obtener los horarios del recurso.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- status: (string)
Filtra los recursos por estado ('ACTIVE', 'INACTIVE').
Example:
ACTIVE
- sortField: (string)
Posibles valores permitidos -> id, weekDay, creationDate.
Example:
creationDate
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
- weekDay: (string)
Filtro por día de la semana "weekDay" -> "MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY".
Example:
MONDAY
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 4,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"scheduleId": 2,
"status": "ACTIVE",
"type": "FACILITY",
"typeId": 15,
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
},
{
"merchantId": 50,
"scheduleId": 3,
"status": "ACTIVE",
"type": "FACILITY",
"typeId": 15,
"weekDay": "MONDAY",
"startTime": "15:00",
"finishTime": "19:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
},
{
"merchantId": 50,
"scheduleId": 4,
"status": "ACTIVE",
"type": "FACILITY",
"typeId": 15,
"weekDay": "TUESDAY",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
},
{
"merchantId": 50,
"scheduleId": 5,
"status": "ACTIVE",
"type": "FACILITY",
"typeId": 15,
"weekDay": "TUESDAY",
"startTime": "15:00",
"finishTime": "19:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"links": {
"total": 4,
"first": "http://localhost:8000/v1/merchants/50/bookings/facilities/15/schedules?page=1",
"last": "http://localhost:8000/v1/merchants/50/bookings/facilities/15/schedules?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle del horario.
Actualizar el horario.
Borrar el horario.
get /merchants/{merchantId}/bookings/facilities/{facilityId}/schedules/{scheduleId}
Obtener detalle del horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
- scheduleId: required(integer)
Identificador único del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el horario exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"scheduleId": 12,
"status": "ACTIVE",
"type": "FACILITY",
"typeId": 15,
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/bookings/facilities/{facilityId}/schedules/{scheduleId}
Actualizar el horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
- scheduleId: required(integer)
Identificador único del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"scheduleId": 12,
"status": "ACTIVE",
"type": "FACILITY",
"typeId": 15,
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/bookings/facilities/{facilityId}/schedules/{scheduleId}
Borrar el horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
- scheduleId: required(integer)
Identificador único del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina el horario exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea una excepción para el horario.
Obtener las excepciones de horario.
post /merchants/{merchantId}/bookings/facilities/{facilityId}/schedules/exceptions
Crea una excepción para el horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"startDate": "2022-08-02",
"finishDate": "2022-08-10",
"startTime": "00:00",
"finishTime": "23:59"
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"exceptionId": 2,
"status": "ACTIVE",
"type": "FACILITY",
"typeId": 15,
"startDate": "2022-08-02",
"finishDate": "2022-08-02",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/bookings/facilities/{facilityId}/schedules/exceptions
Obtener las excepciones de horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- status: (string)
Filtra los recursos por estado ('ACTIVE', 'INACTIVE').
Example:
ACTIVE
- sortField: (string)
Posibles valores permitidos -> id, startDate, finishDate, creationDate.
Example:
creationDate
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 4,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"exceptionId": 2,
"status": "ACTIVE",
"type": "FACILITY",
"typeId": 20,
"startDate": "2022-08-02",
"finishDate": "2022-08-02",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
},
{
"merchantId": 50,
"exceptionId": 3,
"status": "ACTIVE",
"type": "FACILITY",
"typeId": 20,
"startDate": "2022-08-05",
"finishDate": "2022-08-10",
"startTime": "00:00",
"finishTime": "23:59",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
},
{
"merchantId": 50,
"exceptionId": 4,
"status": "ACTIVE",
"type": "FACILITY",
"typeId": 20,
"startDate": "2022-08-15",
"finishDate": "2022-08-15",
"startTime": "00:00",
"finishTime": "23:59",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
},
{
"merchantId": 50,
"exceptionId": 5,
"status": "ACTIVE",
"type": "FACILITY",
"typeId": 20,
"startDate": "2022-08-02",
"finishDate": "2022-08-02",
"startTime": "00:00",
"finishTime": "23:59",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"links": {
"total": 4,
"first": "http://localhost:8000/v1/merchants/50/bookings/facilities/20/schedules/exceptions?page=1",
"last": "http://localhost:8000/v1/merchants/50/bookings/facilities/20/schedules/exceptions?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
/merchants/{merchantId}/bookings/facilities/{facilityId}/schedules/exceptions/{exceptionId} get patch delete
Obtener detalle de la excepción del horario.
Actualizar la excepción del horario.
Borrar la excepción del horario.
get /merchants/{merchantId}/bookings/facilities/{facilityId}/schedules/exceptions/{exceptionId}
Obtener detalle de la excepción del horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
- exceptionId: required(integer)
Identificador único de la excepción del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"exceptionId": 2,
"status": "ACTIVE",
"type": "FACILITY",
"typeId": 15,
"startDate": "2022-08-02",
"finishDate": "2022-08-02",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/bookings/facilities/{facilityId}/schedules/exceptions/{exceptionId}
Actualizar la excepción del horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
- exceptionId: required(integer)
Identificador único de la excepción del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"startDate": "2022-08-02",
"finishDate": "2022-08-10",
"startTime": "00:00",
"finishTime": "23:59"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"exceptionId": 2,
"status": "ACTIVE",
"type": "FACILITY",
"typeId": 15,
"startDate": "2022-08-02",
"finishDate": "2022-08-02",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/bookings/facilities/{facilityId}/schedules/exceptions/{exceptionId}
Borrar la excepción del horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- facilityId: required(integer)
Identificador único de la instalación/Sala.
- exceptionId: required(integer)
Identificador único de la excepción del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina el recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea una persona.
Obtener listado de las personas.
post /merchants/{merchantId}/bookings/persons
Crea una persona.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"userId": 17253,
"firstName": "Pepe",
"lastName": "Pacheco",
"storageId": "5696a131-de58-46bd-bdbf-8d051ef65f31",
"phone": "+593978766761",
"email": "jiniguez@qaroni.com"
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/resource",
"result": [
{
"merchantId": 227,
"userId": 17486,
"userType": "PLATFORM",
"status": "ACTIVE",
"firstName": "Pablo",
"lastName": "Senande",
"phone": "981928655",
"email": "psenande@plaam.com",
"creationDate": "2022-10-28T11:20:20Z",
"lastUpdateDate": "2022-10-28T11:21:11Z",
"personId": 8,
"imageUrl": null,
"user": {
"userId": 17486,
"merchantId": 227,
"addressId": null,
"clientId": null,
"language": "es",
"username": "Mendez Eduardo",
"status": "ACTIVE",
"imageUrl": null,
"hasSetPassword": 1,
"otp": null,
"email_verified_at": null,
"creationDate": null,
"lastUpdateDate": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/bookings/persons
Obtener listado de las personas.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- search: (string)
Búsqueda por firstName, lastName, email.
Example:
Pepe
- userId: (string)
filtro por userId (tabla usuario).
Example:
1,2,3,4
- sortField: (string)
Posibles valores permitidos -> id, firstName, creationDate.
Example:
creationDate
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 3,
"included": null,
"input": "GET/merchants/{merchantId}/bookings/persons",
"result": [
{
"merchantId": 119,
"userId": null,
"userType": "PLATFORM",
"status": "ACTIVE",
"firstName": "Juan Arnold",
"lastName": "Espinoza Perez",
"phone": "(+593) 978766765",
"email": "jiniguez@qaroni.com",
"creationDate": "2023-02-06T17:49:54Z",
"lastUpdateDate": "2023-02-06T17:49:54Z",
"personId": 12,
"imageUrl": null
},
{
"merchantId": 119,
"userId": null,
"userType": "PLATFORM",
"status": "ACTIVE",
"firstName": "Jorge",
"lastName": "Samaniego",
"phone": "(+593) 978766765",
"email": "jiniguez@qaroni.com",
"creationDate": "2022-11-29T14:42:38Z",
"lastUpdateDate": "2022-11-29T14:42:38Z",
"personId": 11,
"imageUrl": null
},
{
"merchantId": 119,
"userId": null,
"userType": "PLATFORM",
"status": "ACTIVE",
"firstName": "Juan Arnold",
"lastName": "Espinoza Perez",
"phone": "(+593) 978766765",
"email": "jiniguez@qaroni.com",
"creationDate": "2022-11-29T14:42:38Z",
"lastUpdateDate": "2022-11-29T14:42:38Z",
"personId": 10,
"imageUrl": null
}
],
"links": {
"total": 3,
"first": "http://localhost:8000/v1/merchants/119/bookings/persons?page=1",
"last": "http://localhost:8000/v1/merchants/119/bookings/persons?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle de la persona.
Actualizar una persona.
Borrar una persona.
get /merchants/{merchantId}/bookings/persons/{personId}
Obtener detalle de la persona.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- personId: required(integer)
Identificador único de la persona.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/resource",
"result": [
{
"merchantId": 227,
"userId": 17486,
"userType": "PLATFORM",
"status": "ACTIVE",
"firstName": "Pablo",
"lastName": "Senande",
"phone": "981928655",
"email": "psenande@plaam.com",
"creationDate": "2022-10-28T11:20:20Z",
"lastUpdateDate": "2022-10-28T11:21:11Z",
"personId": 8,
"imageUrl": null,
"user": {
"userId": 17486,
"merchantId": 227,
"addressId": null,
"clientId": null,
"language": "es",
"username": "Mendez Eduardo",
"status": "ACTIVE",
"imageUrl": null,
"hasSetPassword": 1,
"otp": null,
"email_verified_at": null,
"creationDate": null,
"lastUpdateDate": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/bookings/persons/{personId}
Actualizar una persona.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- personId: required(integer)
Identificador único de la persona.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"userId": 17253,
"firstName": "Pepe",
"lastName": "Pacheco",
"storageId": "5696a131-de58-46bd-bdbf-8d051ef65f31",
"phone": "+593978766761",
"email": "jiniguez@qaroni.com"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/resource",
"result": [
{
"merchantId": 227,
"userId": 17486,
"userType": "PLATFORM",
"status": "ACTIVE",
"firstName": "Pablo",
"lastName": "Senande",
"phone": "981928655",
"email": "psenande@plaam.com",
"creationDate": "2022-10-28T11:20:20Z",
"lastUpdateDate": "2022-10-28T11:21:11Z",
"personId": 8,
"imageUrl": null,
"user": {
"userId": 17486,
"merchantId": 227,
"addressId": null,
"clientId": null,
"language": "es",
"username": "Mendez Eduardo",
"status": "ACTIVE",
"imageUrl": null,
"hasSetPassword": 1,
"otp": null,
"email_verified_at": null,
"creationDate": null,
"lastUpdateDate": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/bookings/persons/{personId}
Borrar una persona.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- personId: required(integer)
Identificador único de la persona.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina recurso exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Borrar imagen.
delete /merchants/{merchantId}/bookings/persons/{personId}/images
Borrar imagen.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- personId: required(integer)
Identificador único de la persona.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina la imagen exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea un horario.
Obtener los horarios del recurso.
post /merchants/{merchantId}/bookings/persons/{personId}/schedules
Crea un horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- personId: required(integer)
Identificador único de la persona.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00"
}
HTTP status code 200
Se crea el horario del recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"scheduleId": 12,
"status": "ACTIVE",
"type": "PERSON",
"typeId": 15,
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/bookings/persons/{personId}/schedules
Obtener los horarios del recurso.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- personId: required(integer)
Identificador único de la persona.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- status: (string)
Filtra los recursos por estado ('ACTIVE', 'INACTIVE').
Example:
ACTIVE
- sortField: (string)
Posibles valores permitidos -> id, weekDay, creationDate.
Example:
creationDate
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
- weekDay: (string)
Filtro por día de la semana "weekDay" -> "MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY".
Example:
MONDAY
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
Can not resolve examples/bookingPersonSchedulesResponse.json
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Obtener detalle del horario.
Actualizar el horario.
Borrar el horario.
get /merchants/{merchantId}/bookings/persons/{personId}/schedules/{scheduleId}
Obtener detalle del horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- personId: required(integer)
Identificador único de la persona.
- scheduleId: required(integer)
Identificador único del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el horario exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"scheduleId": 12,
"status": "ACTIVE",
"type": "PERSON",
"typeId": 15,
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/bookings/persons/{personId}/schedules/{scheduleId}
Actualizar el horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- personId: required(integer)
Identificador único de la persona.
- scheduleId: required(integer)
Identificador único del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"scheduleId": 12,
"status": "ACTIVE",
"type": "PERSON",
"typeId": 15,
"weekDay": "MONDAY",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
delete /merchants/{merchantId}/bookings/persons/{personId}/schedules/{scheduleId}
Borrar el horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- personId: required(integer)
Identificador único de la persona.
- scheduleId: required(integer)
Identificador único del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 204
Se elimina el horario exitosamente.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Crea una excepción para el horario.
Obtener las excepciones de horario.
post /merchants/{merchantId}/bookings/persons/{personId}/schedules/exceptions
Crea una excepción para el horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- personId: required(integer)
Identificador único de la persona.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"startDate": "2022-08-02",
"finishDate": "2022-08-10",
"startTime": "00:00",
"finishTime": "23:59"
}
HTTP status code 200
Se crea el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"exceptionId": 2,
"status": "ACTIVE",
"type": "PERSON",
"typeId": 15,
"startDate": "2022-08-02",
"finishDate": "2022-08-02",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
get /merchants/{merchantId}/bookings/persons/{personId}/schedules/exceptions
Obtener las excepciones de horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- personId: required(integer)
Identificador único de la persona.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Query Parameters
- page: (integer)
Activa la paginación, ubica la página enviada.
Example:
1
- pagination: (integer)
Cantidad de registros a paginar, por defecto son 60.
Example:
10
- status: (string)
Filtra los recursos por estado ('ACTIVE', 'INACTIVE').
Example:
ACTIVE
- sortField: (string)
Posibles valores permitidos -> id, startDate, finishDate, creationDate.
Example:
creationDate
- sortDirection: (string)
Dirección de ordenamiento de resultados, posibles valores ASC o DESC.
Example:
ASC
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 4,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"exceptionId": 2,
"status": "ACTIVE",
"type": "PERSON",
"typeId": 20,
"startDate": "2022-08-02",
"finishDate": "2022-08-02",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
},
{
"merchantId": 50,
"exceptionId": 3,
"status": "ACTIVE",
"type": "PERSON",
"typeId": 20,
"startDate": "2022-08-05",
"finishDate": "2022-08-10",
"startTime": "00:00",
"finishTime": "23:59",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
},
{
"merchantId": 50,
"exceptionId": 4,
"status": "ACTIVE",
"type": "PERSON",
"typeId": 20,
"startDate": "2022-08-15",
"finishDate": "2022-08-15",
"startTime": "00:00",
"finishTime": "23:59",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
},
{
"merchantId": 50,
"exceptionId": 5,
"status": "ACTIVE",
"type": "PERSON",
"typeId": 20,
"startDate": "2022-08-02",
"finishDate": "2022-08-02",
"startTime": "00:00",
"finishTime": "23:59",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"links": {
"total": 4,
"first": "http://localhost:8000/v1/merchants/50/bookings/persons/20/schedules/exceptions?page=1",
"last": "http://localhost:8000/v1/merchants/50/bookings/persons/20/schedules/exceptions?page=1",
"prev": null,
"next": 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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
/merchants/{merchantId}/bookings/persons/{personId}/schedules/exceptions/{exceptionId} get patch delete
Obtener detalle de la excepción del horario.
Actualizar la excepción del horario.
Borrar la excepción del horario.
get /merchants/{merchantId}/bookings/persons/{personId}/schedules/exceptions/{exceptionId}
Obtener detalle de la excepción del horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- personId: required(integer)
Identificador único de la persona.
- exceptionId: required(integer)
Identificador único de la excepción del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
HTTP status code 200
Se obtiene el recurso exitosamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"exceptionId": 2,
"status": "ACTIVE",
"type": "PERSON",
"typeId": 15,
"startDate": "2022-08-02",
"finishDate": "2022-08-02",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
patch /merchants/{merchantId}/bookings/persons/{personId}/schedules/exceptions/{exceptionId}
Actualizar la excepción del horario.
Application-Token for API requests.
URI Parameters
- merchantId: required(integer)
Identificador único de la empresa.
- personId: required(integer)
Identificador único de la persona.
- exceptionId: required(integer)
Identificador único de la excepción del horario.
Headers
- Authorization: required(string)
Bearer Token de Oauth generado por Laravel Passport
- Content-type: required(string)
JSON
Body
Media type: application/json
Example:
{
"status": "ACTIVE",
"startDate": "2022-08-02",
"finishDate": "2022-08-10",
"startTime": "00:00",
"finishTime": "23:59"
}
HTTP status code 200
Se obtiene el recurso correctamente.
Body
Media type: application/json
Example:
{
"count": 1,
"included": null,
"input": "VERBO/recurso",
"result": [
{
"merchantId": 50,
"exceptionId": 2,
"status": "ACTIVE",
"type": "PERSON",
"typeId": 15,
"startDate": "2022-08-02",
"finishDate": "2022-08-02",
"startTime": "08:00",
"finishTime": "12:00",
"creationDate": "2022-08-02T10:22:01Z",
"lastUpdateDate": "2022-08-02T10:22:01Z"
}
],
"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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}
Secured by appToken
Headers
- Application-Token
Token de aplicación para poder acceder a los recursos.
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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.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": "El campo es obligatorio",
"source": {
"pointer": "VERBO/recurso",
"parameter": ""
},
"links": {
"about": "https://plaam.docs.plaam.com/"
}
}
]
}