7 DOMAIN SERVICES RESOURCE

Returns a list §B11 of (links to) domain service resources §C15.

The endpoint URL for this resource is:

/services

7.1 HTTP GET

7.1.1 GET Request

7.1.1.1 Query String

None

7.1.1.2 Headers

  • Accept

    • application/json

    • application/json;profile="…​/list "

7.1.1.3 Body

  • N/A

7.1.2 GET Successful Response

7.1.2.1 Status Code

  • 200 "OK"

7.1.2.2 Headers

  • Content-Type

    • application/json;profile="…​/list ";x-ro-element-type="yyy"

      where "yyy" is the domain type id for the services (most likely a type representing a common base class for all services, eg Object)

  • Caching headers:

    • NON_EXPIRING, see §A2.13

      list of available services will not change between deployments

7.1.2.3 Body

As per §B7.2.

7.2 Representation

The returned representation is a simple list §B11, but with an additional link with a rel="up" referring back to the homepage resource §B5

The links from the services representation to other resources are as shown in the diagram below:

Slide5
Figure 1. SERVICES REPRESENTATION

The JSON representation is:

{
  "links" : [ {
      "rel": "self",
      "href" : "http://~/services",
      "type" : "application/json;profile=\".../services\"",
      "method" : "GET"
    }, {
      "rel": "up",
      "href": "http://~/",
      "type": "application/json;profile=\".../homepage\"",
      "method": "GET"
    },
    ...
  } ],
  "value" : [ {
      "rel": ".../service;serviceId="toDoItems",
      "href" : "http://~/services/toDoItems",
      "method" : "GET",
      "type" : "application/json;profile=\".../object\"",
      "title": To Do Items"
    }, {
      "rel": ".../service;serviceId="categories",
      "href" : "http://~/services/categories",
      "method" : "GET",
      "type" : "application/json;profile=\".../object\"",
      "title": "Categories"
    }, ...
  ],
  "extensions": { ... }
}

where:

JSON-Property Description

links

list of links to resources.

value

list of links to to domain service resources §C15.