Histórico da Página
Índice
| Índice | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Objetivo
Para os usuários que possuem algum aplicativo customizado ou integração do romaneio e necessitam que seja realizada aprovação do romaneio no produto Gestão de Frete Embarcador (SIGAGFE), foi disponibilizado o método Web Service REST para realizar a Aprovação do Romaneio.
...
- Objetivo
- Método Publicado
- Pré-requisitos para Utilização
- Exemplo de Utilização
- Utilizando o Postman para Realizar a liberação de romaneio
- Exemplo de arquivo JSON
- Detalhamento das Tags de Entrada
- IDs de campos suportados
- Detalhamento das Tags de Saída
- Detalhamento técnico da estrutura do arquivo
Método Publicado
| Fonte | GFEWSFREIGHTRELEASE |
|---|---|
| Nome do Serviço | FREIGHTRELEASE |
Pré-requisitos para Utilização
- Atualização do Microsiga Protheus com versão igual ou superior a 12.1.17.
- Atualização da Build 131227a a partir da versão 13.2.3.6.
- Configuração do AppServer para disponibilizar as rotinas publicadas com o Web Service REST.
- No link http://tdn.totvs.com.br/pages/viewpage.action?pageId=185748193 é possível encontrar todas as configurações necessárias, inclusive as orientações para definir, opcionalmente, a filial das requisições.
- Após a configuração do Web Service REST, ao executar o appserver via console, será apresentada uma mensagem, informando que o Web Service REST está habilitado, vide imagem abaixo.
...
Métodos disponíveis no API FREIGHTRELEASE.
Exemplo de Utilização
Para realizar testes, pode ser utilizado qualquer programa de sua preferência que teste API Web Service REST.
Como exemplos de programas, podemos citar o SoapUI ou a extensão Postman do Navegador Chrome. Ambos são excelentes aplicativos.
Utilizando o Postman para Realizar a liberação de romaneio
A API FREIGHTRELEASE disponibiliza o método GET, onde é retornado o arquivo de exemplo no formato JSON, que poderá ser utilizado para executar o método POST.
...
Após executar a liberação do romaneio, o resultado será retornado no formato JSON.
Exemplo de arquivo JSON
Arquivo JSON de entrada para ser utilizado como base, informando três romaneios de forma mínima.
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"content": [
{
"Items": [
{
"Manifest": [
{
"Items": [
{
"id": "ManifestNumber",
"value": "00000006"
}
]
}
]
}
]
}
]
} |
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"content":[
{
"Items":[
{
"FreightReleases":[
{
"Items":[
{
"id":"ManifestNumber",
"Description":"Número do Romaneio para liberação",
"value":"00000006",
"Status":"ok",
"Message":"Romaneio liberado com sucesso"
}
]
}
],
"Status":"ok",
"Message":"freightrelease: Liberação(ões) de Frete realizada(s). Verifique o Status de cada Romaneio."
}
]
}
]
} |
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"content":[
{
"Items":[
{
"FreightReleases":[
{
"Items":[
{
"id":"ManifestNumber",
"Description":"Número do Romaneio para liberação",
"value":"00000008",
"Status":"error",
"Message":"Romaneio não possui documento de carga relacionado"
}
]
}
],
"Status":"ok",
"Message":"freightrelease: Liberação(ões) de Frete realizada(s). Verifique o Status de cada Romaneio."
}
]
}
]
} |
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"content": [
{
"Items": [
{
"FreightReleases": [
{
"Items": [
{
"id": "ManifestNumber",
"Description": "Número do Romaneio para liberação",
"value": "00000006",
"Status": "ok",
"Message": "Romaneio liberado com sucesso"
}
]
},
{
"Items": [
{
"id": "ManifestNumber",
"Description": "Número do Romaneio para liberação",
"value": "00000008",
"Status": "error",
"Message": "Romaneio não possui documento de carga relacionado"
}
]
},
{
"Items": [
{
"id": "ManifestNumber",
"Description": "Número do Romaneio para liberação",
"value": "99999999",
"Status": "error",
"Message": "Romaneio número 99999999 não encontrado"
}
]
}
],
"Status": "ok",
"Message": "freightrelease: Liberação(ões) de Frete realizada(s). Verifique o Status de cada Romaneio."
}
]
}
]
} |
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"errorCode": 500,
"errorMessage": "invalid class JSSONOBJECT"
} |
Detalhamento das Tags de Entrada
| Manifest - Informações do romaneio. Ocorrências 1 ou mais. | |||||
|---|---|---|---|---|---|
| Field | Conteúdo / Descrição | ObservaçãoChave | |||
| id | Nome da TAG - ManifestNumber | Obrigatório. | Description | Descrição do campo - Número do Romaneio | |
| value | Número do romaneio a ser liberado | Obrigatório. | Length | Tamanho do campo do número do manifesto. | type | Tipo da informação - Alfanumérica |
IDs de campos suportados
| Tipo | Tamanho |
| Observação | |||||
| ManifestNumber | Número do Romaneio para liberação | * | Alfanumérico | 8 | Obrigatório |
| DepartureDate | Data de saída | Data | 8 | ||
| DepartureTime | Hora de saída | Alfanumérico | 5 | ||
| DepartureOdometer |
| Hodômetro de saída | Numérico | 6 | |||
| TrackingCode | Código de Rastreamento | Alfanumérico | 18 |
Detalhamento das Tags de Saída
| FreightRelease - Informações do romaneio. Ocorrências 1 ou mais. | ||
|---|---|---|
| Field | Conteúdo / Descrição | Observação |
| id | Nome da TAG - ManifestNumber | Obrigatório. |
| Descriptiondescription | Descrição do campo - Número do Romaneio | |
| value | Número do romaneio a ser liberado | Obrigatório. |
| Satusstatus | Indica se a liberação foi realizada: | |
| Messagemessage | Mensagem da situação da liberação. Quando não realizado com sucesso, indica o motivo. | |
Detalhamento técnico da estrutura do arquivo
Estrutura do arquivo de entrada.
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas