Criar um serviço

Se a unidade informada em unit_code não existir, ela será criada automaticamente usando unit_description.

Parâmetros de entrada

ParâmetroTipoObrigatórioDescrição
descriptionTextoSimNome do tipo de serviço. Máximo de 50 caracteres.
unit_codeTextoSimCódigo da unidade associada ao tipo de serviço. Máximo de 10 caracteres. Se não existir na empresa, uma nova unidade será criada.
unit_descriptionTextoCondicionalDescrição da unidade. Obrigatório se unit_code ainda não existir na empresa. Máximo de 50 caracteres.

Observações

  • Os campos description e unit_code são obrigatórios. Se algum deles estiver ausente ou vazio, a função retorna o código 404 e a mensagem description and unit_code are required.
  • Se unit_code não existir no catálogo de unidades da empresa e unit_description não for enviado, a função retorna o código 404 e a mensagem unit_description is required.
  • A busca por unit_code não diferencia maiúsculas de minúsculas (UPPER).
  • A nova unidade é criada com id_unit_type = 2.

Parâmetros de saída

ParâmetroTipoDescrição
idInteiroIdentificador único do tipo de serviço criado.
id_companyInteiroIdentificador da empresa.
descriptionTextoNome do tipo de serviço registrado.
id_unityInteiroIdentificador da unidade associada.
is_changedBooleanoIndica se o registro foi modificado. Sempre será false na criação.

Exemplo

Quando a unidade não existir, envie unit_description para criá-la automaticamente.

{
  "description": "Manutenção corretiva",
  "unit_code": "HRS",
  "unit_description": "Horas"
}

Quando a unidade já existir, não é necessário enviar unit_description.

{
  "description": "Inspeção preventiva",
  "unit_code": "HRS"
}

Response
200
Language
LoadingLoading…