import OrganisationController from 'itslanguage/administrative-sdk/organisation/organisation-controller.js'

private class | source

OrganisationController

Controller class for the Organisation model.

Constructor Summary

Public Constructor
public	constructor(connection: Connection)

Private Members
private	_connection: Connection Object to use for making a connection to the REST API and Websocket server.

Public Methods
public	createOrganisation(organisation: Organisation): Promise<Organisation> Create an organisation.
public	getOrganisation(organisationId: string): Promise<Organisation> Get an organisation the current tenant is the owner of.
public	getOrganisations(): Promise<Organisation[]> Get and return all organisations the current tenant is the owner of.

Name	Type	Attribute	Description
connection	Connection		Object to use for making a connection to the REST API and Websocket server.

Object to use for making a connection to the REST API and Websocket server.

Create an organisation. The organisation will be owned by the current active tenant.

Name	Type	Attribute	Description
organisation	Organisation		Object to create.

Promise containing the newly created Organisation.

Promise.<Error>	organisation parameter of type "Organisation" is required.
Promise.<Error>	If the server returned an error.

Get an organisation the current tenant is the owner of.

Name	Type	Attribute	Description
organisationId	string		Specify an organisation identifier.

Promise containing an Organisation.

Promise.<Error>	organisationId parameter of type "string" is required.
Promise.<Error>	If no result could not be found.

Get and return all organisations the current tenant is the owner of.

Promise containing an array of Organisations.

Promise.<Error>

If no result could not be found.