The following requests relate to creating, updating and getting teams via the Litmos Training Engine API.
Note: All requests must be Authenticated.
Get Team List
Returns a list of teams in your organisation. By default only the first 100 teams are returned. The list can be filtered team name and paged using the optional paging parameters.
Access Level: Account Owners Only
Request Uri
GET /teams?
Response
<Teams>
<Team>
<Id>string [max length 50]</Id>
<Name>string [max length 100]</Name>
<TeamCodeForBulkImport>string</TeamCodeForBulkImport>
<ParentTeamId>string [max length 50]</ParentTeamId>
</Team>
</Teams>
or for sub teams
GET /teams/{teamId}/teams?
Response
<Teams> <Team> <Id>string [max length 50]</Id> <Name>string [max length 100]</Name>
<TeamCodeForBulkImport>string</TeamCodeForBulkImport>
<ParentTeamId>string [max length 50]</ParentTeamId> </Team> </Teams>
Get Team
Returns a single team for the given team Id.
Access Level: Account Owners and Administrators Only
Request Uri
GET /teams/{team-id}?
Response
Returns HTTP status code 200 on success and the team in the response body
<Team> <Id>string [max length 50]</Id> <Name>string [max length 100]</Name> <Description>string [optional, max length 1000]</Description>
<ParentTeamId>string [max length 50]</ParentTeamId>
<TeamCodeForBulkImport></TeamCodeForBulkImport> </Team>
Create Team or Sub-Team
Creates a new team or sub team in your organisation.
Access Level: Account Owners and Administrators Only
Request Uri
POST /teams or to create a sub team POST /teams/{teamId}/teams
Request Body
<Team> <Id></Id> <Name>string [max length 100]</Name> <Description>string [optional, max length 1000]</Description>
<ParentTeamId>string [max length 50]</ParentTeamId> </Team>
Response
Returns a HTTP status code 201 (Created) on success with the new team Id populated in the response body.
<Team> <Id>string [max length 50]</Id> <Name>string [max length 100]</Name> <Description>string [optional, max length 1000]</Description>
<ParentTeamId>string [max length 50]</ParentTeamId> </Team>
Update Team
Update a single team profile in your organisation. The team Id in the Uri must match the Id specified in the request body.
Access Level: Account Owners and Administrators Only
PUT /teams/{team-id}
Request Body
<Team> <Id>string [max length 50]</Id> <Name>string [max length 100]</Name> <Description>string [optional, max length 1000]</Description>
<ParentTeamId>string [max length 50]</ParentTeamId> </Team>
Response
Returns a HTTP status code 200 on success
Delete Team
Delete a single team profile in your organisation. The team Id in the Uri must match the Id specified in the request body.
Access Level: Account Owners and Administrators Only
DELETE /teams/{team-id}
Response
Returns a HTTP status code 200 on success
Comments
0 comments
Article is closed for comments.