AdminClient

Representa a una asociación de un Client y un Admin. Los Clientes pueden tener Admins asociados, los cuales pueden ver las órdenes de sus clientes y hacerles seguimiento.

La cantidad de Admins asociados a un Cliente es Ilimitada. Sin embargo, sólo 1 admin puede ser elegido como Admin Principal.

Cuando un Cliente tiene un Admin Principal asociado, todas las órdenes hechas por ese cliente pueden ser seguidas por el Admin principal.

Modelo AdminClient

{
  "admin_id": 2,
  "client_id": 44,
  "id": 56,
  "is_main": true,
  "created_at": "2020-02-20 19:37:28",
  "updated_at": "2020-02-20 19:37:28"
}
  • is_main: Indica si se trata del Admin principal de ese Client.

Listar AdminClient

Al tratarse de una tabla Pivote, no puede ser listada directamente.

Agregar Cliente a un Admin

Método URI Cabeceras
PUT /companies/{companyId}/admins/{adminId}/clients/{clientId} Authorization

Quitar un Cliente de un Admin

Método URI Cabeceras
DELETE /companies/{companyId}/admins/{adminId}/clients/{clientId} Authorization

Sincronizar AdminClient

Reemplaza todas las asociaciones por las asociaciones nuevas especificadas. Si alguna asociación existente no es enviada, el API la eliminará. Si alguna asociación existente es enviada, sus datos serán actualizado (si lo require). Si una asociación no existe, el API la creará.

Si se elimina el Admin principal en el proceso de sincronizado, se usará el primer admin que quede como principal automáticamente. El API garantiza que siempre que existan Admins asociados a un Cliente, habrá un Admin principal.

Método URI Cabeceras
PUT /companies/{companyId}/clients/{clientId}/admins Authorization
PUT /companies/{companyId}/admins/{adminId}/clients Authorization 
[1, 2, 3]

Se trata de un Array de id de Admin.

Acciones de AdminClient

Convertir AdminClient en Principal

Convierte el Admin seleccionado en el Admin principal para el cliente en cuestión. El Admin debe estar asociado al Cliente.

Cuando un Cliente tiene un Admin Principal asociado, todas las órdenes hechas por ese Cliente pueden ser seguidas por el Admin principal. También puede ser usado para delegar responsabilidad de Clientes a un Admin.

Método URI Cabeceras
POST /companies/{companyId}/clients/{clientId}/admins/{adminId}/set-main Authorization

Enlaces de AdminClient