Interactions

Every resource exposes a set of interactions. Only the ones a feature requires need to be implemented.

Create

A POST to a collection resource creates a new individual within it. On success, the server returns 201 Created with the new resource in the response body and a Location header pointing to its path. If creation is asynchronous, the server returns 202 Accepted with a workflow identifier in the response body.

Synchronous
Asynchronous

1
POST /players HTTP/1.1
2
Content-Type: application/json
3

4
{
5
  "name": "Smilla",
6
  "surname": "Holmberg",
7
  "position": "RB"
8
}

1
HTTP/1.1 201 Created
2
Content-Type: application/json
3
Location: /players/23c1221d-8d1e-4d71-9a8a-ab3e9bff8025
4

5
{
6
  "id": "23c1221d-8d1e-4d71-9a8a-ab3e9bff8025",
7
  "name": "Smilla",
8
  "surname": "Holmberg",
9
  "position": "RB"
10
}

1
POST /players HTTP/1.1
2
Content-Type: application/json
3

4
{
5
  "name": "Fanny",
6
  "surname": "Peterson",
7
  "position": "RW"
8
}

1
HTTP/1.1 202 Accepted
2
Content-Type: application/json
3

4
{
5
  "workflowId": "10d99886-e03a-49e2-a86f-8743f13a6c4d"
6
}

Read

A GET to a collection resource retrieves all individuals within it. A GET to an individual resource retrieves that single item. Both return 200 OK on success.

Read Many
Read One

1
GET /players HTTP/1.1

1
HTTP/1.1 200 OK
2
Content-Type: application/json
3

4
[
5
  {
6
      "id": "8a9839e7-da35-4438-9dba-1d3ff0b4171b",
7
      "name": "Caroline",
8
      "surname": "Seger",
9
      "position": "CM"
10
  },
11
  {
12
      "id": "c8bf1fdf-152f-46c0-8679-0e5c8d33b404",
13
      "name": "Linda",
14
      "surname": "Sembrant",
15
      "position": "CB"
16
  },
17
  {
18
      "id": "2044c763-91f3-4c49-928a-037444d36111",
19
      "name": "Fridolina",
20
      "surname": "Rolfö",
21
      "position": "LB"
22
  },
23
  {
24
      "id": "23c1221d-8d1e-4d71-9a8a-ab3e9bff8025",
25
      "name": "Smilla",
26
      "surname": "Holmberg",
27
      "position": "RB"
28
  }
29
]

1
GET /players/c8bf1fdf-152f-46c0-8679-0e5c8d33b404 HTTP/1.1

1
HTTP/1.1 200 OK
2
Content-Type: application/json
3

4
{
5
  "id": "c8bf1fdf-152f-46c0-8679-0e5c8d33b404",
6
  "name": "Linda",
7
  "surname": "Sembrant",
8
  "position": "CB"
9
}

Replace

A PUT to an individual resource replaces it entirely with the provided data. On success, the server returns 200 OK with the replaced resource in the response body.

1
PUT /players/c8bf1fdf-152f-46c0-8679-0e5c8d33b404 HTTP/1.1
2
Content-Type: application/json
3

4
{
5
  "name": "Bella",
6
  "surname": "Andersson",
7
  "position": "CB"
8
}

1
HTTP/1.1 200 OK
2
Content-Type: application/json
3

4
{
5
  "id": "c8bf1fdf-152f-46c0-8679-0e5c8d33b404",
6
  "name": "Bella",
7
  "surname": "Andersson",
8
  "position": "CB"
9
}

Update

A PATCH to an individual resource applies a partial update, changing only the fields included in the request body. On success, the server returns 200 OK with the updated resource in the response body.

1
PATCH /players/2044c763-91f3-4c49-928a-037444d36111 HTTP/1.1
2
Content-Type: application/json
3

4
{
5
  "position": "LW"
6
}

1
HTTP/1.1 200 OK
2
Content-Type: application/json
3

4
{
5
  "id": "2044c763-91f3-4c49-928a-037444d36111",
6
  "name": "Fridolina",
7
  "surname": "Rolfö",
8
  "position": "LW"
9
}

Delete

A DELETE to an individual resource removes it. On success, the server returns 204 No Content with no response body.

1
DELETE /players/8a9839e7-da35-4438-9dba-1d3ff0b4171b HTTP/1.1

1
HTTP/1.1 204 No Content