BranchRating

Calificación que un Client otorga a una Branch tras completar una Order. La puntuación se agrega también a nivel de BranchGroup. rate va de 1 a 5; comment es opcional. Un cliente solo puede editar su calificación mientras no tenga comentario.

Estructura de Datos

Atributo Tipo Descripción
id int
rate int Puntuación de 1 a 5
comment string\|null Comentario opcional de la calificación
created_at datetime\|null
updated_at datetime\|null
order_id int {@link Order} de la que surge la calificación
client_id int\|null {@link Client} que califica
branch_id int\|null {@link Branch} calificada
branch_group_id int\|null {@link BranchGroup} de la sucursal calificada
company_id int {@link Company} de la calificación (oculto)
allLogs ApiLog>
branch Branch\|null {@link Branch} calificada
branchGroup BranchGroup\|null {@link BranchGroup} de la sucursal calificada
client Client\|null {@link Client} que califica
logs ApiLog>
order Order {@link Order} de la que surge la calificación
rated Branch\|null Entidad calificada (la {@link Branch}) 
{
    "id": 1,
    "rate": 4,
    "comment": "De-ma-sia-do bueno!",
    "created_at": "2020-11-27 14:14:57",
    "updated_at": "2020-11-27 14:14:57",
    "order_id": 3845,
    "client_id": 74,
    "branch_id": 42,
    "branch_group_id": 36
}

Endpoints

Insertar BranchRating

Insertar BranchRating de Order

Calificar la sucursal de una orden

Crea una BranchRating para la Branch de la Order, que debe estar completada y no cancelada. Un cliente solo puede calificar sus propias órdenes.

Método URI Cabeceras
POST /companies/{companyId}/orders/{orderId}/branch-ratings Authorization 
{
    "rate": "required|integer|min:1|max:5",
    "comment": "string|max:255"
}

Listar BranchRating

Listar BranchRating de Client

{info} Soporta: Paginación Filters Carga dinámica

Listar calificaciones de sucursal hechas por un cliente

BranchRating otorgadas por el Client indicado.

Método URI Cabeceras
GET /companies/{companyId}/clients/{clientId}/branch-ratings Authorization

Listar BranchRating de Branch

{info} Soporta: Paginación Filters Carga dinámica

Listar calificaciones de una sucursal

BranchRating recibidas por la Branch indicada.

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/branch-ratings Authorization

Listar BranchRating de BranchGroup

{info} Soporta: Paginación Filters Carga dinámica

Listar calificaciones de un grupo de sucursales

BranchRating de las sucursales del BranchGroup indicado.

Método URI Cabeceras
GET /companies/{companyId}/branch-groups/{branchGroupId}/branch-ratings Authorization

Mostrar BranchRating

{info} Soporta: Carga dinámica

Mostrar calificación de sucursal

Devuelve la BranchRating por su id.

Método URI Cabeceras
GET /companies/{companyId}/branch-ratings/{branchRatingId} Authorization

Actualizar BranchRating

Actualizar calificación de sucursal

Modifica rate y comment de la BranchRating. Un cliente solo puede editarla mientras no tenga comentario.

Método URI Cabeceras
PATCH /companies/{companyId}/branch-ratings/{branchRatingId} Authorization 
{
    "comment": "required|string|max:255"
}

Errores de negocio

Código HTTP Cuándo ocurre
EE300 400 La calificación ya tiene un comentario.

Relaciones