Pular para o conteúdo principal

Atualizar os dados de uma Fazenda

Descrição: Atualiza os dados de uma fazenda a partir do id.

Endpoint​

PUT/api/v1/integration/farms/{farm_id}

Regras​

AtributosDescriçãoTipoObrigatórioValidações
farm_idIdentificador da fazendaUUIDSim-
state_subscriptionInscrição estadualStringNãoFormato: inscrição-Estado. Ex: 123456-MS
nameNomeStringSimCampo de preenchimento obrigatório, até 255 caracteres.
ownTipo de propriedadeBooleanSimtrue para própria, false para alugada
registrationNúmero de matriculaStringNãoSem limite de tamanho definido pela API.
latitudeLatitude da sedeStringNãoIgnorado. O serviço substitui o valor enviado pelo que já está cadastrado na fazenda, antes de gravar. A validação de formato ainda roda antes do descarte: até 50 caracteres, padrão de latitude decimal de -90 a 90 com até 6 casas (ex: -15.601411), e valor fora disso devolve 400 mesmo sendo ignorado depois.
longitudeLongitude da sedeStringNãoIgnorado. O serviço substitui o valor enviado pelo que já está cadastrado na fazenda, antes de gravar. A validação de formato ainda roda antes do descarte: até 50 caracteres, padrão de longitude decimal de -180 a 180 com até 6 casas (ex: -56.097892).
areaÁrea da fazendaStringNãoIgnorado. O serviço substitui o valor enviado pelo que já está cadastrado na fazenda, antes de gravar.
address_idIdentificador do endereço a vincularUUIDNãoIgnorado. O serviço substitui o valor enviado pelo que já está cadastrado na fazenda, antes de gravar. Não é possível revincular endereço por este endpoint: a chamada devolve 204 e o vínculo permanece o mesmo.

Exemplo de Requisição​

curl -X PUT \
-H "Authorization: {SUA_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"name": "Fazenda Boa Vista Atualizada",
"own": true,
"state_subscription": "654321-MT",
"registration": "REG-002"
}' \
"https://api.merx.tech/api/v1/integration/farms/{FARM_ID}"

Parâmetros​

Parâmetros de Caminho:​

NomeDescriçãoTipoObrigatório
farm_idIdentificador da fazendaStringSim

Parâmetros de Cabeçalho​

NomeDescriçãoTipoObrigatório
AuthorizationChave de API obtida via support-api@merx.techStringSim
Content-Typeapplication/jsonStringSim

Respostas​

  • 204 - No Content

  • 400 - Bad Request

{
"messages": ["message.entidade.campo-inválido"]
}
  • 401 - Unauthorized

  • 404 - NotFound