dvl-api-fleet-trailer-create.md

Fleet Trailer Create

• URL

  /v1/trailers

• Method:

  POST

• HEADERS

  Authorization=bearer ACCESS_TOKEN

• Data Params

  trailer[model]=[text]
  

• Success Response:

  • Code: 201 CREATED
    Content: {"data":
{"trailer":{
"id":28,
"model":"MODEL_NAME"
}}}

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content: { error": "Invalid access token" }

  OR

  • Code: 401 UNAUTHORIZED
    Content { error: 'You don't have permission' }

  OR

  • Code: 422 UNPROCESSABLE ENTITY
    Content: {"errors":{
"model":["can't be blank"]
}}
    

• Sample Call:

• Notes:

dvl-api-fleet-trailer-delete.md

Fleet Trailer Delete

• URL

  /v1/trailers/:id

• Method:

  DELETE

• HEADERS

  Authorization=bearer ACCESS_TOKEN

• URL Params

  Required:

  id=[integer]

• Data Params

• Success Response:

  • Code: 200 OK
    Content:

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content: { error": "Invalid access token" }

  OR

  • Code: 401 UNAUTHORIZED
    Content { error: 'You don't have permission' }

  OR

  • Code 404 NOT FOUND
    Content: { error: "Not Found" }

  OR

  • Code: 404 UNPROCESSABLE ENTITY
    Content:

• Sample Call:

• Notes:

dvl-api-fleet-trailer-update.md

Fleet Trailer Update

• URL

  /v1/trailers/:id

• Method:

  PUT | PATCH

• HEADERS

  Authorization=bearer ACCESS_TOKEN

• URL Params

  Required:

  id=[integer]

• Data Params

  trailer[model]=[text]
  

• Success Response:

  • Code: 200 OK
    Content: {"data":
{"trailer":{
"id":28,
"truck":"MODEL_NAME"
}}}

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content: { error": "Invalid access token" }

  OR

  • Code: 401 UNAUTHORIZED
    Content { error: 'You don't have permission' }

  OR

  • Code 404 NOT FOUND
    Content: { error: "Not Found" }

  OR

  • Code: 404 UNPROCESSABLE ENTITY
    Content: {"errors":{"model":["can't be blank"]}}

• Sample Call:

• Notes:

dvl-api-fleet-trailers.md

Fleet Trailers

• URL

  /v1/trailers

• Method:

  GET

• HEADERS

  Authorization=bearer ACCESS_TOKEN

• URL Params

  Required:

  none

  Optional:

  per_page=[integer]
page=[integer]
'q[model_eq]'=[text]
...

• Data Params

  none

• Success Response:

  • Code: 200 OK
    Content: {"data":{
"trailers":[
{"id":3,"model":"MODEL_NAME"},

{"id":20,"model":"MODEL_NAME"}
],
"pagination":{"page":1,"per_page":2,"total":10,"pages":5}}}

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content: { error": "Invalid access token" }

  OR

  • Code: 401 UNAUTHORIZED
    Content { error: 'You don't have permission' }

• Sample Call:

• Notes:

in search query

*_eq - equal
*_cont Contains value