Pular para o conteúdo principal

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çãoURL Exemplo
POST{{url_base}}/PostAddLogisticRegion
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddLogisticRegion"

Parâmetros de Entrada

ParâmetroTipoObrigatórioDescrição
LogisticRegionNoString(25)SimCódigo externo da Região Logística
LogisticRegionNameString(40)SimDescrição da Região Logística
RiskDegreeIntegerSimEnumerador com os possíveis valores para o Grau de Risco: rdLow (Baixo), rdMedium (Médio) ou rdHigh (Alto)
SubLogisticRegionListSubLogisticRegionDataListSimLista de Sub Região Logística (caso não haja, passar as mesmas informações da Região Logística)
OverwriteIfExistsBooleanNãoFlag 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âmetroTipoObrigatórioDescrição
SubLogisticRegionNoString(25)SimCódigo externo da Sub Região Logística
SubLogisticRegionNameString(40)SimDescrição da Sub Região Logística
OverwriteIfExistsBooleanNãoFlag que indica que os dados devem ser sobrescritos caso o registro já exista

Retorno

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformações padrão de resposta do WebService na execução do método
LogisticRegionCodeIntegerSimCó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ódigoMensagem
LRE‑001O parâmetro Código Externo da Região Logística (LogisticRegionNo) informado já existe!
LRE‑002O parâmetro Código Externo da Sub Região Logística (SubLogisticRegionNo) informado já existe!