Error
A valid request URL is required to generate request examples{
"sysidHomeForum": 12345,
"customRules": [
{
"sysidAccountCustomRule": 12345,
"sysidCustomRuleType": 12345
},
{
"sysidAccountCustomRule": 12345,
"sysidCustomRuleType": 12345
}
],
"images": [
{
"height": 12345,
"width": 12345,
"sysidAccountImage": 12345,
"description": "...",
"thumbnailSource": "...",
"imageSource": "...",
"displayOrder": 12345,
"defaultImage": true,
"name": "..."
},
{
"height": 12345,
"width": 12345,
"sysidAccountImage": 12345,
"description": "...",
"thumbnailSource": "...",
"imageSource": "...",
"displayOrder": 12345,
"defaultImage": true,
"name": "..."
}
],
"name": "...",
"license": "...",
"active": true,
"description": "...",
"accountType": "PRIVATE_BUSINESS",
"sysidOwnerUser": 12345,
"sysidAccount": 12345,
"allowICS": true,
"login": "...",
"externalMeetingTypes": [
{
"sysidAccountExternalMeeting": 12345,
"sysidExternalMeetingType": 12345
},
{
"sysidAccountExternalMeeting": 12345,
"sysidExternalMeetingType": 12345
}
],
"password": "...",
"sysidAccountType": 12345,
"tangoAccountID": "...",
"displayLinks": [
{
"text": "...",
"description": "...",
"targetURL": "...",
"sysidLanguage": 12345,
"display": true,
"imageURL": "...",
"expirationAqDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"external": true,
"sysidDisplayLink": 12345,
"displayOrder": 12345,
"activationAqDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
}
},
{
"text": "...",
"description": "...",
"targetURL": "...",
"sysidLanguage": 12345,
"display": true,
"imageURL": "...",
"expirationAqDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"external": true,
"sysidDisplayLink": 12345,
"displayOrder": 12345,
"activationAqDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
}
}
]
}ForumService
Post forumssystem
Creates a new Forum, adding a new account if provided and initializing with default values if requested.
This operation is intended for management of multiple forums used by multiple accounts. The requestor must be the SystemAdmin, or a AuthorizationException is thrown.
This operation requires a Create Forum Account Data value.
This operation returns a Account Data value of the Forum’s owning Account.
POST
/
forums
/
system
Error
A valid request URL is required to generate request examples{
"sysidHomeForum": 12345,
"customRules": [
{
"sysidAccountCustomRule": 12345,
"sysidCustomRuleType": 12345
},
{
"sysidAccountCustomRule": 12345,
"sysidCustomRuleType": 12345
}
],
"images": [
{
"height": 12345,
"width": 12345,
"sysidAccountImage": 12345,
"description": "...",
"thumbnailSource": "...",
"imageSource": "...",
"displayOrder": 12345,
"defaultImage": true,
"name": "..."
},
{
"height": 12345,
"width": 12345,
"sysidAccountImage": 12345,
"description": "...",
"thumbnailSource": "...",
"imageSource": "...",
"displayOrder": 12345,
"defaultImage": true,
"name": "..."
}
],
"name": "...",
"license": "...",
"active": true,
"description": "...",
"accountType": "PRIVATE_BUSINESS",
"sysidOwnerUser": 12345,
"sysidAccount": 12345,
"allowICS": true,
"login": "...",
"externalMeetingTypes": [
{
"sysidAccountExternalMeeting": 12345,
"sysidExternalMeetingType": 12345
},
{
"sysidAccountExternalMeeting": 12345,
"sysidExternalMeetingType": 12345
}
],
"password": "...",
"sysidAccountType": 12345,
"tangoAccountID": "...",
"displayLinks": [
{
"text": "...",
"description": "...",
"targetURL": "...",
"sysidLanguage": 12345,
"display": true,
"imageURL": "...",
"expirationAqDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"external": true,
"sysidDisplayLink": 12345,
"displayOrder": 12345,
"activationAqDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
}
},
{
"text": "...",
"description": "...",
"targetURL": "...",
"sysidLanguage": 12345,
"display": true,
"imageURL": "...",
"expirationAqDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"external": true,
"sysidDisplayLink": 12345,
"displayOrder": 12345,
"activationAqDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
}
}
]
}Body
application/json
CreateForumAccountData
Show child attributes
Show child attributes
Example:
{
"emailAddress": "...",
"lastName": "...",
"firstName": "...",
"password": "..."
}
Show child attributes
Show child attributes
Example:
{
"sysidHomeForum": 12345,
"customRules": [
{
"sysidAccountCustomRule": 12345,
"sysidCustomRuleType": 12345
},
{
"sysidAccountCustomRule": 12345,
"sysidCustomRuleType": 12345
}
],
"images": [
{
"height": 12345,
"width": 12345,
"sysidAccountImage": 12345,
"description": "...",
"thumbnailSource": "...",
"imageSource": "...",
"displayOrder": 12345,
"defaultImage": true,
"name": "..."
},
{
"height": 12345,
"width": 12345,
"sysidAccountImage": 12345,
"description": "...",
"thumbnailSource": "...",
"imageSource": "...",
"displayOrder": 12345,
"defaultImage": true,
"name": "..."
}
],
"name": "...",
"license": "...",
"active": true,
"description": "...",
"accountType": "PUBLIC_PUBLISHER",
"sysidOwnerUser": 12345,
"sysidAccount": 12345,
"allowICS": true,
"login": "...",
"externalMeetingTypes": [
{
"sysidAccountExternalMeeting": 12345,
"sysidExternalMeetingType": 12345
},
{
"sysidAccountExternalMeeting": 12345,
"sysidExternalMeetingType": 12345
}
],
"password": "...",
"sysidAccountType": 12345,
"tangoAccountID": "...",
"displayLinks": [
{
"text": "...",
"description": "...",
"targetURL": "...",
"sysidLanguage": 12345,
"display": true,
"imageURL": "...",
"expirationAqDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"external": true,
"sysidDisplayLink": 12345,
"displayOrder": 12345,
"activationAqDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
}
},
{
"text": "...",
"description": "...",
"targetURL": "...",
"sysidLanguage": 12345,
"display": true,
"imageURL": "...",
"expirationAqDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"external": true,
"sysidDisplayLink": 12345,
"displayOrder": 12345,
"activationAqDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
}
}
]
}
Show child attributes
Show child attributes
Example:
{
"allowSelfRegistration": true,
"active": true,
"name": "...",
"allowAnonymousBrowsing": true,
"description": "...",
"schemaName": "...",
"forumMembers": [
{
"owner": true,
"sysidForumMember": 12345,
"sysidAccount": 12345
},
{
"owner": true,
"sysidForumMember": 12345,
"sysidAccount": 12345
}
],
"sysidForum": 12345,
"databaseName": "..."
}
Response
201 - application/json
AccountData com.agilquest.phoenix.shared.data.account.AccountData
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
PUBLIC_PUBLISHER, PRIVATE_BUSINESS Show child attributes
Show child attributes
Show child attributes
Show child attributes