Viviot.Api

<back to all web services

UpdateTeam

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, TeamAdmin
The following routes are available for this service:
PUT/teamUpdate an existing team.
UpdateTeam Parameters:
NameParameterData TypeRequiredDescription
IdbodystringYesTeam Id (GUID)
NamebodystringYesThe team name.
LeaderBusinessUserIdbodyintNoThe team leader ID.
TeamMembersbodyarrayNoIDs of team members.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
TeamResponse Parameters:
NameParameterData TypeRequiredDescription
TeamsformList<TeamDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
TeamDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
OrganizationIdformGuidNo
NameformstringNo
LeaderBusinessUserIdformint?No
TeamMembersformList<TeamMemberDto>No
TeamMemberDto Parameters:
NameParameterData TypeRequiredDescription
BusinessUserIdformintNo
FirstNameformstringNo
LastNameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /team HTTP/1.1 
Host: api.4spaces.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 00000000000000000000000000000000,
	name: String,
	leaderBusinessUserId: 0,
	teamMembers: 
	[
		0
	],
	version: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	teams: 
	[
		{
			id: 00000000000000000000000000000000,
			organizationId: 00000000000000000000000000000000,
			name: String,
			leaderBusinessUserId: 0,
			teamMembers: 
			[
				{
					businessUserId: 0,
					firstName: String,
					lastName: String
				}
			]
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}