Skip to content

GET_services_id.md

Latest commit

 

History

History
64 lines (43 loc) · 1.15 KB

GET_services_id.md

File metadata and controls

64 lines (43 loc) · 1.15 KB

Service Resource

GET /services/{id}

Description

Returns a specified service format.

Parameters

Return format

A JSON Object filled with a service following the service format.

Errors

All errors return an HTTP error response with a JSON Object as keys message about the error, request.method the method of the received request, request.path the path used to send the request, request.input an array containing the parameters sent.

  • 404 Not Found — A service with the specified ID does not exist.

Example

Request

    GET /services/3

Return

    {
        "id": 3,
        "name": "vimeo",
        "link": "https://vimeo.com",
        "logo": null,
        "color": null
    }

Wrong Request

    GET /services/999

Return

{
    "message": "The requested object is not valid",
    "request": {
    "method": "GET",
    "path": "api/v1/services/999",
    "parameters": [ ]
    },
    "data": [ ]
}