Saltar al contenido principal

Crear un colaborador

POSThttps://carchost.fieldcontrol.com.br/employees

Crea un colaborador y le envía una invitación de acceso a la app al correo informado. La dirección del colaborador se completa con la dirección de la cuenta.

Requiere los headers X-Api-Key, User-Agent y Content-Type: application/json. Límite: 1 solicitud por segundo (más información).

Solicitud​

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Cuerpo de la solicitud

JSON, enviado con el header Content-Type: application/json.

namestringobligatorio

Nombre del colaborador.

De 4 a 150 caracteres.

emailstring (correo electrónico)obligatorio

Correo electrónico de acceso a la app. Debe ser único entre todas las cuentas de Field Control. El colaborador recibe una invitación en ese correo.

passwordstring

Contraseña de acceso del colaborador a la app. Opcional: sin contraseña, el colaborador define la suya mediante la invitación enviada al correo.

Acepta: null.

notesstring

Observaciones del colaborador.

Hasta 2000 caracteres.

avatarUrlstring

URL de la foto del colaborador.

Acepta: null.

contractobject

Contrato del colaborador. Si se omite, la API guarda hiredAt con la fecha actual y firedAt nulo, incluso en la actualización.

Campos de contract
hiredAtstring (fecha)

Fecha de contratación (AAAA-MM-DD).

firedAtstring (fecha)

Fecha de desvinculación (AAAA-MM-DD). A partir de esa fecha el colaborador queda inactivo.

Acepta: null.

workScheduleobject

Jornada de trabajo, en HH:MM:SS. Si se omite, la API guarda de 08:00:00 a 17:00:00 con descanso de 12:00:00 a 13:00:00, incluso en la actualización.

Campos de workSchedule
startstring

Inicio de la jornada.

Ejemplo: 08:00:00.

endstring

Fin de la jornada.

Ejemplo: 17:00:00.

breakobject

Descanso.

Campos de break
startstring

Inicio del descanso.

Ejemplo: 12:00:00.

endstring

Fin del descanso.

Ejemplo: 13:00:00.

Respuestas

  • 201

    Colaborador creado.

  • 401

    Clave de API ausente (Missing API Key) o inválida (Invalid API Key). Consulte Autenticación.

  • 403

    Cuenta bloqueada (Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación.

  • 422

    Cuerpo inválido (resourceValidationErr) o correo electrónico ya usado por otro colaborador (reason: duplicated).

  • 429

    Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.

  • 500

    Error inesperado en el servidor.