User API
{ http://soa.com/wsdl/user/1.0 } UserAPI
The Users service provides operations for managing users in the platform, such as adding, modifying, and deleting users and retrieving user information.
POST/usersaddUser
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
body
entity
User
User {
entry {
UserIdentificationChallenge {
UserPhone {
Description( string )
Email( string )
LastLoginDate( dateTime )
ProfileName( string )
Created( dateTime )
Industry( string )
Locked( boolean )
AvatarURL( anyURI )
Language( Collection of string )
Technology( Collection of string )
UserID( string )
Phone( string )
LockExpirationDate( dateTime )
classifiers( Collection of entry )
AcceptedAgreementID( Collection of string )
Disabled( boolean )
Password( string )
artifacts( Collection of entry )
HasPicture( boolean )
UserName( string )
Updated( dateTime )
AuthIdentifier( string )
FirstName( string )
PictureID( long )
Title( string )
LoginDomainID( string )
labels( Collection of entry )
ExpirationDate( dateTime )
State( string )
UserIdentificationChallenges( Collection of UserIdentificationChallenge, required )
Visibility( string )
EmailUpdated( dateTime )
LastName( string )
AvatarProvider( string )
ForcePasswordChangeOnLogin( boolean )
Domain( string )
userClaims( Collection of entry )
Link( string )
BusinessID( string )
Favorites( string )
UserPhones( Collection of UserPhone, required )
}
entry {
value( anyType )
key( string )
}
UserIdentificationChallenge {
Answer( string )
UserID( string )
ChallengeCode( string, required )
ChallengeQuestion( string )
}
UserPhone {
Type( string )
Verified( boolean )
Primary( boolean )
PhoneNumber( string )
CountryCode( string )
}
Reponse
Produces application/jsonapplication/xmltext/plainapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
User
User {
entry {
UserIdentificationChallenge {
UserPhone {
Description( string )
Email( string )
LastLoginDate( dateTime )
ProfileName( string )
Created( dateTime )
Industry( string )
Locked( boolean )
AvatarURL( anyURI )
Language( Collection of string )
Technology( Collection of string )
UserID( string )
Phone( string )
LockExpirationDate( dateTime )
classifiers( Collection of entry )
AcceptedAgreementID( Collection of string )
Disabled( boolean )
Password( string )
artifacts( Collection of entry )
HasPicture( boolean )
UserName( string )
Updated( dateTime )
AuthIdentifier( string )
FirstName( string )
PictureID( long )
Title( string )
LoginDomainID( string )
labels( Collection of entry )
ExpirationDate( dateTime )
State( string )
UserIdentificationChallenges( Collection of UserIdentificationChallenge )
Visibility( string )
EmailUpdated( dateTime )
LastName( string )
AvatarProvider( string )
ForcePasswordChangeOnLogin( boolean )
Domain( string )
userClaims( Collection of entry )
Link( string )
BusinessID( string )
Favorites( string )
UserPhones( Collection of UserPhone )
}
entry {
value( anyType )
key( string )
}
UserIdentificationChallenge {
Answer( string )
UserID( string )
ChallengeCode( string )
ChallengeQuestion( string )
}
UserPhone {
Type( string )
Verified( boolean )
Primary( boolean )
PhoneNumber( string )
CountryCode( string )
}
GET/users/{userID}getUser
Parameters
Name
Type
Description
Model
userID
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
User
User {
entry {
UserIdentificationChallenge {
UserPhone {
Description( string )
Email( string )
LastLoginDate( dateTime )
ProfileName( string )
Created( dateTime )
Industry( string )
Locked( boolean )
AvatarURL( anyURI )
Language( Collection of string )
Technology( Collection of string )
UserID( string )
Phone( string )
LockExpirationDate( dateTime )
classifiers( Collection of entry )
AcceptedAgreementID( Collection of string )
Disabled( boolean )
Password( string )
artifacts( Collection of entry )
HasPicture( boolean )
UserName( string )
Updated( dateTime )
AuthIdentifier( string )
FirstName( string )
PictureID( long )
Title( string )
LoginDomainID( string )
labels( Collection of entry )
ExpirationDate( dateTime )
State( string )
UserIdentificationChallenges( Collection of UserIdentificationChallenge )
Visibility( string )
EmailUpdated( dateTime )
LastName( string )
AvatarProvider( string )
ForcePasswordChangeOnLogin( boolean )
Domain( string )
userClaims( Collection of entry )
Link( string )
BusinessID( string )
Favorites( string )
UserPhones( Collection of UserPhone )
}
entry {
value( anyType )
key( string )
}
UserIdentificationChallenge {
Answer( string )
UserID( string )
ChallengeCode( string )
ChallengeQuestion( string )
}
UserPhone {
Type( string )
Verified( boolean )
Primary( boolean )
PhoneNumber( string )
CountryCode( string )
}
GET/users/mylogindomaingetMyLoginDomain
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
LoginDomain
LoginDomain {
DisplayMode( string )
FedmemberId( string )
LogoAssigned( boolean )
DomainName( string )
IdSystemType( string )
Title( string )
Enabled( boolean )
LogoId( long )
LoginDomainID( string )
Sequence( int )
VirtualHost( Collection of string )
}
POST/users/verifySignupverifySignup
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
signupCode
form
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
signupResponse
signupResponse {
UserPhone {
profileName( string )
lastName( string )
pendingTasks( Collection of string )
loginState( string )
loginDomainID( string )
pendingNotifications( int )
userName( string )
userID( string )
userPhones( Collection of UserPhone )
signupStatus( string )
firstName( string )
pendingAgreements( Collection of string )
emailAddress( string )
expired( boolean )
pendingTaskData( anyType )
domainName( string )
authTokenValidUntil( string )
state( string )
authIdentifier( string )
sessionValidUntil( string )
}
UserPhone {
Type( string )
Verified( boolean )
Primary( boolean )
PhoneNumber( string )
CountryCode( string )
}
POST/users/completeSignupcompleteSignup
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
signupCode
form
string
password
form
string
firstName
form
string
lastName
form
string
emailAddress
form
string
signupAgreementsAccepted
form
boolean
countryCode
form
string
phoneNumber
form
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
signupResponse
signupResponse {
UserPhone {
profileName( string )
lastName( string )
pendingTasks( Collection of string )
loginState( string )
loginDomainID( string )
pendingNotifications( int )
userName( string )
userID( string )
userPhones( Collection of UserPhone )
signupStatus( string )
firstName( string )
pendingAgreements( Collection of string )
emailAddress( string )
expired( boolean )
pendingTaskData( anyType )
domainName( string )
authTokenValidUntil( string )
state( string )
authIdentifier( string )
sessionValidUntil( string )
}
UserPhone {
Type( string )
Verified( boolean )
Primary( boolean )
PhoneNumber( string )
CountryCode( string )
}
POST/users/completeSignupcompleteSignupAdvanced
Parameters
Accepts application/json application/vnd.soa.v84+json
Name
Type
Description
Model
body
entity
CompleteSignUpUser
CompleteSignUpUser {
entry {
FirstName( string )
SignupAgreementsAccepted( boolean )
classifiers( Collection of entry )
PhoneNumber( string )
LastName( string )
SignupCode( string )
CountryCode( string )
EmailAddress( string )
Password( string )
artifacts( Collection of entry )
}
entry {
value( anyType )
key( string )
}
Reponse
Produces application/jsonapplication/vnd.soa.v84+json
Status Code
Reason
Model
200
Success
signupResponse
signupResponse {
UserPhone {
profileName( string )
lastName( string )
pendingTasks( Collection of string )
loginState( string )
loginDomainID( string )
pendingNotifications( int )
userName( string )
userID( string )
userPhones( Collection of UserPhone )
signupStatus( string )
firstName( string )
pendingAgreements( Collection of string )
emailAddress( string )
expired( boolean )
pendingTaskData( anyType )
domainName( string )
authTokenValidUntil( string )
state( string )
authIdentifier( string )
sessionValidUntil( string )
}
UserPhone {
Type( string )
Verified( boolean )
Primary( boolean )
PhoneNumber( string )
CountryCode( string )
}
POST/users/resendActivationresendActivation
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
emailAddress
form
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
POST/users/invitationsinviteUserToPlatform
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
body
entity
UserInviteRequest
UserInviteRequest {
Message( string )
EmailAddresses( Collection of 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
string
DELETE/users/{userID}deleteUser
Parameters
Name
Type
Description
Model
userID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
POST/users/verifyInvitationverifyInvitation
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
validationCode
form
string
Reponse
Produces application/jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
signupResponse
signupResponse {
UserPhone {
profileName( string )
lastName( string )
pendingTasks( Collection of string )
loginState( string )
loginDomainID( string )
pendingNotifications( int )
userName( string )
userID( string )
userPhones( Collection of UserPhone )
signupStatus( string )
firstName( string )
pendingAgreements( Collection of string )
emailAddress( string )
expired( boolean )
pendingTaskData( anyType )
domainName( string )
authTokenValidUntil( string )
state( string )
authIdentifier( string )
sessionValidUntil( string )
}
UserPhone {
Type( string )
Verified( boolean )
Primary( boolean )
PhoneNumber( string )
CountryCode( string )
}
PUT/users/{userID}modifyUser
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
userID
path
string
body
entity
User
User {
entry {
UserIdentificationChallenge {
UserPhone {
Description( string )
Email( string )
LastLoginDate( dateTime )
ProfileName( string )
Created( dateTime )
Industry( string )
Locked( boolean )
AvatarURL( anyURI )
Language( Collection of string )
Technology( Collection of string )
UserID( string )
Phone( string )
LockExpirationDate( dateTime )
classifiers( Collection of entry )
AcceptedAgreementID( Collection of string )
Disabled( boolean )
Password( string )
artifacts( Collection of entry )
HasPicture( boolean )
UserName( string )
Updated( dateTime )
AuthIdentifier( string )
FirstName( string )
PictureID( long )
Title( string )
LoginDomainID( string )
labels( Collection of entry )
ExpirationDate( dateTime )
State( string )
UserIdentificationChallenges( Collection of UserIdentificationChallenge, required )
Visibility( string )
EmailUpdated( dateTime )
LastName( string )
AvatarProvider( string )
ForcePasswordChangeOnLogin( boolean )
Domain( string )
userClaims( Collection of entry )
Link( string )
BusinessID( string )
Favorites( string )
UserPhones( Collection of UserPhone, required )
}
entry {
value( anyType )
key( string )
}
UserIdentificationChallenge {
Answer( string )
UserID( string )
ChallengeCode( string, required )
ChallengeQuestion( string )
}
UserPhone {
Type( string )
Verified( boolean )
Primary( boolean )
PhoneNumber( string )
CountryCode( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
POST/users/validateEmailChangeCodevalidateEmailChangeCode
Parameters
Accepts application/json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
body
entity
emailChangeRequest
emailChangeRequest {
password( string )
changeCode( string )
newEmailAddress( string )
}
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
emailChangeResponse
emailChangeResponse {
userIdentificationChallenge {}
userIdentificationChallenge( userIdentificationChallenge )
changeStatus( boolean )
userName( string )
newEmailAddress( string )
}
userIdentificationChallenge {}
GET/users/{UserID}/challengesgetChallenges
Parameters
Name
Type
Description
Model
UserID
path
string
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
UserIdentificationChallenges
UserIdentificationChallenges {
UserIdentificationChallenge {
UserIdentificationChallenge( Collection of UserIdentificationChallenge )
}
UserIdentificationChallenge {
Answer( string )
UserID( string )
ChallengeCode( string )
ChallengeQuestion( string )
}
GET/users/{UserID}/appslistApps
Parameters
Accepts */*
Name
Type
Description
Model
UserID
path
string
includeVersions
query
boolean
start
query
integer
count
query
integer
versionCount
query
integer
LimitToConnectedWithAPIVersion
query
string
LimitToAppsWithActivatedConnections
query
boolean
LimitToConnectedInEnvironmentOnly
query
string
IncludeTags
query
boolean
Reponse
Produces application/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Applications
Applications {
Application {
ApplicationVersion {
RatingSummary {
AppVersionSettings {
TargetResource {
Image {
entry {
AppSettings {
Application( Collection of Application )
}
Application {
Connections( long )
Description( string )
ApplicationVersion( ApplicationVersion )
AppSettings( AppSettings )
ApplicationVersions( Collection of ApplicationVersion )
Rating( float )
DefaultVersionID( string )
TeamID( string )
Image( Image )
Name( string )
Created( dateTime )
AvatarURL( anyURI )
AppID( string )
RatingSummary( RatingSummary )
Updated( dateTime )
PictureID( long )
Followers( long )
TargetResources( Collection of TargetResource )
State( string )
Summary( string )
Visibility( string )
Tag( Collection of string )
IsFollowed( boolean )
BusinessID( string )
InitialEnvironment( string )
}
ApplicationVersion {
RatingSummary( RatingSummary )
SharedSecret( string )
Description( string )
Updated( dateTime )
HasKeyInfo( boolean )
SecurityMechanisms( Collection of string )
AppVersionSettings( AppVersionSettings )
CurrentEnvironment( string )
WebsiteAddress( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
labels( Collection of entry )
EncryptedSharedSecret( string )
AppID( string )
State( string )
classifiers( Collection of entry )
Visibility( string )
Tag( Collection of string )
RuntimeID( string )
Identity( string )
InitialEnvironment( string )
artifacts( Collection of entry )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
AppVersionSettings {
SimultaneousSandboxProductAccessSupport( string )
ReturnPlainTextSharedSecret( string )
AppRatingsSupport( string )
UserDefinedIdentitySupport( string )
AppReviewsSupport( string )
AppBoardSupport( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
entry {
value( anyType )
key( string )
}
AppSettings {
SimultaneousSandboxProductAccessSupport( string )
PublicAppRatingsSupport( string )
PrivateAppReviewsSupport( string )
AppPromotionSupport( string )
PublicAppSupport( string )
RegisteredUsersAppRatingsSupport( string )
PrivateAppRatingsSupport( string )
RegisteredUsersAppReviewsSupport( string )
PublicAppBoardSupport( string )
PrivateAppBoardSupport( string )
PrivateAppSupport( string )
ContractPoliciesSupport( string )
PublicAppReviewsSupport( string )
ReturnPlainTextSharedSecret( string )
UserDefinedIdentitySupport( string )
RegisteredUsersAppSupport( string )
}
GET/users/{UserID}/permissionsgetUserPermissions
Parameters
Name
Type
Description
Model
UserID
path
string
ScopeID
query
string
ResourceID
query
string
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
UserPermissions
UserPermissions {
ScopePermissions {
ResourceTypePermissions {
ResourcePermissions {
ScopePermissions( ScopePermissions )
UserID( string )
ResourcePermissions( ResourcePermissions )
}
ScopePermissions {
ScopeID( string )
ResourceTypePermissions( Collection of ResourceTypePermissions )
}
ResourceTypePermissions {
Permissions( Collection of string )
ResourceType( string )
}
ResourcePermissions {
ResourceID( string )
Permissions( Collection of string )
}
GET/users/{UserID}/auzstatusgetAuthorizationResult
Parameters
Name
Type
Description
Model
UserID
path
string
ResourceID
query
string
ResourceKey
query
string
ScopeID
query
string
ResourceType
query
string
Action
query
string
Role
query
string
AuthorizeAll
query
boolean
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
AuthorizationResult
AuthorizationResult {
ResourceID( string )
UserID( string )
PermissionName( string )
ScopeID( string )
ResourceType( string )
Result( string )
}
GET/users/{UserID}/notificationsgetNotifications
Parameters
Accepts */*
Name
Type
Description
Model
UserID
path
string
start
query
integer
count
query
integer
Reponse
Produces text/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/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 )
}
POST/users/{userID}/invitationsinviteUser
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
userID
path
string
body
entity
UserInviteRequest
UserInviteRequest {
Message( string )
EmailAddresses( Collection of 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
string
GET/users/{userID}/avatarprovidersgetAvatarProviders
Parameters
Name
Type
Description
Model
userID
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
AvatarProviders
AvatarProviders {
AvatarProvider {
AvatarProvider( Collection of AvatarProvider )
}
AvatarProvider {
Type( string )
Url( string )
}
GET/users/{UserID}/preferencesgetUserPreferences
Parameters
Name
Type
Description
Model
UserID
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
UserPreferences
UserPreferences {
UserPreference {
UserPreference( Collection of UserPreference )
}
UserPreference {
Value( string )
Name( string )
}
POST/users/{UserID}/preferencessavePreference
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
UserID
path
string
body
entity
UserPreference
UserPreference {
Value( string )
Name( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/users/{UserID}/attributeslistUserAttributes
Parameters
Name
Type
Description
Model
UserID
path
string
Federation
query
boolean
UserGroups
query
string
LeaderGroups
form
string
AdminGroups
form
string
TokenNames
query
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
UserAttributes
UserAttributes {
UserAttribute {
UserAttribute( Collection of UserAttribute )
}
UserAttribute {
ResourceID( string )
ResourceType( string )
}
POST/users/{UserID}/attributeslistUserAttributesPOST
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
UserID
path
string
Federation
form
boolean
UserGroups
form
string
LeaderGroups
form
string
AdminGroups
form
string
TokenNames
form
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
UserAttributes
UserAttributes {
UserAttribute {
UserAttribute( Collection of UserAttribute )
}
UserAttribute {
ResourceID( string )
ResourceType( string )
}
POST/users/{UserID}/tokengenerateAuthToken
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
UserID
path
string
UserName
form
string
UserAttributes
form
string
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xmltext/plain
Status Code
Reason
Model
200
Success
loginResponse
loginResponse {
pendingTasks( Collection of string )
loginState( string )
avatarURL( string )
authToken( string )
lastLoginDate( string )
loginDomainID( string )
pendingNotifications( int )
userName( string )
pendingAgreements( Collection of string )
csrfToken( string )
pendingTaskData( anyType )
authTokenValidUntil( string )
sessionValidUntil( string )
status( string )
userFDN( string )
}
PUT/users/{UserID}/propertiessaveExtensionProperties
Parameters
Accepts application/json application/xml application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+xml
Name
Type
Description
Model
UserID
path
string
body
entity
UserExtensionProperties
UserExtensionProperties {
entry {
classifiers( Collection of entry )
artifacts( Collection of entry )
}
entry {
value( anyType )
key( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
UserExtensionProperties
UserExtensionProperties {
entry {
classifiers( Collection of entry )
artifacts( Collection of entry )
}
entry {
value( anyType )
key( string )
}
GET/users/{UserID}/topapisgetTopApis
Parameters
Name
Type
Description
Model
UserID
path
string
Reponse
Produces application/jsonapplication/vnd.akana.v2020+json
Status Code
Reason
Model
200
Success
UserTopAPIs
UserTopAPIs {
UserTopAPI {
UserTopAPI( Collection of UserTopAPI )
}
UserTopAPI {
AvatarURL( anyURI )
ApiName( string )
APIID( string )
}
POST/users/{UserID}/topapisaddTopApi
Parameters
Accepts application/json application/vnd.akana.v2020+json
Name
Type
Description
Model
UserID
path
string
body
entity
UserTopAPI
UserTopAPI {
AvatarURL( anyURI )
ApiName( string )
APIID( string, required )
}
Reponse
Produces application/jsonapplication/vnd.akana.v2020+json
Status Code
Reason
Model
200
Success
UserTopAPI
UserTopAPI {
AvatarURL( anyURI )
ApiName( string )
APIID( string )
}
GET/users/{UserID}/mydashboardgetUserTopApisMetrics
Parameters
Name
Type
Description
Model
UserID
path
string
StartDate
query
string
EndDate
query
string
TimeZone
query
string
TimeInterval
query
string
Duration
query
string
SelectedApis
query
string
Reponse
Produces application/jsonapplication/vnd.akana.v2020+json
Status Code
Reason
Model
200
Success
ApisMetrics
ApisMetrics {
ApiMetrics {
IntervalType {
GeoLocationMetric {
Metric {
EndTime( dateTime )
StartTime( dateTime )
ApiMetrics( Collection of ApiMetrics )
}
ApiMetrics {
ApiName( string )
APIID( string )
Interval( Collection of IntervalType )
}
IntervalType {
StartTime( dateTime )
GeoLocationMetric( Collection of GeoLocationMetric )
Metric( Collection of Metric )
}
GeoLocationMetric {
Latitude( double )
Count( unsignedInt )
Longitude( double )
Location( string )
}
Metric {
Value( int )
Key( string )
Name( string )
}
POST/users/{UserID}/delete-board-itemsdeleteUserBoardItems
Parameters
Accepts application/json application/vnd.akana.v2019+json
Name
Type
Description
Model
UserID
path
string
body
entity
BoardItemFDNs
BoardItemFDNs {
BoardItemID( string, required )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/users/{UserID}/settingsgetAccountSettings
Parameters
Accepts */*
Name
Type
Description
Model
UserID
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
AccountSettings
AccountSettings {
OptedNotification( Collection of string )
Email( string )
UserID( string )
Phone( string )
NotifyMechanism( Collection of string )
Password( string )
}
PUT/users/{UserID}/settingsmodifyAccountSettings
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
UserID
path
string
body
entity
AccountSettings
AccountSettings {
OptedNotification( Collection of string )
Email( string )
UserID( string )
Phone( string )
NotifyMechanism( Collection of string )
Password( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/users/{UserID}/appsgetApps
Parameters
Accepts */*
Name
Type
Description
Model
UserID
path
string
includeVersions
query
boolean
start
query
integer
count
query
integer
versionCount
query
integer
LimitToConnectedAppsWithAPIVersion
query
string
LimitToAppsWithActivatedConnections
query
boolean
LimitToConnectedAppsInEnvironment
query
string
IncludeTags
query
boolean
Reponse
Produces text/xmlapplication/rss+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 )
}
GET/users/{UserID}/groupsgetMyGroups
Parameters
Name
Type
Description
Model
UserID
path
string
Reponse
Produces application/jsontext/xmlapplication/rss+xmlapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/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/users/{UserID}/apislistApis
Parameters
Name
Type
Description
Model
UserID
path
string
count
query
integer
Reponse
Produces application/vnd.akana.v2020+json
Status Code
Reason
Model
200
Success
APIs
APIs {
API {
RatingSummary {
TargetResource {
Image {
APIVersion {
APIVersionResourceDetails {
Resource {
OperationResourceDetails {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
APIImplementation {
DeploymentZonesHostingInfo {
DeploymentZoneEndpoint {
APIBinding {
BindingOperation {
HttpOperation {
Input {
Policy {
ServiceReference {
Endpoint {
ConnectionProperty {
APIInterface {
InterfaceOperation {
OperationOAuthDetails {
Operation {
entry {
stringArray {
APIDesign {
Descriptor {
Links {
TargetAPI {
APIVersionSettings {
APISettings {
API( Collection of API )
}
API {
RatingSummary( RatingSummary )
Description( string )
Updated( dateTime )
PictureID( long )
APIID( string )
Name( string )
Created( dateTime )
TargetResources( Collection of TargetResource )
OrganizationKey( string )
AvatarURL( anyURI )
LatestVersionID( string )
APIVersion( APIVersion )
AdminGroupID( string )
State( string )
APISettings( APISettings )
Summary( string )
Visibility( string )
Tag( Collection of string )
IsFollowed( boolean )
InUserTop( boolean )
BusinessID( string )
}
RatingSummary {
Five( int )
Four( int )
One( int )
Two( int )
Three( int )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
APIVersion {
DefaultProfile( string )
APIVersionResourceDetails( APIVersionResourceDetails )
Description( string )
SandboxEndpointOAuthDetailsList( Collection of EndpointOAuthDetails )
ProductionEndpointAccessAutoApproved( boolean )
ProductionEndpointExists( boolean )
SandboxEndpointAccessAutoApproved( boolean )
APIImplementations( Collection of APIImplementation )
APIVersionID( string )
Name( string )
Created( dateTime )
Endpoints( Collection of Endpoint )
SandboxAnonymousAccessAllowed( boolean )
SandboxEndpointExists( boolean )
ProductionAnonymousAccessAllowed( boolean )
SandboxServiceKey( string )
classifiers( Collection of entry )
Operations( Collection of Operation )
APIVersionOAuthResourceMapping( Collection of string )
artifacts( Collection of entry )
ProductionEndpointOAuthDetails( EndpointOAuthDetails )
ProductionEndpointOAuthDetailsList( Collection of EndpointOAuthDetails )
RatingSummary( RatingSummary )
DefaultFaultContentType( string )
SandboxEndpoint( anyURI )
Updated( dateTime )
ResourceLevelPermissionsSupported( boolean )
ProductionEndpoint( anyURI )
APIDesign( APIDesign )
APIID( string )
TargetResources( Collection of TargetResource )
labels( Collection of entry )
SandboxEndpointOAuthDetails( EndpointOAuthDetails )
Type( string )
APIOwnedImplementations( boolean )
State( string )
Environment( string )
Descriptor( Descriptor )
Links( Collection of Links )
Visibility( string )
Tag( Collection of string )
ProductionServiceKey( string )
DefaultInputContentType( string )
TargetAPI( TargetAPI )
DefaultOutputContentType( string )
APIVersionSettings( APIVersionSettings )
}
APIVersionResourceDetails {
Resource( Collection of Resource )
SupportsLicenses( boolean )
OperationResourceDetails( Collection of OperationResourceDetails )
}
Resource {
OAuthGrantDefaultResource( boolean )
ChildResources( Collection of Resource )
Name( string )
ShortDescription( string )
SandboxAnonymousAccessAllowed( boolean )
LongDescription( string )
ParentResourceID( string )
ResourcePath( string )
ResourceID( string )
ProductionAnonymousAccessAllowed( boolean )
OAuthGrantUserAuthorizationRequired( boolean )
Visibility( string )
BusinessID( string )
}
OperationResourceDetails {
OperationName( string )
Resource( Collection of Resource )
OperationKey( string )
}
EndpointOAuthDetails {
OAuthTokenResourceURISettings( OAuthTokenResourceURISettings )
OAuth20Settings( OAuth20Settings )
OAuth10aSupported( boolean )
Resource( Collection of string )
TokenEndpointParameters( Collection of string )
ClientAuthPolicyOption( Collection of string )
OAuth10aSettings( OAuth10aSettings )
AuthorizationEndpointParameters( Collection of string )
OAuthProvider( string )
PlatformAppIdentitiesInUse( boolean )
SupportedGrant( Collection of string )
OAuth20Supported( boolean )
}
OAuthTokenResourceURISettings {
OAuthTokenRequestURI( string )
OAuthTokenResourceURIOption( string )
}
OAuth20Settings {
TokenEndpointURL( anyURI )
TokenEndpointRequestVerb( string )
BearerTokenMethods( Collection of string )
AuthorizationEndpointURL( anyURI )
}
OAuth10aSettings {
TokenEndpointRequestVerb( string )
AuthorizationEndpointURL( anyURI )
AccessTokenEndpointURL( anyURI )
TokenParameterTransmissionMethods( Collection of string )
RequestTokenEndpointURL( anyURI )
}
APIImplementation {
Pattern( string )
APIImplementationDeployments( Collection of DeploymentZonesHostingInfo )
Description( string )
APIBindings( Collection of APIBinding )
Policies( Collection of Policy )
ImplementationCode( string )
EndpointOAuthDetailsList( Collection of EndpointOAuthDetails )
ServiceKey( string )
ProxiedService( ServiceReference )
EndpointOAuthDetails( EndpointOAuthDetails )
Name( string )
AccessPoints( Collection of string )
Endpoints( Collection of Endpoint )
ServiceDetails( ServiceReference )
Environment( string )
AnonymousAccessAllowed( boolean )
APIOwnedImplementation( boolean )
APIInterfaces( Collection of APIInterface )
Operations( Collection of Operation )
EndpointAccessAutoApproved( boolean )
}
DeploymentZonesHostingInfo {
DeploymentZoneID( string )
DeploymentZoneEndpoint( Collection of DeploymentZoneEndpoint )
}
DeploymentZoneEndpoint {
Path( string )
EndpointHostName( string )
Public( boolean )
ListenerName( string )
ContainerKey( string )
Url( string )
EndpointPath( string )
UseServiceIdentityForSNI( boolean )
GatewayHostPath( string )
DeploymentZoneID( string )
GatewayHostName( string )
BindingType( string )
EndpointKey( string )
Protocol( string )
BindingQName( string )
}
APIBinding {
BindingOperations( Collection of BindingOperation )
BindingKey( string )
BindingType( string )
InterfaceKey( string )
BindingQName( string )
InterfaceQName( string )
}
BindingOperation {
SOAPAction( string )
WsdlOperationName( string )
OperationName( string )
HttpOperation( HttpOperation )
BindingOperationKey( string )
}
HttpOperation {
Path( string )
OutputContentType( string )
FaultContentType( string )
Input( Collection of Input )
InputContentType( string )
Method( string )
}
Input {
Type( string )
Value( string )
Name( string )
}
Policy {
PolicyType( string )
PolicyKey( string )
Description( string )
PolicySubType( string )
PolicyConfiguration( string )
BusinessID( string )
Name( string )
}
ServiceReference {
Endpoints( Collection of Endpoint )
ServiceName( string )
ServiceType( string )
ServiceKey( string )
ServiceManagementState( string )
OrganizationKey( string )
}
Endpoint {
BindingType( string )
ConnectionProperties( Collection of ConnectionProperty )
EndpointKey( string )
Uri( anyURI )
BindingQName( string )
}
ConnectionProperty {
Value( string )
Name( string )
}
APIInterface {
InterfaceOperations( Collection of InterfaceOperation )
InterfaceKey( string )
InterfaceQName( string )
}
InterfaceOperation {
WsdlOperationName( string )
OperationName( string )
OAuthDetails( OperationOAuthDetails )
}
OperationOAuthDetails {
WsdlOperationName( string )
OperationName( string )
Resource( Collection of string )
OperationKey( string )
InterfaceQName( string )
}
Operation {
Path( string )
OutputContentType( string )
FaultContentType( string )
WsdlOperationName( string )
Input( Collection of Input )
InputContentType( string )
OAuthDetails( OperationOAuthDetails )
Method( string )
OperationKey( string )
OperationResourceDetails( OperationResourceDetails )
Name( string )
InterfaceQName( string )
}
entry {
value( stringArray )
key( string )
}
stringArray {
item( Collection of string )
}
APIDesign {
BindingType( Collection of string )
CommonDesign( boolean )
DesignServiceKey( string )
}
Descriptor {
WsdlURL( string )
WsdlId( long )
}
Links {
rel( string )
href( string )
type( string )
title( string )
}
TargetAPI {
DefaultProfile( string )
APIBindings( Collection of APIBinding )
DefaultFaultContentType( string )
Endpoints( Collection of Endpoint )
SandboxEndpointOAuthDetails( EndpointOAuthDetails )
Type( string )
SandboxServiceKey( string )
Descriptor( Descriptor )
ProductionServiceKey( string )
DefaultInputContentType( string )
Operations( Collection of Operation )
APIInterfaces( Collection of APIInterface )
DefaultOutputContentType( string )
ProductionEndpointOAuthDetails( EndpointOAuthDetails )
}
APIVersionSettings {
SandboxEndpointSupport( string )
PrivateAPIGroupTypeSupport( string )
ReviewsSupport( string )
ProductionAutoApprovalSupport( string )
PrivateAPIIndependentGroupSupport( string )
SandboxAutoApprovalSupport( string )
ResourceLevelPermissionsSupport( string )
RatingsSupport( string )
BoardSupport( string )
ProductionEndpointSupport( string )
}
APISettings {
PrivateAPIRatingsSupport( string )
PrivateAPIGroupTypeSupport( string )
PrivateAPIBoardSupport( string )
PublicAPISandboxEndpointSupport( string )
PublicAPIRatingsSupport( string )
PrivateAPIIndependentGroupSupport( string )
PrivateAPIResourceLevelPermissionsSupport( string )
PublicAPIReviewsSupport( string )
PublicAPISandboxAutoApprovalSupport( string )
PublicAPIProductionAutoApprovalSupport( string )
ValidateUniqueContextPath( string )
PublicAPIResourceLevelPermissionsSupport( string )
PrivateAPISandboxEndpointSupport( string )
PrivateAPISupport( string )
PrivateAPISandboxAutoApprovalSupport( string )
PrivateAPIProductionEndpointSupport( string )
PublicAPIBoardSupport( string )
PrivateAPIReviewsSupport( string )
PublicAPIProductionEndpointSupport( string )
PublicAPISupport( string )
PrivateAPIProductionAutoApprovalSupport( string )
}
PUT/users/{UserID}/statuschangeStatus
Parameters
Accepts application/json application/xml application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+xml
Name
Type
Description
Model
UserID
path
string
body
entity
ChangeUserStatusRequest
ChangeUserStatusRequest {
Comments( string, required )
UserStatus( string, required )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
User
User {
entry {
UserIdentificationChallenge {
UserPhone {
Description( string )
Email( string )
LastLoginDate( dateTime )
ProfileName( string )
Created( dateTime )
Industry( string )
Locked( boolean )
AvatarURL( anyURI )
Language( Collection of string )
Technology( Collection of string )
UserID( string )
Phone( string )
LockExpirationDate( dateTime )
classifiers( Collection of entry )
AcceptedAgreementID( Collection of string )
Disabled( boolean )
Password( string )
artifacts( Collection of entry )
HasPicture( boolean )
UserName( string )
Updated( dateTime )
AuthIdentifier( string )
FirstName( string )
PictureID( long )
Title( string )
LoginDomainID( string )
labels( Collection of entry )
ExpirationDate( dateTime )
State( string )
UserIdentificationChallenges( Collection of UserIdentificationChallenge )
Visibility( string )
EmailUpdated( dateTime )
LastName( string )
AvatarProvider( string )
ForcePasswordChangeOnLogin( boolean )
Domain( string )
userClaims( Collection of entry )
Link( string )
BusinessID( string )
Favorites( string )
UserPhones( Collection of UserPhone )
}
entry {
value( anyType )
key( string )
}
UserIdentificationChallenge {
Answer( string )
UserID( string )
ChallengeCode( string )
ChallengeQuestion( string )
}
UserPhone {
Type( string )
Verified( boolean )
Primary( boolean )
PhoneNumber( string )
CountryCode( string )
}
GET/users/{UserID}/boardgetBoard
Parameters
Name
Type
Description
Model
UserID
path
string
ItemType
query
string
DiscussionType
query
string
APIID
query
string
TicketLabel
query
string
TicketState
query
string
AppID
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
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.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/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/users/{UserID}/logindomaingetLoginDomain
Parameters
Name
Type
Description
Model
UserID
path
string
cache
query
boolean
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
LoginDomain
LoginDomain {
DisplayMode( string )
FedmemberId( string )
LogoAssigned( boolean )
DomainName( string )
IdSystemType( string )
Title( string )
Enabled( boolean )
LogoId( long )
LoginDomainID( string )
Sequence( int )
VirtualHost( Collection of string )
}
POST/users/{userID}/sendEmailChangeCodesendEmailChangeCode
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
userID
path
string
newEmailAddress
form
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
PUT/users/{userID}/passwordmodifyPassword
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
userID
path
string
body
entity
PasswordChange
PasswordChange {
NewPassword( string )
ForcePasswordChangeOnLogin( boolean )
OldPassword( string )
NewEmail( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/users/{UserID}/followingsgetFollowings
Parameters
Accepts */*
Name
Type
Description
Model
UserID
path
string
Type
query
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/users/{UserID}/rolesgetUserRoles
Parameters
Accepts */*
Name
Type
Description
Model
UserID
path
string
ResourceID
query
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
UserRoles
UserRoles {
RoleName( Collection of string )
}
PUT/users/{UserID}/challengessaveChallenges
Parameters
Accepts application/json application/xml application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+xml
Name
Type
Description
Model
UserID
path
string
body
entity
UserIdentificationChallenges
UserIdentificationChallenges {
UserIdentificationChallenge {
UserIdentificationChallenge( Collection of UserIdentificationChallenge, required )
}
UserIdentificationChallenge {
Answer( string )
UserID( string )
ChallengeCode( string, required )
ChallengeQuestion( string )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
UserIdentificationChallenges
UserIdentificationChallenges {
UserIdentificationChallenge {
UserIdentificationChallenge( Collection of UserIdentificationChallenge )
}
UserIdentificationChallenge {
Answer( string )
UserID( string )
ChallengeCode( string )
ChallengeQuestion( string )
}
GET/users/{UserID}/apisgetApis
Parameters
Accepts */*
Name
Type
Description
Model
UserID
path
string
includeVersions
query
boolean
start
query
integer
count
query
integer
versionCount
query
integer
Reponse
Produces text/xmlapplication/rss+xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/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/users/{UserID}/followersgetFollowers
Parameters
Accepts */*
Name
Type
Description
Model
UserID
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/users/{UserID}/statusgetStatus
Parameters
Accepts */*
Name
Type
Description
Model
UserID
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
UserStatus
UserStatus {
Discussions( int )
APIs( int )
Tickets( int )
Followings( int )
}
GET/users/{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/users/{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/users/{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/users/{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/users/{ID}/picturedeleteImage
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
POST/users/{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/users/{UserID}/following/{ResourceID}getFollowing
Parameters
Accepts */*
Name
Type
Description
Model
UserID
path
string
ResourceID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/users/{UserID}/preferences/{PreferenceName}getUserPreference
Parameters
Name
Type
Description
Model
UserID
path
string
PreferenceName
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
UserPreference
UserPreference {
Value( string )
Name( string )
}
GET/users/{UserID}/notifications/countgetNotificationsCount
Parameters
Accepts */*
Name
Type
Description
Model
UserID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
PUT/users/{UserID}/registration/statechangeSignupState
Parameters
Accepts application/json application/xml application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+xml
Name
Type
Description
Model
UserID
path
string
body
entity
ChangeSignupStateRequest
ChangeSignupStateRequest {
Comments( string, required )
SignupState( string, required )
}
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
User
User {
entry {
UserIdentificationChallenge {
UserPhone {
Description( string )
Email( string )
LastLoginDate( dateTime )
ProfileName( string )
Created( dateTime )
Industry( string )
Locked( boolean )
AvatarURL( anyURI )
Language( Collection of string )
Technology( Collection of string )
UserID( string )
Phone( string )
LockExpirationDate( dateTime )
classifiers( Collection of entry )
AcceptedAgreementID( Collection of string )
Disabled( boolean )
Password( string )
artifacts( Collection of entry )
HasPicture( boolean )
UserName( string )
Updated( dateTime )
AuthIdentifier( string )
FirstName( string )
PictureID( long )
Title( string )
LoginDomainID( string )
labels( Collection of entry )
ExpirationDate( dateTime )
State( string )
UserIdentificationChallenges( Collection of UserIdentificationChallenge )
Visibility( string )
EmailUpdated( dateTime )
LastName( string )
AvatarProvider( string )
ForcePasswordChangeOnLogin( boolean )
Domain( string )
userClaims( Collection of entry )
Link( string )
BusinessID( string )
Favorites( string )
UserPhones( Collection of UserPhone )
}
entry {
value( anyType )
key( string )
}
UserIdentificationChallenge {
Answer( string )
UserID( string )
ChallengeCode( string )
ChallengeQuestion( string )
}
UserPhone {
Type( string )
Verified( boolean )
Primary( boolean )
PhoneNumber( string )
CountryCode( string )
}
PUT/users/{UserID}/domains/{DomainID}changeUserDomain
Parameters
Accepts application/json application/xml application/vnd.soa.v84+json application/vnd.soa.v84+xml
Name
Type
Description
Model
UserID
path
string
DomainID
path
string
body
entity
ChangeUserDomainRequest
ChangeUserDomainRequest {
Comments( string, required )
UserDomain( string, required )
}
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v84+jsonapplication/vnd.soa.v84+xml
Status Code
Reason
Model
200
Success
User
User {
entry {
UserIdentificationChallenge {
UserPhone {
Description( string )
Email( string )
LastLoginDate( dateTime )
ProfileName( string )
Created( dateTime )
Industry( string )
Locked( boolean )
AvatarURL( anyURI )
Language( Collection of string )
Technology( Collection of string )
UserID( string )
Phone( string )
LockExpirationDate( dateTime )
classifiers( Collection of entry )
AcceptedAgreementID( Collection of string )
Disabled( boolean )
Password( string )
artifacts( Collection of entry )
HasPicture( boolean )
UserName( string )
Updated( dateTime )
AuthIdentifier( string )
FirstName( string )
PictureID( long )
Title( string )
LoginDomainID( string )
labels( Collection of entry )
ExpirationDate( dateTime )
State( string )
UserIdentificationChallenges( Collection of UserIdentificationChallenge )
Visibility( string )
EmailUpdated( dateTime )
LastName( string )
AvatarProvider( string )
ForcePasswordChangeOnLogin( boolean )
Domain( string )
userClaims( Collection of entry )
Link( string )
BusinessID( string )
Favorites( string )
UserPhones( Collection of UserPhone )
}
entry {
value( anyType )
key( string )
}
UserIdentificationChallenge {
Answer( string )
UserID( string )
ChallengeCode( string )
ChallengeQuestion( string )
}
UserPhone {
Type( string )
Verified( boolean )
Primary( boolean )
PhoneNumber( string )
CountryCode( string )
}
DELETE/users/{UserID}/topapis/{ApiID}deleteTopApi
Parameters
Name
Type
Description
Model
UserID
path
string
ApiID
path
string
Reponse
Produces application/jsonapplication/vnd.akana.v2020+json
PUT/users/{UserID}/notifications/statechangeNotificationsState
Parameters
Accepts application/json application/vnd.soa.v84+json
Name
Type
Description
Model
UserID
path
string
body
entity
NotificationsState
NotificationsState {
NotificationID( Collection of string )
State( string, required )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/users/{UserID}/feeds/homefeedgetHomeFeed
Parameters
Accepts */*
Name
Type
Description
Model
UserID
path
string
AppID
query
string
APIID
query
string
ItemType
query
string
DiscussionType
query
string
TicketLabel
query
string
TicketState
query
string
ItemID
query
string
Tag
query
string
IncludeComments
query
boolean
NumberOfComments
query
integer
IncludeActions
query
boolean
start
query
integer
count
query
integer
SortBy
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.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/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 )
}
POST/users/signupUser{invitationCode:(/[^/]+?)?}signupUser
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
invitationCode
path
string
body
entity
User
User {
entry {
UserIdentificationChallenge {
UserPhone {
Description( string )
Email( string )
LastLoginDate( dateTime )
ProfileName( string )
Created( dateTime )
Industry( string )
Locked( boolean )
AvatarURL( anyURI )
Language( Collection of string )
Technology( Collection of string )
UserID( string )
Phone( string )
LockExpirationDate( dateTime )
classifiers( Collection of entry )
AcceptedAgreementID( Collection of string )
Disabled( boolean )
Password( string )
artifacts( Collection of entry )
HasPicture( boolean )
UserName( string )
Updated( dateTime )
AuthIdentifier( string )
FirstName( string )
PictureID( long )
Title( string )
LoginDomainID( string )
labels( Collection of entry )
ExpirationDate( dateTime )
State( string )
UserIdentificationChallenges( Collection of UserIdentificationChallenge, required )
Visibility( string )
EmailUpdated( dateTime )
LastName( string )
AvatarProvider( string )
ForcePasswordChangeOnLogin( boolean )
Domain( string )
userClaims( Collection of entry )
Link( string )
BusinessID( string )
Favorites( string )
UserPhones( Collection of UserPhone, required )
}
entry {
value( anyType )
key( string )
}
UserIdentificationChallenge {
Answer( string )
UserID( string )
ChallengeCode( string, required )
ChallengeQuestion( string )
}
UserPhone {
Type( string )
Verified( boolean )
Primary( boolean )
PhoneNumber( string )
CountryCode( 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
signupResponse
signupResponse {
UserPhone {
profileName( string )
lastName( string )
pendingTasks( Collection of string )
loginState( string )
loginDomainID( string )
pendingNotifications( int )
userName( string )
userID( string )
userPhones( Collection of UserPhone )
signupStatus( string )
firstName( string )
pendingAgreements( Collection of string )
emailAddress( string )
expired( boolean )
pendingTaskData( anyType )
domainName( string )
authTokenValidUntil( string )
state( string )
authIdentifier( string )
sessionValidUntil( string )
}
UserPhone {
Type( string )
Verified( boolean )
Primary( boolean )
PhoneNumber( string )
CountryCode( string )
}
GET/users/{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
DELETE/users/{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/users/{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/users/{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/users/{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 )
}
PUT/users/{UserID}/notifications/{NotificationID}/statechangeNotificationState
Parameters
Accepts text/plain
Name
Type
Description
Model
UserID
path
string
NotificationID
path
string
body
entity
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/users/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
