RICADO Gen 4 API JS Client

RICADO Gen 4 API JS Client

Class

SiteController

Controller Class for Sites

Constructor

new SiteController()

Source

Methods

static

create(createData) → {Promise.<SiteModel>}

Create a Site [POST /sites]

Parameters

  • createData SiteController.CreateData

    The Site Create Data

Returns

  • Promise.<SiteModel>

Source

static

getAll(queryParametersopt) → {Promise.<Array.<SiteModel>>}

List all Sites [GET /sites]

Parameters

  • queryParameters SiteController.GetAllQueryParameters <optional>

    The Optional Query Parameters

Returns

  • Promise.<Array.<SiteModel>>

Source

static

update(id, updateData) → {Promise.<SiteModel>}

Update a Site [PATCH /sites/{id}]

Parameters

  • id number

    The Site ID

  • updateData SiteController.UpdateData

    The Site Update Data

Returns

  • Promise.<SiteModel>

Source

Type Definitions

CreateData

The Create Data for a Site

Type

  • Object

Properties

  • name string

    The Site Name

  • companyId string

    The Company this Site belongs to

  • enabled boolean <optional>

    Whether the Site is Enabled

Source

GetAllQueryParameters

The Optional Query Parameters for the getAll Function

Type

  • Object

Properties

  • name string <optional>

    The Site Name

  • companyId string <optional>

    The Company this Site belongs to

  • enabled boolean <optional>

    Whether the Site is Enabled

Source

UpdateData

The Update Data for a Site

Type

  • Object

Properties

  • name string <optional>

    The Site Name

  • companyId string <optional>

    The Company this Site belongs to

  • enabled boolean <optional>

    Whether the Site is Enabled

Source