Group API
{ http://soa.com/wsdl/group/1.0 } GroupAPI
The Groups service provides methods for managing groups in the Akana API Platform, including app teams, API Context Groups, and independent groups.
POST/groupsaddGroup
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
body
entity
AddGroupRequest
AddGroupRequest {
Group {
RatingSummary {
GroupSettings {
Group( Group, required )
Administrators( Collection of string )
}
Group {
RatingSummary( RatingSummary, required )
Description( string )
Updated( dateTime )
ContextObjectID( string )
PictureID( long )
AdminCount( int )
MemberCount( int )
GroupID( string )
Name( string )
Contact( string )
Created( dateTime )
AvatarURL( anyURI )
GroupType( string )
State( string )
GroupSettings( GroupSettings, required )
Visibility( string )
Tag( Collection of string )
IsFollowed( boolean )
Link( anyURI )
}
RatingSummary {
Five( int, required )
Four( int, required )
One( int, required )
Two( int, required )
Three( int, required )
}
GroupSettings {
GroupBoardSupport( string )
GroupRatingsSupport( string )
GroupReviewsSupport( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Group
Group {
RatingSummary {
GroupSettings {
RatingSummary( RatingSummary )
Description( string )
Updated( dateTime )
ContextObjectID( string )
PictureID( long )
AdminCount( int )
MemberCount( int )
GroupID( string )
Name( string )
Contact( string )
Created( dateTime )
AvatarURL( anyURI )
GroupType( string )
State( string )
GroupSettings( GroupSettings )
Visibility( string )
Tag( Collection of string )
IsFollowed( boolean )
Link( anyURI )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
GroupSettings {
GroupBoardSupport( string )
GroupRatingsSupport( string )
GroupReviewsSupport( string )
}
DELETE/groups/{GroupID}deleteGroup
Parameters
Name
Type
Description
Model
GroupID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
PUT/groups/{GroupID}modifyGroup
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
GroupID
path
string
body
entity
Group
Group {
RatingSummary {
GroupSettings {
RatingSummary( RatingSummary, required )
Description( string )
Updated( dateTime )
ContextObjectID( string )
PictureID( long )
AdminCount( int )
MemberCount( int )
GroupID( string )
Name( string )
Contact( string )
Created( dateTime )
AvatarURL( anyURI )
GroupType( string )
State( string )
GroupSettings( GroupSettings, required )
Visibility( string )
Tag( Collection of string )
IsFollowed( boolean )
Link( anyURI )
}
RatingSummary {
Five( int, required )
Four( int, required )
One( int, required )
Two( int, required )
Three( int, required )
}
GroupSettings {
GroupBoardSupport( string )
GroupRatingsSupport( string )
GroupReviewsSupport( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Group
Group {
RatingSummary {
GroupSettings {
RatingSummary( RatingSummary )
Description( string )
Updated( dateTime )
ContextObjectID( string )
PictureID( long )
AdminCount( int )
MemberCount( int )
GroupID( string )
Name( string )
Contact( string )
Created( dateTime )
AvatarURL( anyURI )
GroupType( string )
State( string )
GroupSettings( GroupSettings )
Visibility( string )
Tag( Collection of string )
IsFollowed( boolean )
Link( anyURI )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
GroupSettings {
GroupBoardSupport( string )
GroupRatingsSupport( string )
GroupReviewsSupport( string )
}
GET/groups/{GroupID}getGroup
Parameters
Name
Type
Description
Model
GroupID
path
string
IncludeSettings
query
boolean
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
Group
Group {
RatingSummary {
GroupSettings {
RatingSummary( RatingSummary )
Description( string )
Updated( dateTime )
ContextObjectID( string )
PictureID( long )
AdminCount( int )
MemberCount( int )
GroupID( string )
Name( string )
Contact( string )
Created( dateTime )
AvatarURL( anyURI )
GroupType( string )
State( string )
GroupSettings( GroupSettings )
Visibility( string )
Tag( Collection of string )
IsFollowed( boolean )
Link( anyURI )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
GroupSettings {
GroupBoardSupport( string )
GroupRatingsSupport( string )
GroupReviewsSupport( string )
}
GET/groups/requests/{MembershipRequestID}getRequestState
Parameters
Name
Type
Description
Model
MembershipRequestID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/groups/{GroupID}/boardgetBoard
Parameters
Name
Type
Description
Model
GroupID
path
string
ItemType
query
string
DiscussionType
query
string
ItemID
query
string
Tag
query
string
IncludeComments
query
boolean
NumberOfComments
query
integer
IncludeActions
query
boolean
IncludeCommentActions
query
boolean
start
query
integer
count
query
integer
SortBy
query
string
RetrievingUserID
query
string
IncludeSelfAuthored
query
boolean
PublishedState
query
string
Reponse
Produces text/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
rss
rss {
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
channel( rssChannel )
version( string )
}
rssChannel {
image( rssImage )
copyright( string )
item( rssItem )
skipHours( rssSkipHours )
lastBuildDate( string )
link( anyURI )
rating( string )
description( string )
generator( string )
language( string )
title( string )
managingEditor( string )
webMaster( string )
pubDate( string )
ttl( int )
skipDays( rssSkipDays )
cloud( rssCloud )
textInput( rssTextInput )
docs( anyURI )
category( rssCategory )
}
rssImage {
link( anyURI )
width( int )
description( string )
title( string )
url( string )
height( int )
}
rssItem {
comments( anyURI )
enclosure( rssEnclosure )
author( string )
link( anyURI )
description( string )
guid( rssGuid )
source( rssSource )
title( string )
category( rssCategory )
pubDate( string )
}
rssEnclosure {
length( string )
type( string )
url( string )
}
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
hour( Collection of string )
}
rssSkipDays {
day( Collection of string )
}
rssCloud {
path( string )
protocol( string )
port( int )
registerProcedure( string )
domain( string )
}
rssTextInput {
name( string )
link( anyURI )
description( string )
title( string )
}
GET/groups/{GroupID}/memberslistMembers
Parameters
Name
Type
Description
Model
GroupID
path
string
Reponse
Produces application/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Membership
Membership {
Image {
GroupName( string )
Email( string )
role( string )
UserName( string )
DomainName( string )
FirstName( string )
Image( Image )
GroupID( string )
GroupDescription( string )
UserID( string )
State( string )
GroupMembershipID( string )
LastName( string )
IdentityName( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
POST/groups/{GroupID}/membersinviteMemberToGroup
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
GroupID
path
string
body
entity
MembershipRequest
MembershipRequest {
Role( string )
Email( string )
Message( string )
MembershipRequestID( string )
UserID( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/groups/{GroupID}/settingsgetGroupSettings
Parameters
Name
Type
Description
Model
GroupID
path
string
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
GroupSettings
GroupSettings {
GroupBoardSupport( string )
GroupRatingsSupport( string )
GroupReviewsSupport( string )
}
GET/groups/{GroupID}/followersgetFollowers
Parameters
Name
Type
Description
Model
GroupID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
rss
rss {
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
channel( rssChannel )
version( string )
}
rssChannel {
image( rssImage )
copyright( string )
item( rssItem )
skipHours( rssSkipHours )
lastBuildDate( string )
link( anyURI )
rating( string )
description( string )
generator( string )
language( string )
title( string )
managingEditor( string )
webMaster( string )
pubDate( string )
ttl( int )
skipDays( rssSkipDays )
cloud( rssCloud )
textInput( rssTextInput )
docs( anyURI )
category( rssCategory )
}
rssImage {
link( anyURI )
width( int )
description( string )
title( string )
url( string )
height( int )
}
rssItem {
comments( anyURI )
enclosure( rssEnclosure )
author( string )
link( anyURI )
description( string )
guid( rssGuid )
source( rssSource )
title( string )
category( rssCategory )
pubDate( string )
}
rssEnclosure {
length( string )
type( string )
url( string )
}
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
hour( Collection of string )
}
rssSkipDays {
day( Collection of string )
}
rssCloud {
path( string )
protocol( string )
port( int )
registerProcedure( string )
domain( string )
}
rssTextInput {
name( string )
link( anyURI )
description( string )
title( string )
}
GET/groups/{GroupID}/membersgetMembers
Parameters
Name
Type
Description
Model
GroupID
path
string
Reponse
Produces text/xmlapplication/json
Status Code
Reason
Model
200
Success
rss
rss {
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
channel( rssChannel )
version( string )
}
rssChannel {
image( rssImage )
copyright( string )
item( rssItem )
skipHours( rssSkipHours )
lastBuildDate( string )
link( anyURI )
rating( string )
description( string )
generator( string )
language( string )
title( string )
managingEditor( string )
webMaster( string )
pubDate( string )
ttl( int )
skipDays( rssSkipDays )
cloud( rssCloud )
textInput( rssTextInput )
docs( anyURI )
category( rssCategory )
}
rssImage {
link( anyURI )
width( int )
description( string )
title( string )
url( string )
height( int )
}
rssItem {
comments( anyURI )
enclosure( rssEnclosure )
author( string )
link( anyURI )
description( string )
guid( rssGuid )
source( rssSource )
title( string )
category( rssCategory )
pubDate( string )
}
rssEnclosure {
length( string )
type( string )
url( string )
}
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
hour( Collection of string )
}
rssSkipDays {
day( Collection of string )
}
rssCloud {
path( string )
protocol( string )
port( int )
registerProcedure( string )
domain( string )
}
rssTextInput {
name( string )
link( anyURI )
description( string )
title( string )
}
POST/groups/{ID}/ratingsaddRating
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml
Name
Type
Description
Model
ID
path
string
body
entity
Rating
Rating {
UserID( string, required )
Rating( int, required )
ID( string, required )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xml
Status Code
Reason
Model
200
Success
Rating
Rating {
UserID( string )
Rating( int )
ID( string )
}
GET/groups/{ID}/picturegetImage
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
size
query
integer
Reponse
Produces image/jpeg
Status Code
Reason
Model
200
Success
byte
GET/groups/{ID}/avatargetDefaultAvatar
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
size
query
integer
Reponse
Produces image/png
Status Code
Reason
Model
200
Success
byte
GET/groups/{ID}/previewavatarpreviewAvatar
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
Provider
query
string
Reponse
Produces image/jpeg
Status Code
Reason
Model
200
Success
any
POST/groups/{ID}/pictureupdateImage
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
ID
path
string
body
entity
base64Binary
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
DELETE/groups/{ID}/picturedeleteImage
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
POST/groups/requests/{MembershipRequestID}/actionsexecuteWorkflowAction
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
MembershipRequestID
path
string
body
entity
Action
Action {
ActionParameter {
ActionName( string, required )
Parameters( Collection of ActionParameter, required )
UserID( string, required )
Comments( string )
}
ActionParameter {
Value( string )
Name( string, required )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/groups/requests/{MembershipRequestID}/historygetWorkflowHistory
Parameters
Name
Type
Description
Model
MembershipRequestID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
ProcessHistory
ProcessHistory {
HistoricalAction {
HistoricalAction( Collection of HistoricalAction )
}
HistoricalAction {
ActionName( string )
UserID( string )
Comments( string )
TimeTaken( dateTime )
}
DELETE/groups/{GroupID}/members/{UserID}removeMemberFromGroup
Parameters
Name
Type
Description
Model
GroupID
path
string
UserID
path
string
Comment
query
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
DELETE/groups/{ID}/ratings/{userID}deleteRating
Parameters
Name
Type
Description
Model
userID
path
string
ID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xml
PUT/groups/{ID}/ratings/{userID}updateRating
Parameters
Accepts application/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml
Name
Type
Description
Model
userID
path
string
ID
path
string
body
entity
Rating
Rating {
UserID( string, required )
Rating( int, required )
ID( string, required )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xml
Status Code
Reason
Model
200
Success
Rating
Rating {
UserID( string )
Rating( int )
ID( string )
}
GET/groups/{ID}/ratings/summarygetRatingSummary
Parameters
Name
Type
Description
Model
ID
path
string
Reponse
Produces text/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xml
Status Code
Reason
Model
200
Success
RatingSummary
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
GET/groups/{ID}/ratings/{userID}getRating
Parameters
Name
Type
Description
Model
ID
path
string
userID
path
string
Reponse
Produces text/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xml
Status Code
Reason
Model
200
Success
Rating
Rating {
UserID( string )
Rating( int )
ID( string )
}
GET/groups/{ID}/avatars/{version}.pnggetAvatar
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
version
path
string
size
query
integer
Reponse
Produces image/png
Status Code
Reason
Model
200
Success
byte
PUT/groups/{GroupID}/members/{UserID}/roleupdateMemberRole
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
GroupID
path
string
UserID
path
string
body
entity
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
GET/groups/avatar/{version}{Extension:(/[^/]+?)*}getDefaultVersionedAvatar
Parameters
Accepts */*
Name
Type
Description
Model
version
path
string
Extension
path
string
size
query
integer
Reponse
Produces image/png
Status Code
Reason
Model
200
Success
byte
