Pular para o conteúdo principal

Propriedade

O endpoint PostAddFarm é responsável por cadastrar uma nova granja (ou propriedade) no sistema MIMS. Esse cadastro pode ser visualizado na tela CAD073.


Como cadastrar uma propriedade​

Request HTTP POST

Tipo da RequisiçãoURL Exemplo
POST{{url_base}}/PostAddFarm
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddFarm"

Parâmetros de Entrada​

ParâmetroTipoObrigatórioDescrição
FarmNoString(25)SimCódigo externo da propriedade
NameString(40)SimDescrição da propriedade
SupplierNoString(15)SimCódigo externo do fornecedor/integrado
AddressAddressInfoSimObjeto que contém as informações do endereço da propriedade
FederalRegisterNoString(14)NãoCNPJ/CPF da propriedade
ProductorRegisterNoString(22)NãoNúmero do produtor rural
EmailString(200)NãoEndereço de e-mail da propriedade
AgricultureSecretaryCodeIntegerNãoCódigo da Secretaria de Agricultura
InternalFarmCodeString(25)NãoCódigo interno da propriedade
OverwriteIfExistsBooleanNãoFlag que indica se os dados devem ser sobrescritos caso o registro já exista
TransportDataFarmSlaughterItemListTransportDataFarmSlaughterItemNãoLista de dados de transporte entre a unidade de abate e a propriedade
Observação
  • A obrigatoriedade do parâmetro Address é definida por configuração. Por padrão, esse parâmetro é obrigatório. Para alterar esse comportamento, consulte o consultor responsável.

📝 Objeto TransportDataFarmSlaughterItem​

O objeto TransportDataFarmSlaughterItem representa um item dos dados de transporte no sistema MIMS.

Parâmetros de Entrada​

ParâmetroTipoObrigatórioDescrição
BranchNoString(25)NãoCódigo Externo da Filial
DistanceFloatNãoDistância entre a propriedade e a Unidade de Abate (Filial)
TransportTimeIntegerNãoTempo de percurso entre a propriedade e a Unidade de Abate (Filial)

Retorno​

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformações padrão de resposta do WebService na execução do método
FarmCodeIntegerSimCódigo interno da propriedade gerada no sistema MIMS

Exemplo de Request​

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddFarm"' \
--header 'Content-Type: application/json' \
--data-raw '{
"FarmNo": "FARM-00123",
"Name": "Propriedade Santa Luzia",
"SupplierNo": "SUP-045",
"Address": {
"Address": "Estrada Municipal KM 15",
"District": "VAL FLOR",
"ZIPCode": "06456100",
"City": "EMBU-GUACU",
"State": "SAO PAULO",
"StateInitials": "SP",
"Country": "BRASIL"
},
"FederalRegisterNo": "12345678000199",
"ProductorRegisterNo": "PR-982345",
"Email": "contato@santaluzia.com.br",
"AgricultureSecretaryCode": 45678,
"InternalFarmCode": "IFC-0099",
"OverwriteIfExists": true,
"TransportDataFarmSlaughterItemList": [
{
"BranchNo": "FIL-001",
"Distance": 125.6,
"TransportTime": 180
}
]
}'

Exemplo de Response​

{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"FarmCode": 1023
}

🐞 Possíveis Erros​

CódigoMensagem
AFM‑001Parâmetro Código Externo da Granja/Propriedade (FarmNo) informado já existe!
AFM‑002Parâmetro Código Externo do Integrado (SupplierNo) pertence a um fornecedor que não é do tipo "Integrado". Operação não permitida!
AFM‑003A Unidade de Abate não foi encontrada para a filial informada ([valor enviado na requisição]). Operação não permitida!