api/organisations

This file contains the readily available functions which interact with the ITSLanguage organisation API.

Source:

Members

(inner, constant) url :string

Source:

The URL for the organisation handler(s).

Type:
  • string

Methods

(static) create(organisation) → {Promise}

Source:

Create a new organisation.

Parameters:
Name Type Description
organisation Object

The organisation to create.

Properties
Name Type Attributes Description
id string <optional>

The organisation id. If none is given, one is generated.
name Array

The name of the organisation.
Returns:
  • The organisation creation promise.
Type
Promise

(static) getAll(filtersopt) → {Promise}

Source:

Get a all organisations.

By default all organisations are fetched though it is allowed to pass filters as a URLSearchParams object.

Parameters:
Name Type Attributes Description
filters URLSearchParams <optional>

The filters to apply to the category list.
Throws:
  • If the given optional filters are not an instance of URLSearchParams.
Type
Promise.<string>
Returns:
  • The promise for the organisations.
Type
Promise

(static) getById(id) → {Promise}

Source:

Get a single organisation by its ID.

Parameters:
Name Type Description
id string

The ID of the desired organisation.
Returns:
  • The promise for the organisation.
Type
Promise