Organizations module API explorer

/api/administrator/organizations/organization (GET)

Account information like email addresses is generated with faker-js it is not real user information.

await global.api.administrator.organizations.Organization.get(req)

Returns object

{
  "organizationid": "orgn_3a4356a4dcf8c1aa",
  "object": "organization",
  "appid": "tests_1656039698",
  "ownerid": "acct_a9dcd99f5b5c4a41",
  "name": "My organization",
  "pin": "12345",
  "email": "Bert.Dietrich51@yahoo.com",
  "createdAt": "2022-06-24T03:01:38.802Z",
  "updatedAt": "2022-06-24T03:01:38.802Z"
}

Exceptions

These exceptions are thrown (NodeJS) or returned as JSON (HTTP) if you provide incorrect data or do not meet the requirements:

Exception Circumstances
invalid-organizationid unspecified querystring organizationid
invalid querystring organizationid

NodeJS source (view on github)

const dashboard = require('@layeredapps/dashboard')
const organizations = require('../../../../../index.js')

module.exports = {
  get: async (req) => {
    if (!req.query || !req.query.organizationid) {
      throw new Error('invalid-organizationid')
    }
    let organization = await dashboard.StorageCache.get(req.query.organizationid)
    if (!organization) {
      const organizationInfo = await organizations.Storage.Organization.findOne({
        where: {
          organizationid: req.query.organizationid,
          appid: req.appid || global.appid
        }
      })
      if (!organizationInfo) {
        throw new Error('invalid-organizationid')
      }
      organization = {}
      for (const field of organizationInfo._options.attributes) {
        organization[field] = organizationInfo.get(field)
      }
      await dashboard.StorageCache.set(req.query.organizationid, organization)
    }
    return organization
  }
}

Test source (view on github)

/* eslint-env mocha */
const assert = require('assert')
const TestHelper = require('../../../../../test-helper.js')

describe('/api/administrator/organizations/organization', () => {
  describe('exceptions', () => {
    describe('invalid-organizationid', () => {
      it('unspecified querystring organizationid', async () => {
        const administrator = await TestHelper.createOwner()
        const req = TestHelper.createRequest('/api/administrator/organizations/organization')
        req.account = administrator.account
        req.session = administrator.session
        let errorMessage
        try {
          await req.get()
        } catch (error) {
          errorMessage = error.message
        }
        assert.strictEqual(errorMessage, 'invalid-organizationid')
      })

      it('invalid querystring organizationid', async () => {
        const administrator = await TestHelper.createOwner()
        const req = TestHelper.createRequest('/api/administrator/organizations/organization?organizationid=invalid')
        req.account = administrator.account
        req.session = administrator.session
        let errorMessage
        try {
          await req.get()
        } catch (error) {
          errorMessage = error.message
        }
        assert.strictEqual(errorMessage, 'invalid-organizationid')
      })
    })
  })

  describe('returns', () => {
    it('object', async () => {
      const administrator = await TestHelper.createOwner()
      const owner = await TestHelper.createUser()
      global.userProfileFields = ['display-name', 'display-email']
      await TestHelper.createProfile(owner, {
        'display-name': owner.profile.fullName,
        'display-email': owner.profile.contactEmail
      })
      await TestHelper.createOrganization(owner, {
        email: owner.profile.displayEmail,
        name: 'My organization',
        profileid: owner.profile.profileid,
        pin: '12345'
      })
      const req = TestHelper.createRequest(`/api/administrator/organizations/organization?organizationid=${owner.organization.organizationid}`)
      req.account = administrator.account
      req.session = administrator.session
      req.filename = __filename
      req.saveResponse = true
      const organization = await req.get()
      assert.strictEqual(organization.object, 'organization')
    })
  })
})