Skip to content

Latest commit

 

History

History
84 lines (65 loc) · 1.73 KB

EditBus.md

File metadata and controls

84 lines (65 loc) · 1.73 KB

Edit Bus

Used to edit bus details.

URL : /api/admin/1.0/buses/{busno}

Method : PUT

Auth required : Yes

NOTE : Pass the {busno} of the bus you want to edit in the API-URL

Set the headers

	Content-Type : application/json,
	Accept: application/json,
	Authorization : Bearer admin_api_token.

Example : Suppose you created the bus with bus_no 8840, and it was saved successfully using create bus api , now you want to edit both the bus_no and gps_device_id.

The endpoint to edit this bus is

PUT : api/admin/1.0/buses/{busno}/

make a PUT request, and pass the form with fields

bus_no
gps_device_id

as shown in Data example for a bus

Authorization Header need to be set in the post request api, and please keep space between Bearer and api_token.

Example: Authorization : Bearer api_token.

Where api_token is the token recieved on login.

Data constraints

Note: This is the actual form that need to be passed as payload to api.

{
    "bus_no"       : "[valid bus no of as bus e.g 8840, to be passed as form payload]",
    "gps_device_id"  : "[unique gps device id]",
}

Data example for a bus

{
   "bus_no"  : 8812,
   "gps_device_id" : "sdsada-123Wwdqw-sadas142-sssdass"
}

Success Response

Code : 201 Created

{
  "status": "created"
}

Error Response

Condition : If '{busno}' passed in form payload or gps_device id is already found in database.

Code : 422 Unprocessable Entity

Content :

{
   "errors": {
        "bus_no": [
            "The bus no has already been taken."
        ],
        "gps_device_id": [
            "The gps device id has already been taken."
        ]
    }
}