Organizations module API explorer

/api/administrator/organizations/memberships (GET)

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

Returns array

Exceptions

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

Exception Circumstances

Receives

API routes may receive parameters from the URL and POST supporting simple and multipart:

Field Value Required Type
accountid string optional URL
all boolean optional URL
limit integer optional URL
offset integer optional URL
organizationid string optional URL

NodeJS source (edit on github)

If you see a problem with the source submit a pull request on Github.

const organizations = require('../../../../../index.js')

module.exports = {
  get: async (req) => {
    req.query = req.query || {}
    let index
    if (req.query.accountid) {
      index = `${req.appid}/account/memberships/${req.query.accountid}`
    } else if (req.query.organizationid) {
      index = `${req.appid}/organization/memberships/${req.query.organizationid}`
    }
    index = index || `${req.appid}/memberships`
    let membershipids
    if (req.query.all) {
      membershipids = await organizations.StorageList.listAll(index)
    } else {
      const offset = req.query.offset ? parseInt(req.query.offset, 10) : 0
      const limit = req.query.limit ? parseInt(req.query.limit, 10) : global.pageSize
      membershipids = await organizations.StorageList.list(index, offset, limit)
    }
    if (!membershipids || !membershipids.length) {
      return null
    }
    const items = []
    for (const membershipid of membershipids) {
      req.query.membershipid = membershipid
      const membership = await global.api.administrator.organizations.Membership.get(req)
      items.push(membership)
    }
    return items
  }
}

Test source (edit on github)

Tests perform real HTTP requests against a running Dashboard server.

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

