Al llamado de este recurso se deben obtener datos relacionados a la(s) cita(s) de acuerdo a los valores proporcionados a través de los parámetros de la llamada.
Obtiene el listado de la(s) cita(s)
GET
/appointments
Parámetros
organizationId
REQUERIDO
(header)
Identificador único de la agencia, taller o inventario de la cual se quiere obtener la información.
16
dateFrom
REQUERIDO
(query)
Fecha de inicio que se usará para filtrar la información.
2021-09-22
dateTo
REQUERIDO
(query)
Fecha de fin que se usará para filtrar la información.
2021-09-22
arrived
REQUERIDO
(query)
(query)
Estatus de las citas u Órdenes de Reparación que hace referencia a si el cliente ya se presentó o no a la agencia o taller. Si no se incluye, se devuelven todas las citas u Órdenes de Reparación.
true
Cuerpo de solicitud
Sin datos
Respuestas
Code 200
Solicitud completada de forma satisfactoria.
- Ejemplo
- Esquema
{
"success": true,
"message": null,
"data": [
{
"appointmentId": "639503",
"orderId": null,
"status": "Pending",
"clientId": "738949",
"firstName": "Ricardo",
"lastName": "Gamboa Torres",
"address": "Av de los Insurgente 6400, Colonia del Valle, CDMX, CP 03100",
"mainPhone": "5534456006",
"secondaryPhone": null,
"mobile": "5584982090",
"email": "rgamboatorres@gmail.com",
"serviceAdvisorId": "28494",
"vin": "3KPC24B54KE019325",
"licensePlate": "UHN5647",
"brand": "Honda",
"model": "Accord",
"year": "2019",
"date": "2021-09-21T12:30:00.000Z",
"promisedDate": null,
"confirmed": true,
"socialName": null,
"comments": "Cliente pide descuento en servicio",
"preOrderId": null,
"orderTypeId": "1",
"orderType": "MANTENIMIENTO",
"serviceType": "20000 km",
"isService": true,
"isRepair": false,
"isDiagnostic": false,
"mainType": "Service",
"secondType": null,
"thirdType": null,
"appointmentPersonId": "014"
},
{
"appointmentId": "639123",
"orderId": null,
"status": "No Show",
"clientId": "918239",
"firstName": "Carlos",
"lastName": "Estrada García",
"address": "Av de los Laureles 1234, Colonia del Valle, CDMX, CP 03110",
"mainPhone": "5533982928",
"secondaryPhone": null,
"mobile": "5533982928",
"email": "carlosega@gmail.com",
"serviceAdvisorId": "124",
"vin": "3KPC24BPO91819325",
"licensePlate": "UMN1982",
"brand": "Honda",
"model": "CR-V",
"year": "2018",
"date": "2021-09-21T12:00:00.000Z",
"promisedDate": null,
"confirmed": false,
"socialName": null,
"comments": null,
"preOrderId": null,
"orderTypeId": "1",
"orderType": "DIAGNÓSTICO",
"serviceType": "Revisión de Frenos",
"isService": false,
"isRepair": false,
"isDiagnostic": true,
"mainType": "diagnostic",
"secondType": null,
"thirdType": null,
"appointmentPersonId": "011"
},
{
"appointmentId": "640010",
"orderId": null,
"status": "Arrive",
"clientId": "8726182",
"firstName": "Angel",
"lastName": "Viveros Ruiz",
"address": "Av Central 8172, Colonia del Prado, CDMX, CP 03100",
"mainPhone": "3388117722",
"secondaryPhone": null,
"mobile": "3388117722",
"email": "angelviruz@gmail.com",
"serviceAdvisorId": "124",
"vin": "3KPC24BPO918MKSJAS",
"licensePlate": "JKV9019",
"brand": "Honda",
"model": "Civic",
"year": "2020",
"date": "2021-09-21T11:30:00.000Z",
"promisedDate": null,
"confirmed": true,
"socialName": null,
"comments": null,
"preOrderId": null,
"orderTypeId": "1",
"orderType": "MANTENIMIENTO",
"serviceType": "10000 km",
"isService": true,
"isRepair": false,
"isDiagnostic": false,
"mainType": "service",
"secondType": null,
"thirdType": null,
"appointmentPersonId": "014"
}
]
}
{
}
| success* | boolean Valor que indica que el llamado al recurso fue exitoso. / Field that tells if a request was successful. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| message* | string nullable: true Proporciona una pequeña descripción cuando ocurre un error al llamado del recurso, por lo regular el valor de este parametro es nulo si no ocurre algún error. / Error message description, can be null if it was a successful request. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| data* | [ Representa el conjunto de citas que cumplan con los criterios proporcionados en cualquiera de los parámetros
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Code 400
Error de solicitud incorrecta, se recomienda proporcionar más detalle a través del atributo “mensaje”, indicando si faltan parámetros para realizar la búsqueda.
- Ejemplo
- Esquema
{
"success": false,
"message": "El servidor no puede entender la solicitud debido a un error de sintaxis del lado del cliente, faltan los parámetros: xxxxx, yyyyy, zzzzz. / There is a client side syntax error. The following paramters are missing: xxxxx, yyyyy, zzzzz.",
"data": []
}
{
}
| success* | boolean Valor que indica que el llamado al recurso no fue exitoso. / Field that tells if the request was successful. |
| message* | string Proporciona una pequeña descripción del error que hubo al momento de la ejecución del recurso. / Provides an error description. |
| data* | [ minItems: 0 maxItems: 0 Arreglo que no contiene datos debido a que hubo un error al momento de la ejecución del recurso. / Empty array due to a failed request. |
Code 404
No se encontró una coincidencia con los parámetros de búsqueda.
- Ejemplo
- Esquema
{
"success": false,
"message": "No se encontraron datos que cumplan con los criterios proporcionados a través de los parámetros. / There was no match for the resource you're looking for.",
"data": []
}
{
}
| success* | boolean Valor que indica que el llamado al recurso no fue exitoso. / Field that tells if the request was successful. |
| message* | string Proporciona una pequeña descripción del error que hubo al momento de la ejecución del recurso. / Provides an error description. |
| data* | [ minItems: 0 maxItems: 0 Arreglo que no contiene datos debido a que hubo un error al momento de la ejecución del recurso. / Empty array due to a failed request. |
Code 500
Error de servidor interno, se recomienda proporcionar más detalle a través del atributo “mensaje”.
- Ejemplo
- Esquema
{
"success": false,
"message": "El servidor se ha encontrado con una situación que no sabe cómo manejar, intentelo más tarde. / The server can't handle your request at the moment, please try again later.",
"data": []
}
{
}
| success* | boolean Valor que indica que el llamado al recurso no fue exitoso. / Field that tells if the request was successful. |
| message* | string Proporciona una pequeña descripción del error que hubo al momento de la ejecución del recurso. / Provides an error description. |
| data* | [ minItems: 0 maxItems: 0 Arreglo que no contiene datos debido a que hubo un error al momento de la ejecución del recurso. / Empty array due to a failed request. |