Conductor
Descripción
El endpoint PostAddDriver es responsable del registro de un nuevo conductor en el sistema MIMS y puede ser visualizado en la pantalla CAD105.
Cómo registrar un nuevo conductor
Request HTTP Post
| Tipo de Solicitud | URL Ejemplo |
|---|---|
| POST | {{url_base}}/PostAddDriver |
| Ejemplo | http://suIPyPuerto/datasnap/rest/RESTWebServiceMethods/"PostAddDriver" |
Parámetros de Entrada
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| DriverNo | String(25) | Sí | Código externo del conductor |
| Name | String(40) | Sí | Nombre del conductor |
| ShortName | String(15) | No | Nombre reducido del conductor |
| FederalRegisterNo | String(11) | No | CPF |
| StateRegisterNo | String(20) | No | RG |
| Address | AddressInfo | Sí | Objeto que contiene la información de la dirección del conductor |
| Phone | String(20) | No | Teléfono |
| CellPhone | String(20) | No | Celular |
| String(200) | No | Correo electrónico | |
| FoundationDate | FechaHora | No | Fecha de nacimiento |
| IsInactive | Boolean | No | Flag que indica que el conductor está inactivo |
| DriversLicenseNo | String(25) | No | Número de la Licencia |
| PassportNo | String(10) | No | Número del Pasaporte |
| ConsignorOrganID | String(10) | No | Órgano Expedidor del RG |
| DriverType | DriverType | No | Enumerador con los posibles valores para el Tipo de Conductor: drtDriver (Conductor) o drtValet (Valet) |
| OverwriteIfExists | Boolean | No | Flag que indica que los datos deben ser sobrescritos si el registro ya existe |
Observación
Los parámetros FederalRegisterNo y StateRegisterNo son obligatorios si el campo PassportNo no es informado y viceversa, es decir, es necesario garantizar que:
FederalRegisterNoyStateRegisterNoestén completados, oPassportNoesté completado.
No está permitido enviar todos estos campos en blanco.
Retorno
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Sí | Información estándar de respuesta del Webservice en la ejecución del método |
| DriverCode | Integer | Sí | Código interno del conductor generado en el sistema MIMS |
Ejemplo de Request
curl --location --request POST '{{url_base}}/PostAddDriver' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
"DriverNo": "COND12345",
"Name": "Juan da Silva",
"ShortName": "Juan S.",
"Address": {
"Street": "Calle A",
"Number": "123",
"City": "São Paulo",
"State": "SP",
"ZipCode": "01000-000"
},
"Phone": "1123456789",
"CellPhone": "11987654321",
"Email": "juan.silva@email.com",
"DriversLicenseNo": "AB1234567",
"DriverType": "drtDriver",
"FederalRegisterNo": "12345678901",
"StateRegisterNo": "123456789",
"ConsignorOrganID": "SSP",
"FoundationDate": "1980-05-10",
"IsInactive": false,
"OverwriteIfExists": true
}'
Ejemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"DriverCode": 321
}