Skip to main content

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

Parâmetros de Entrada

ParâmetroTipoObrigatórioDescrição
DriverNoString(25)SimCódigo externo do motorista
NameString(40)SimNome do motorista
ShortNameString(15)NãoNome reduzido do motorista
FederalRegisterNoString(11)NãoCPF
StateRegisterNoString(20)NãoRG
ConsignorOrganIDString(10)NãoÓrgão expedidor do RG
PassportNoString(10)NãoNúmero do passaporte
FoundationDateDataHoraNãoData de nascimento
PhoneString(20)NãoTelefone
CellPhoneString(20)NãoCelular
EmailString(200)NãoE-mail
DriversLicenseNoString(25)NãoNúmero da Habilitação
AddressAddressInfoSimObjeto que contém as informações do endereço do motorista
DriverTypeDriverTypeNãoEnumerador com os possíveis valores para o Tipo de Motorista: drtDriver (Motorista) ou drtValet (Manobrista)
IsInactiveBooleanNãoFlag que indica que o motorista está inativo
OverwriteIfExistsBooleanNãoFlag 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 FederalRegisterNo e StateRegisterNo são obrigatórios caso o campo PassportNo não seja informado e o inverso também se aplica, ou seja, é necessário garantir que:
    • FederalRegisterNo e StateRegisterNo estejam preenchidos, ou
    • PassportNo esteja preenchido.
      Não é permitido enviar todos esses campos em branco.

Retorno

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformações padrão de resposta do WebService na execução do método
DriverCodeIntegerSimCó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ódigoMensagem
ADV‑001Parâmetro Código Externo do Motorista (DriverNo) informado já existe!