Pular para o conteúdo principal

Criar um colaborador

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

Cria um colaborador e envia a ele um convite de acesso ao app no e-mail informado. O endereço do colaborador é preenchido com o endereço da conta.

Requer os headers X-Api-Key, User-Agent e Content-Type: application/json. Limite: 1 requisição por segundo (saiba mais).

Requisição​

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Corpo da requisição

JSON, enviado com o header Content-Type: application/json.

namestringobrigatório

Nome do colaborador.

De 4 a 150 caracteres.

emailstring (e-mail)obrigatório

E-mail de acesso ao app. Deve ser único entre todas as contas do Field Control. O colaborador recebe um convite nesse e-mail.

passwordstring

Senha de acesso do colaborador ao app. Opcional: sem senha, o colaborador define a dele pelo convite enviado ao e-mail.

Aceita: null.

notesstring

Observações do colaborador.

Até 2000 caracteres.

avatarUrlstring

URL da foto do colaborador.

Aceita: null.

contractobject

Contrato do colaborador. Se omitido, a API grava hiredAt com a data atual e firedAt nulo, inclusive na atualização.

Campos de contract
hiredAtstring (data)

Data de contratação (AAAA-MM-DD).

firedAtstring (data)

Data de desligamento (AAAA-MM-DD). A partir dessa data o colaborador fica inativo.

Aceita: null.

workScheduleobject

Jornada de trabalho, em HH:MM:SS. Se omitida, a API grava das 08:00:00 às 17:00:00 com intervalo das 12:00:00 às 13:00:00, inclusive na atualização.

Campos de workSchedule
startstring

Início da jornada.

Exemplo: 08:00:00.

endstring

Fim da jornada.

Exemplo: 17:00:00.

breakobject

Intervalo.

Campos de break
startstring

Início do intervalo.

Exemplo: 12:00:00.

endstring

Fim do intervalo.

Exemplo: 13:00:00.

Respostas

  • 201

    Colaborador criado.

  • 401

    Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

  • 403

    Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

  • 422

    Corpo inválido (resourceValidationErr) ou e-mail já usado por outro colaborador (reason: duplicated).

  • 429

    Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

  • 500

    Erro inesperado no servidor.