Região Logística
O endpoint PostAddLogisticRegion é responsável pelo cadastro de uma Região Logística no sistema MIMS e pode ser visualizado na tela CAD036.
Como cadastrar uma região logística
Request HTTP Post
| Tipo da Requisição | URL Exemplo |
|---|---|
| POST | {{url_base}}/PostAddLogisticRegion |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddLogisticRegion" |
Parâmetros de Entrada
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| LogisticRegionNo | String(25) | Sim | Código externo da Região Logística |
| LogisticRegionName | String(40) | Sim | Descrição da Região Logística |
| RiskDegree | Integer | Sim | Enumerador com os possíveis valores para o Grau de Risco: rdLow (Baixo), rdMedium (Médio) ou rdHigh (Alto) |
| SubLogisticRegionList | SubLogisticRegionDataList | Sim | Lista de Sub Região Logística (caso não haja, passar as mesmas informações da Região Logística) |
| OverwriteIfExists | Boolean | Não | Flag que indica que os dados devem ser sobrescritos caso o registro já exista |
📝 Objeto SubLogisticRegionDataList
O objeto SubLogisticRegionDataList representa uma lista das Sub Regiões Logísticas pertencentes a uma Região Logística.
Parâmetros de Entrada
Parâmetro Tipo Obrigatório Descrição SubLogisticRegionNo String(25) Sim Código externo da Sub Região Logística SubLogisticRegionName String(40) Sim Descrição da Sub Região Logística OverwriteIfExists Boolean Não Flag que indica que os dados devem ser sobrescritos caso o registro já exista
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 |
| LogisticRegionCode | Integer | Sim | Código interno da Região Logística gerado no sistema MIMS |
Exemplo de Request
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddLogisticRegion"' \
--header 'Content-Type: application/json' \
--data '{
"LogisticRegionNo": "001",
"LogisticRegionName": "Região Norte",
"RiskDegree": "rdMedium",
"SubLogisticRegionList": [
{
"SubLogisticRegionNo": "001-1",
"SubLogisticRegionName": "SubRegião Norte A",
"OverwriteIfExists": true
}
],
"OverwriteIfExists": true
}'
Exemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"LogisticRegionCode": 2
}
🐞 Possíveis Erros
| Código | Mensagem |
|---|---|
| LRE‑001 | O parâmetro Código Externo da Região Logística (LogisticRegionNo) informado já existe! |
| LRE‑002 | O parâmetro Código Externo da Sub Região Logística (SubLogisticRegionNo) informado já existe! |