API v1 Documentation

List all micro portals

This version of the API docs is depreciated and will be taken offline soon.
Please migrate to the new version as soon as possible to avoid service disruption.

New version can be found at https://docs.wceaapi.org/

Returns all micro portals in the authenticated organization.

Request

  • HTTP Verb: GET
  • URI: /microportal

Searchable Fields

name Example:

(name[lk]:hobbyist, status[eq]:active)

Find all trainings whose:

  • name contains hobbyist
  • And has the status active
abbreviation
subdomain
status
See Advanced queries for details on how to use Searchable Fields.

Request example

curl -H "Request-Time: Wed, 11 Dec 2013 13:15:04 +0000" \
     -H "Api-Key: 78b47a40f93378a6a487919edea6e92c" \
     -H "Signature: 0a035961fbf7d2ffdc5ca8780e0a33cb3d6c3a5f8fb0623e886c9933377d3e1e" \
     http://wceaapi.org/v1/microportal

Output Example

{
  "_meta": {
   ...
  },
  "records": [
    {
      "id": 1234,
      "name": "Professional Portal",
      "abbreviation": "pro",
      "subdomain": "pro.dmc",
      "status": "Active"
    },
    {
      "id": 1235,
      "name": "Hobbyist Portal",
      "abbreviation": "play",
      "subdomain": "play.dmc",
      "status": "Disabled"
    }
    ...
  ]
}