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ção | URL Exemplo |
|---|---|
| POST | {{url_base}}/PostAddFarm |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddFarm" |
Parâmetros de Entrada
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| FarmNo | String(25) | Sim | Código externo da propriedade |
| Name | String(40) | Sim | Descrição da propriedade |
| SupplierNo | String(15) | Sim | Código externo do fornecedor/integrado |
| Address | AddressInfo | Sim | Objeto que contém as informações do endereço da propriedade |
| FederalRegisterNo | String(14) | Não | CNPJ/CPF da propriedade |
| ProductorRegisterNo | String(22) | Não | Número do produtor rural |
| String(200) | Não | Endereço de e-mail da propriedade | |
| AgricultureSecretaryCode | Integer | Não | Código da Secretaria de Agricultura |
| InternalFarmCode | String(25) | Não | Código interno da propriedade |
| OverwriteIfExists | Boolean | Não | Flag que indica se os dados devem ser sobrescritos caso o registro já exista |
| TransportDataFarmSlaughterItemList | TransportDataFarmSlaughterItem | Não | Lista 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âmetro Tipo Obrigatório Descrição BranchNo String(25) Não Código Externo da Filial Distance Float Não Distância entre a propriedade e a Unidade de Abate (Filial) TransportTime Integer Não Tempo de percurso entre a propriedade e a Unidade de Abate (Filial)
Retorno
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Sim | Informações padrão de resposta do WebService na execução do método |
| FarmCode | Integer | Sim | Có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ódigo | Mensagem |
|---|---|
| AFM‑001 | Parâmetro Código Externo da Granja/Propriedade (FarmNo) informado já existe! |
| AFM‑002 | Parâmetro Código Externo do Integrado (SupplierNo) pertence a um fornecedor que não é do tipo "Integrado". Operação não permitida! |
| AFM‑003 | A Unidade de Abate não foi encontrada para a filial informada ([valor enviado na requisição]). Operação não permitida! |