Standards¶

Use nouns not verbs

Use plurals to manage both collection and instance resources

Use hierarchical URLs to imply structure (aggregation or composition)

GET /orders/e7c07022-f583-4245-80a8-f20222e55e46/products/2d2d6af5-e37c-408b-981e-f834bf4c162e

Use business unique identifiers or opaque and hard to guess ones

Do not expose a database primary key as identifier but a logical unique one.

/organisations/Lumberjacks /citizens/756-1234-4321-01 /clients/1dbd456aa-c129-4904-a44b-f115a6e851a3

Access to one resource¶

The investment proposal resource identified by 5558fba8-104f-464a-a2d2-76837a1895a6

GET /investment-proposals/5558fba8-104f-464a-a2d2-76837a1895a6

The user resource identified by johndoe inside the organisation resource identified by Lumberjacks

GET /organisations/Lumberjacks/users/johndoe

The one default strategy resource attached to the portfolio resource identified by 0c92d1b7-04f4-48ab-9333-83ec916b08a6

GET /portfolios/0c92d1b7-04f4-48ab-9333-83ec916b08a6/default-strategy

The singleton user information resource

GET /user-info

All the organisations

GET /organisations

A list of identified organisations: Lumberjacks,Lions

GET /organisations?id=Lumberjacks&id=Lions

All the organisations with name lumb

GET /organisations?name=lumb

The users of the organisation Lumberjacks

GET /organisations/Lumberjacks/users

The users of all organisations with first name doe and last name doe

GET /organisations/*/users?firstName=john&lastName=doe GET /organisations/users?firstName=john&lastName=doe

Name, tags, and partner of the users of the organisation Lumberjacks

GET /organisations/Lumberjacks?fields=name,tags,partner

List all the organisations with all their attributes

GET /organisations?view=full

A predefined and minimal subset of the attributes of all the organisations

GET /organisations?view=minimalistic