Ordem de Pesagem de Animais

---

Cadastro de Ordem de Pesagem de Animais

O endpoint PostAddAnimalWeighingOrder é responsável pelo cadastro de uma nova ordem de pesagem de animais no sistema MIMS.

---

Como cadastrar uma ordem de pesagem de animais

Request HTTP Post

Tipo da Requisição	URL Exemplo
POST	{{url_base}}/PostAddAnimalWeighingOrder
Exemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddAnimalWeighingOrder"

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
AnimalWeighingOrderNo	String(25)	Sim	Código externo da Ordem de Pesagem
BranchNo	String(25)	Sim	Código externo da Filial
WeighingEvent	WeighingEvent	Não	Enumerador com os possíveis valores para o Tipo da Ordem de Pesagem: weNormal (Normal), weIncident (Acidentado), weInTransit (Em Trânsito), weDiverted (Desviado) ou weChickenSale (Venda de Frango)
AnimalWeighingOrderStatusType	AnimalWeighingOrderStatusType	Não	Enumerador com os possíveis valores para o Tipo de Status da Ordem de Pesagem: wsOpened (Aberta) ou wsBlocked (Bloqueada)
ScheduleDate	DataHora	Sim	Data da programação da ordem de pesagem
CatchDate	DataHora	Sim	Data da apanha
ScheduleSlaughterDate	DataHora	Não	Data programada de abate
VehiclePlateNo	String(10)	Sim	Placa do veículo
VehicleNo	String(25)	Não	Código externo do veículo
TransporterNo	String(25)	Sim	Código externo do transportador
DriverNo	String(25)	Sim	Código externo do motorista
LotNo	String(40)	Sim	Lote
FarmNo	String(25)	Sim	Código externo da propriedade
ShedNo	Integer	Sim	Código externo do Galpão
CatchMethodNo	String(25)	Não	Método da apanha
CatchCrewNo	String(25)	Sim	Código externo da equipe de apanha
CatchCrewSupervisorNo	String(25)	Não	Código externo do supervisor de apanha
AnimalAge	Integer	Sim	Idade dos animais
CageQty	Integer	Sim	Quantidade de gaiolas
AnimalPerCageQty	Integer	Sim	Quantidade de animais por gaiola
DocumentNumber	String(25)	Não	Número do documento de entrada
ReferenceNumber	String(25)	Não	Número de Referência da ordem de pesagem
Notes	String(200)	Não	Observações da ordem de pesagem
LoadingOrderNumber	String(5)	Não	Número da ordem de carregamento
IsActivatedQAPrope	Boolean	Sim	Indica se há presença de Salmonela na carga
ExpectedAverageWeight	Float	Não	Peso médio previsto dos animais
PropertyKMDistance	String(20)	Não	Distância em KM entre a propriedade e o abatedouro
QAAnalysisResult	QAAnalysisResultType	Não	Enumerador com os possíveis valores para o Tipo de Resultado da Análise QA: arNotAssigned (Vazio), arPresent (Presente) ou arAbsent (Ausente)

---

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
AnimalWeighingOrderCode	Integer	Sim	Código interno da Ordem de Pesagem gerado no sistema MIMS

---

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddAnimalWeighingOrder"' \
--header 'Content-Type: application/json' \
--data '{
    "AnimalWeighingOrderNo": "AWO-0115001",
    "BranchNo": "BR-001",
    "WeighingEvent": "weNormal",
    "AnimalWeighingOrderStatusType": "wsOpened",
    "ScheduleDate": "2025-01-15T08:30:00",
    "CatchDate": "2025-01-15T05:00:00",
    "ScheduleSlaughterDate": "2025-01-16T07:00:00",
    "VehiclePlateNo": "ABC1D23",
    "VehicleNo": "VEH-402",
    "TransporterNo": "TRP-012",
    "DriverNo": "DRV-887",
    "LotNo": "LT-2025-01892",
    "FarmNo": "FRM-045",
    "ShedNo": 3,
    "CatchMethodNo": "CMT-02",
    "CatchCrewNo": "CRW-155",
    "CatchCrewSupervisorNo": "SUP-017",
    "AnimalAge": 42,
    "CageQty": 120,
    "AnimalPerCageQty": 14,
    "DocumentNumber": "DOC-77821",
    "ReferenceNumber": "REF-14002",
    "Notes": "",
    "LoadingOrderNumber": "50310",
    "IsActivatedQAPrope": true,
    "ExpectedAverageWeight": 2.45,
    "PropertyKMDistance": "78",
    "QAAnalysisResult": "arPresent"
}'

---

Exemplo de Response

{
    "WebServiceReturn": {
        "Status": "wrsSuccess",
        "ErrorCode": "",
        "Message": "",
        "Actor": "",
        "ReturnQuestion": null
    },
    "AnimalWeighingOrderCode": 1001
}

---

🐞 Possíveis Erros

Código	Mensagem
AWO‑001	Parâmetro Código Externo da Entrada de Aves Vivas (AnimalWeighingOrderNo) informado já existe!
AWO‑002	Não Foi Encontrado um Supervisor de Apanha Padrão para a Fazenda (FarmNo) informada!
AWO‑003	Parâmetro Código Externo do Transportador (TransporterNo) pertence a um fornecedor que não é do tipo "Transportador". Operação não permitida!
AWO‑004	Parâmetro (AnimalPerCageQty) informado "[valor enviado na requisição]" está fora do intervalo cadastrado. O range deve ser entre "[Quantidade mínima de animais por gaiola]" e "[Quantidade máxima de animais por gaiola]"!
AWO‑010	Nenhuma placa foi encontrada para o código do veículo ("[valor enviado na requisição]")

Exclusão de Ordem de Pesagem de Animais

O endpoint PostDeleteAnimalWeighingOrder é responsável por executar a exclusão de uma ordem de pesagem de Animais no sistema MIMS.

---

Como excluir uma ordem de pesagem de animais

Request HTTP Post

Tipo da Requisição	URL Exemplo
POST	{{url_base}}/PostDeleteAnimalWeighingOrder
Exemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteAnimalWeighingOrder"

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
AnimalWeighingOrderNo	String(25)	Sim	Código externo da Ordem de Pesagem
ErrorIfNotFound	Boolean	Não	Retorna erro caso a ordem informada não exista no banco de dados

---

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

---

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteAnimalWeighingOrder"' \
--header 'Content-Type: application/json' \
--data '{
    "AnimalWeighingOrderNo": "1",
    "ErrorIfNotFound": true
}'

---

Exemplo de Response

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

---

🐞 Possíveis Erros

Código	Mensagem
AWO‑007	A "AnimalWeighingOrderNo" informada não pode ser excluída pois há outras ordens vinculadas a ela
AWO‑008	O status atual da "AnimalWeighingOrderNo" informada ("[Status da Ordem de Pesagem]") não permite exclusão!
AWO‑009	A "AnimalWeighingOrderNo" informada já foi enviada para o Handheld. Ela deve ser cancelada pelo supervisor de apanha!

---