describe('/api/administrator/organizations/memberships', function () {
  const cachedResponses = {}
  const cachedMemberships = []
  const accountMemberships = []
  const organizationMemberships = []
  before(async () => {
    await DashboardTestHelper.setupBeforeEach()
    await TestHelper.setupBeforeEach()
    const administrator = await TestHelper.createOwner()
    global.delayDiskWrites = true
    for (let i = 0, len = global.pageSize + 1; i < len; i++) {
      global.userProfileFields = ['contact-email', 'full-name']
      const owner = await TestHelper.createUser()
      global.userProfileFields = ['display-email', 'display-name']
      await TestHelper.createProfile(owner, {
        'display-name': owner.profile.firstName,
        'display-email': owner.profile.contactEmail
      })
      await TestHelper.createOrganization(owner, {
        email: owner.profile.displayEmail,
        name: 'My organization',
        profileid: owner.profile.profileid
      })
      cachedMemberships.unshift(owner.membership.membershipid)
      global.userProfileFields = ['contact-email', 'full-name']
      const user = await TestHelper.createUser()
      global.userProfileFields = ['display-email', 'display-name']
      await TestHelper.createProfile(user, {
        'display-name': user.profile.firstName,
        'display-email': user.profile.contactEmail
      })
      await TestHelper.createInvitation(owner)
      await TestHelper.acceptInvitation(user, owner)
      cachedMemberships.unshift(user.membership.membershipid)
    }
    global.userProfileFields = ['contact-email', 'full-name']
    const user = await TestHelper.createUser()
    global.userProfileFields = ['display-email', 'display-name']
    await TestHelper.createProfile(user, {
      'display-name': user.profile.firstName,
      'display-email': user.profile.contactEmail
    })
    await TestHelper.createOrganization(user, {
      email: user.profile.displayEmail,
      name: 'My organization 1',
      profileid: user.profile.profileid
    })
    accountMemberships.unshift(user.membership.membershipid)
    cachedMemberships.unshift(user.membership.membershipid)
    organizationMemberships.unshift(user.membership.membershipid)
    for (let i = 0, len = 3; i < len; i++) {
      global.userProfileFields = ['contact-email', 'full-name']
      const member = await TestHelper.createUser()
      global.userProfileFields = ['display-email', 'display-name']
      await TestHelper.createProfile(member, {
        'display-name': member.profile.firstName,
        'display-email': member.profile.contactEmail
      })
      await TestHelper.createInvitation(user)
      await TestHelper.acceptInvitation(member, user)
      organizationMemberships.unshift(member.membership.membershipid)
      cachedMemberships.unshift(user.membership.membershipid)
    }
    for (let i = 0, len = 3; i < len; i++) {
      global.userProfileFields = ['contact-email', 'full-name']
      const owner = await TestHelper.createUser()
      global.userProfileFields = ['display-email', 'display-name']
      await TestHelper.createProfile(owner, {
        'display-name': owner.profile.firstName,
        'display-email': owner.profile.contactEmail
      })
      await TestHelper.createOrganization(owner, {
        email: owner.profile.displayEmail,
        name: 'My organization',
        profileid: owner.profile.profileid
      })
      cachedMemberships.unshift(owner.membership.membershipid)
      await TestHelper.createInvitation(owner)
      await TestHelper.acceptInvitation(user, owner)
      accountMemberships.unshift(user.membership.membershipid)
      cachedMemberships.unshift(user.membership.membershipid)
    }
    const req1 = TestHelper.createRequest('/api/administrator/organizations/memberships?offset=1')
    req1.account = administrator.account
    req1.session = administrator.session
    cachedResponses.offset = await req1.get()
    const req2 = TestHelper.createRequest('/api/administrator/organizations/memberships?limit=1')
    req2.account = administrator.account
    req2.session = administrator.session
    cachedResponses.limit = await req2.get()
    const req3 = TestHelper.createRequest('/api/administrator/organizations/memberships?all=true')
    req3.account = administrator.account
    req3.session = administrator.session
    cachedResponses.all = await req3.get()
    const req4 = TestHelper.createRequest(`/api/administrator/organizations/memberships?accountid=${user.account.accountid}&all=true`)
    req4.account = administrator.account
    req4.session = administrator.session
    cachedResponses.accountid = await req4.get()
    const req5 = TestHelper.createRequest(`/api/administrator/organizations/memberships?organizationid=${user.organization.organizationid}&all=true`)
    req5.account = administrator.account
    req5.session = administrator.session
    cachedResponses.organizationid = await req5.get()
    const req6 = TestHelper.createRequest(`/api/administrator/organizations/memberships?accountid=${user.account.accountid}`)
    req6.account = administrator.account
    req6.session = administrator.session
    req6.filename = __filename
    req6.saveResponse = true
    cachedResponses.returns = await req6.get()
    global.pageSize = 3
    cachedResponses.pageSize = await req6.get()
  })
  describe('receives', () => {
    it('optional querystring offset (integer)', async () => {
      const offset = 1
      const membershipsNow = cachedResponses.offset
      for (let i = 0, len = global.pageSize; i < len; i++) {
        assert.strictEqual(membershipsNow[i].membershipid, cachedMemberships[offset + i])
      }
    })

    it('optional querystring limit (integer)', async () => {
      const limit = 1
      const membershipsNow = cachedResponses.limit
      assert.strictEqual(membershipsNow.length, limit)
    })

    it('optional querystring all (boolean)', async () => {
      const membershipsNow = cachedResponses.all
      assert.strictEqual(membershipsNow.length, cachedMemberships.length)
    })

    it('optional querystring accountid (string)', async () => {
      const membershipsNow = cachedResponses.accountid
      assert.strictEqual(membershipsNow.length, accountMemberships.length)
    })

    it('optional querystring organizationid (string)', async () => {
      const membershipsNow = cachedResponses.organizationid
      assert.strictEqual(membershipsNow.length, organizationMemberships.length)
    })
  })
  describe('returns', () => {
    it('array', async () => {
      const membershipsNow = cachedResponses.returns
      assert.strictEqual(membershipsNow.length, global.pageSize)
    })
  })

  describe('configuration', () => {
    it('environment PAGE_SIZE', async () => {
      global.pageSize = 3
      const membershipsNow = cachedResponses.pageSize
      assert.strictEqual(membershipsNow.length, global.pageSize)
    })
  })
})