Api Drivers - morenagit/wikiTest GitHub Wiki

Drivers

Driver Login

Description

Driver login API.

  • Resource URI: /driver-login
  • HTTP Req type: POST
  • Req Content Type: application/x-www-form-urlencoded
  • Res Content Type: application/json

Request Body

Parameter Type Description
phone String Driver phone number
password String Driver password

Response Body

HTTP Res Code Structure Description
200 OK
  • Content
  • Message
  • Code
 Returns driver's data
404 Not found
  • Message
  • Code
 The resource cannot be found

Example

POST /api/driver-login

password=pass&phone=3663177645

{
    "code": "200",
    "status": "success",
    "message": "Resource successfully retrieved",
    "content": [
        {
            "_id": "5e4fab7ce7223c34240da0a5",
            "name": "John",
            "surname": "Doe",
            "email": "[email protected]",
            "phone": "3663177645",
            "payment": null
        }
    ]
}

Driver registration

Description

Registers a new driver.

  • Resource URI: /driver
  • HTTP Req type: POST
  • Req Content Type: application/x-www-form-urlencoded
  • Res Content Type: application/json

Request Body

Parameter Type Description
name String Driver name
surname String Driver surname
email String Driver email
phone String Driver phone number
password String Driver password

Response Body

HTTP Res Code Structure Description
200 OK
  • Message
  • Code
 Driver has been successfully registered
422 Unprocessable Entity
  • Message
  • Code
 Driver already exists
⚠️ **GitHub.com Fallback** ⚠️