Documentação API OCORRENCIAS

API responsável pela gravação dos registros de ocorrencia – TMSA360

URL Base: http://localhost:9090  trocar aqui pela sua URL Base.

Documentação da MsExecAuto

https://tdn.totvs.com/pages/releaseview.action?pageId=679964840

Métodos:

Inclusão de novas ocorrências

Verbo POST
Endpoint /OCORRENCIAS
Body Parâmetro Tipo Descrição
Ocurrencies jsonarray Matriz que ira conter os items
que devem ser inseridos
ocurrencies .header jsonarray Informações do cabeçalho
header.field String Nome do campo que deve ser
enviado para a execauto
(Verificar com o Protheus
quais campos enviar)
header.value any Valor do campo que sera
enviado para a execauto
ocurrencies .items jsonarray Informações dos itens
Items.sequence string Sequencia da ocorrencia
Items.occurence_date string Data da ocorrencia
Items.occurence_hour string Hora da ocorrencia, deve ser
enviado sem os : exemplo
(17:00 enviar como 1700)
Items.occurence_code string Codigo da ocorrencia
Items.document_branch String Filial do documento
Items.document_number String Numero do documento
Items.document_series String Serie do documento
Items.occurence_volume number Quantidade de volumes da
ocorrencia
Items. occurrence_weight number Peso real da ocorrencia
Items. branch_transfer string Filial da viagem transfer
Items. transfertrip_number String Numero da viagem transfer
ocurrencies .damageinvoice jsonarray Campos para Ordenação dos
Resultados
 Damageinvoice.keydocument String Chave contendo filial, numero
e serie
Damageinvoice.damage json Objeto json contendo as
informações da nota de avaria
Damageinvoice.damage.numbernfc string Numero da nota
Damageinvoice.damage.serienfc string Serie da nota
Damageinvoice.damage.qtdvolume number Quantidade de volume
Damageinvoice.damage.qtddamage number Quantidade de avarias
Damageinvoice.weigthdamage json Informações de peso da nota
Damageinvoice.weigthdamage.numbernfc string Numero da nota
Damageinvoice.weigthdamage.weight number Peso da nota
Damageinvoice.ocurrence string Numero da ocorrencia
Damageinvoice.pendingType string Tipo de pendencia
Damageinvoice.positionDv4 string Posição do registro na tabela
DV4

Exemplo {
"ocurrencies": [
{
"header": [
{
"field": "DUA_FILOCO",
"value": "M SP 04"
},
{
"field": "DUA_NUMOCO",
"value": "000001"
},
{
"field": "DUA_FILORI",
"value": "M SP 04 "
},
{
"field": "DUA_VIAGEM",
"value": "000095"
}
],
"items": [
{
"field": "DUA_SEQOCO",
"value": "01"
},
{
"field": "DUA_DATOCO",
"value": "2022-10-12"
},
{
"field": "DUA_HOROCO",
"value": "11:55"
 },
{
"field": "DUA_CODOCO",
"value": "EINF"
},
{
"field": "DUA_FILDOC",
"value": "M SP 04"
},
{
"field": "DUA_DOC",
"value": "001094 "
},
{
"field": "DUA_SERIE",
"value": "UNI"
},
{
"field": "DUA_QTDOCO",
"value": 100
},
{
"field": "DUA_PESOCO",
"value": 100
},
{
"field": "DUA_FILVTR",
"value": ""
},
{
"field": "DUA_NUMVTR",
"value": ""
}
],
"damageinvoice": {
"keydocument": "M SP 01 000000029117",
"damage": {
"numbernfc": "098765432",
"serienfc": "001",
"qtdVolume": 10,
"qtddamage": 1
},
"weightdamage": {
"numbernfc": "098765432",
"weight": 100
},
"occurrence": "E008",
"pendingType": "01",
"positionDv4": "1"
}
}
 ]
}

Retorno "messages": [
{
"type": "sucess",
"index": 1,
"message": "Registro de ocorrencia numero XXXXX com recno XXXX incluido com sucesso"
}
]