API: GET /appointments/{appointmentId}

Obtiene el detalle de una cita en específico.

GET

/appointments/{appointmentId}

Al llamado de este recurso se deben obtener datos relacionados a la cita de acuerdo al valor proporcionado a través del parámetro(path).

Parámetros

organizationId

REQUERIDO

(header)

Identificador único de la agencia, taller o inventario de la cual se quiere obtener la información.

appointmentId

REQUERIDO

(header)

Identificador único de la cita.

639503

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": "Ingresada",
    "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": false,
    "socialName": null,
    "comments": null,
    "preOrderId": null,
    "orderTypeId": "1",
    "orderType": "MANTENIMIENTO",
    "serviceType": "20000 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*

{

description:	Representa la cita que cumpla con los criterios proporcionados en cualquiera de los parámetros
appointmentId*	string Identificador único de la cita
orderId*	string Identificador único de la orden relacionada a la cita
status*	string example: PENDING, ARRIVE, NO_SHOW, NO_SETTLED Estado en el que se encuentra la cita
clientId*	string Identificador único del cliente relacionado a la cita
firstName*	string Nombre del cliente
lastName*	string Apellido del cliente
address*	string Dirección del cliente
mainPhone*	string Número telefónico del cliente
secondaryPhone	string Número alternativo del cliente
mobile*	string Número celular del cliente
email*	string Correo electrónico del cliente
serviceAdvisorId*	string Identificador único del Asesor de Servicio relacionado a la cita
vin*	string Número de Identificación del Vehículo relacionado a la cita
licensePlate*	string Placas del vehículo relacionado a la cita
brand*	string Marca del vehículo relacionado a la cita
model*	string Modelo del vehículo relacionado a la cita
year*	string Año del vehículo relacionado a la cita
date*	string($date-time) pattern: yyyy-MM-ddThh:mm:ss.000Z Fecha y hora de la cita
promisedDate*	string($date-time) pattern: yyyy-MM-ddThh:mm:ss.000Z Fecha y hora promesa de entrega del vehículo
confirmed*	boolean Indica si la cita esta confirmada o no
socialName	string Razón social del cliente
comments	string Observaciones de la cita o información adicional del vehículo, distintos comentarios deben ir separados por comas.
preOrderId	string Identificador único de la pre orden relacionado a la cita, si y solo si la agencia maneja pre ordenes
orderTypeId	string Identificador único del tipo de orden relacionado a la cita
orderType*	string Tipo de orden relacionado a la cita
serviceType*	string Tipo de servicio relacionado a la cita
isService*	boolean Valor que indica si la cita esta relacionada a un trabajo de tipo servicio
isRepair*	boolean Valor que indica si la cita esta relacionada a un trabajo de tipo reparación
isDiagnostic*	boolean Valor que indica si la cita esta relacionada a un trabajo de tipo diagnóstico
mainType*	string example: service, repair, diagnostic Valor que indica cuál es el trabajo principal que se le hará al vehículo.
secondType	string example: service, repair, diagnostic Valor que indica cuál es el trabajo secundario que se le hará al vehículo.
thirdType	string example: service, repair, diagnostic Valor que indica cuál es el trabajo terciario que se le hará al vehículo.
appointmentsPersonId*	string example: 167 Identificador único de la persona que agendó la cita.

}

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. string]

}

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. string]

}

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. string]

}

Recepción de vehículos

Cotizaciones

Facturación

API: GET /appointments/{appointmentId}

Obtiene el detalle de una cita en específico.

GET

/appointments/{appointmentId}

(header)

Identificador único de la agencia, taller o inventario de la cual se quiere obtener la información.

(header)

Identificador único de la cita.

Solicitud completada de forma satisfactoria.

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.

No se encontró una coincidencia con los parámetros de búsqueda.

Error de servidor interno, se recomienda proporcionar más detalle a través del atributo “mensaje”.

Compañía

Productos

Uso de información