Layout themes

get

/team/:teamid/themes/story (authenticated)

Get the themes associated with the team

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. member_of
Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

teamid: The id of the team to act on

get

/division/:divisionid/themes/story (authenticated)

Get the themes associated with the division

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. member_of
Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

divisionid: undocumented

get

/team/:teamid/themes/story/deleted (authenticated)

Get the deleted themes associated with the team

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. theme_management
Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

teamid: The id of the team to act on

get

/division/:divisionid/themes/story/deleted (authenticated)

Get the deleted themes associated with the division

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. theme_management
Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

divisionid: undocumented

get

/division/:divisionid/themes/story/all (authenticated)

Get all themes associated with the division id (non-deleted)

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. theme_management
Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

divisionid: undocumented

get

/team/:teamid/deleted/themes/story/all (authenticated)

Get all themes associated with the team (deleted and non-deleted)

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. theme_management
Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

teamid: The id of the team to act on

get

/team/:teamid/themes/story/search

Get all the themes within a team! (search)

Accepted Query Arguments

string query: The search string
integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

teamid: The id of the team to act on

get

/division/:divisionid/themes/story/search

Get all the themes within a division! (search)

Accepted Query Arguments

string query: The search string
integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

divisionid: undocumented

get

/team/:teamid/themes/story/all (authenticated)

Get all themes associated with the team (non-deleted)

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. theme_management
Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
Accepted Restful Arguments

teamid: The id of the team to act on

get

/team/:teamid/theme/:themeid/story (authenticated)

Get a single theme - fetches the latest version.

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. view_charts
Accepted Restful Arguments

teamid: The id of the team to act on
themeid: undocumented
Returns

{
// The ID of the story
story_id: number,
// The view counter for the chart
view_count: number,
// The chart version
version: number,
// The timestamp for this version
creation_time: date,
// The chart data
data: json,
// The URL for the latest thumbnail
thumbnail_url: string,
// The username for the owner
username: string,
}

post

/team/:teamid/story/:storyid/totheme (authenticated)

Turn a chart into a theme

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. theme_management
Accepted Restful Arguments

teamid: The id of the team to act on
storyid: undocumented

post

/teams/:teamid/story/theme/:themeid (authenticated)

Update a theme for a team

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. theme_management
Accepted Body Arguments

{
// The type of theme
type: string,
// The theme name
name: string,
// Chart options
properties: json,
}
Accepted Restful Arguments

teamid: The id of the team to act on
themeid: undocumented

Did you find what you were looking for? Thank you! There was a problem submitting your feedback. Please try again later.