Panels

>>>

GET //v1/panels
get a list of panels

Also see GET /v1/panels/<panelId>.

Examples

GET /v1/panels
{
   "message":null,
   "result":[ <panel> ]
}

Returns

Code: 200

Description:

OK

Param name Description
panelId
required

Validations:

  • Must be a Integer
panelName
required

Validations:

  • Must be a String
displayPanelName
required

Validations:

  • Must be a String
panelAbbr
required

Validations:

  • Must be a String
description
required

Validations:

  • Must be a String
isActive
required

Validations:

  • Must be one of: true, false.
panelType
required

Validations:

  • Must be a String
members
required

Usernames of the panel members

Validations:

  • Must be an array of String
>>>

GET //v1/panels/<panelId>
get the specified panel

Examples

GET /v1/panels/1
{
   "message":null,
   "result":{
      "panelId":1,
      "panelName":"XRAC",
      "displayPanelName":"XRAC",
      "panelAbbr":"XRAC",
      "description":"Extreme Science",
      "isActive":true,
      "panelType":"Research",
      "members":[
         "aschuele",
         "esoriano"
      ]
   }
}

Params

Param name Description
panelId
required

Validations:

  • Must be a Integer

Returns

Code: 200

Description:

OK

Param name Description
panelId
required

Validations:

  • Must be a Integer
panelName
required

Validations:

  • Must be a String
displayPanelName
required

Validations:

  • Must be a String
panelAbbr
required

Validations:

  • Must be a String
description
required

Validations:

  • Must be a String
isActive
required

Validations:

  • Must be one of: true, false.
panelType
required

Validations:

  • Must be a String
members
required

Usernames of the panel members

Validations:

  • Must be an array of String