Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The transport protocol for all API requests is HTTPS (HTTP 1.1 + TLS 1.2). Connections using TLS versions before 1.2 will be rejected.

Encoding

Most API operations encode data as simple objects, arrays or strings. In cases where more complex objects are used, these are detailed throughout this guide.

...

Links have the following fields:

href

A URL reference to the linked object

rel

The relation of the linked object to the object carrying the link.

type

The type of the object referenced by the link (optional).

method

The HTTP verb describing the method to use when following the link (optional).

name

The name of the linked object (optional).

Object relationships

The ‘rel’ field on a link may be a number of values depending on the nature of the relationship. These values are defined as follows.

...

These relations define general relationships between objects. Most objects will carry links with one or more of these relationships.

self

A reference to the current object.

down

The linked object is a child of the carrying object.

up

The linked object is a parent of the carrying object.

add

Perform an add operation to create a new object as a child of the current object.

update

Perform an update operation to update the current object.

delete

Delete the current object.

Object-specific relationships

These relations define relationships that are specific to objects of particular types.

organisation:root

Defines a link to the root organisation. The root organisation has no parent organisations.

organisation:query

Defines a link to a resource to query organisations.

account:query

Defines a link to a resource to query accounts.

Example

Code Block
"links": [
           {
             "type" : "application/vnd.eduserv.iam.account-v1+json",
             "rel" : "self",
             "href" : "/api/v1/example.org/account/12345",
             "method" : "get"
           },
           {
             "rel" : "delete",
             "href" : "/api/v1/example.org/account/12345",
             "method" : "delete"
           }
]

...


See next:

Children Display
depth1
pageOpenAthens REST API documentation