Motoristas
O endpoint PostAddDriver é responsável pelo cadastro de um novo motorista no sistema MIMS e pode ser visualizado na tela CAD105.
Como cadastrar um motorista
Request HTTP Post
| Tipo da Requisição | URL Exemplo |
|---|---|
| POST | {{url_base}}/PostAddDriver |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddDriver" |
Parâmetros de Entrada
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| DriverNo | String(25) | Sim | Código externo do motorista |
| Name | String(40) | Sim | Nome do motorista |
| ShortName | String(15) | Não | Nome reduzido do motorista |
| FederalRegisterNo | String(11) | Não | CPF |
| StateRegisterNo | String(20) | Não | RG |
| ConsignorOrganID | String(10) | Não | Órgão expedidor do RG |
| PassportNo | String(10) | Não | Número do passaporte |
| FoundationDate | DataHora | Não | Data de nascimento |
| Phone | String(20) | Não | Telefone |
| CellPhone | String(20) | Não | Celular |
| String(200) | Não | ||
| DriversLicenseNo | String(25) | Não | Número da Habilitação |
| Address | AddressInfo | Sim | Objeto que contém as informações do endereço do motorista |
| DriverType | DriverType | Não | Enumerador com os possíveis valores para o Tipo de Motorista: drtDriver (Motorista) ou drtValet (Manobrista) |
| IsInactive | Boolean | Não | Flag que indica que o motorista está inativo |
| OverwriteIfExists | Boolean | Não | Flag que indica que os dados devem ser sobrescritos caso o registro já exista |
Observação
- A obrigatoriedade do parâmetro
Addressé definida por configuração. Por padrão, esse parâmetro é obrigatório. Para alterar esse comportamento, consulte o consultor responsável. - Os parâmetros
FederalRegisterNoeStateRegisterNosão obrigatórios caso o campoPassportNonão seja informado e o inverso também se aplica, ou seja, é necessário garantir que:FederalRegisterNoeStateRegisterNoestejam preenchidos, ouPassportNoesteja preenchido.
Não é permitido enviar todos esses campos em branco.
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 |
| DriverCode | Integer | Sim | Código interno do motorista gerado no sistema MIMS |
Exemplo de Request
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddDriver"' \
--header 'Content-Type: application/json' \
--data '{
"DriverNo": "DRV12345",
"Name": "João da Silva",
"ShortName": "João S.",
"FederalRegisterNo": "12345678901",
"StateRegisterNo": "123456789",
"DriversLicenseNo": "07224116669",
"ConsignorOrganID": "SP",
"DriverType": "drtDriver",
"Phone": "1123456789",
"CellPhone": "15991977870",
"Email": "joao.silva@email.com",
"IsInactive": false,
"Address": {
"Address": "RUA CINCO",
"District": "VILA SONIA",
"ZIPCode": "18200000",
"City": "ITAPETININGA",
"State": "SAO PAULO",
"StateInitials": "SP",
"Country": "BRASIL"
},
"OverwriteIfExists": true
}'
Exemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"DriverCode": 321
}
🐞 Possíveis Erros
| Código | Mensagem |
|---|---|
| ADV‑001 | Parâmetro Código Externo do Motorista (DriverNo) informado já existe! |