GrowthZone REST API API Reference
undefined
API Endpoint
https://app.memberzone.orgRequest Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0
Paths
GET /api/forum/all
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"Criteria": "string"
}
OK
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
DELETE /api/forum/drop/{forumid}
forumid:
integer
in path
(no description)
200 OK
OK
GET /api/forum/editmodel/{forumid}
forumid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"ForumId": "integer",
"Name": "string",
"Description": "string",
"CategoryId": "string",
"Moderators": "string",
"GroupsAccesses": "string"
}
GET /api/forum/emaildesigner/forumtopics
forumid:
integer
in query
(no description)
maxresults:
integer
in query
(no description)
OK
Response Example (200 OK)
[
{
"TopicTitle": "string",
"TopicUrl": "string",
"ForumTitle": "string"
}
]
GET /api/forum/forumcategories
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/forum/forumcategory/all
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
DELETE /api/forum/forumcategory/delete/{forumcategoryid}
forumcategoryid:
integer
in path
(no description)
200 OK
OK
GET /api/forum/forumcategory/editmodel/{forumcategoryid}
forumcategoryid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"ForumCategoryId": "integer",
"Name": "string",
"Description": "string"
}
POST /api/forum/forumcategory/savemodel
undefined
Request Example
{
"ForumCategoryId": "integer",
"Name": "string",
"Description": "string"
}
200 OK
OK
Response Example (200 OK)
{
"ForumCategoryId": "integer",
"Name": "string",
"Description": "string"
}
GET /api/forum/lookup/forums
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
POST /api/forum/savemodel
undefined
Request Example
{
"ForumId": "integer",
"Name": "string",
"Description": "string",
"CategoryId": "string",
"Moderators": "string",
"GroupsAccesses": "string"
}
200 OK
OK
Response Example (200 OK)
{
"ForumId": "integer",
"Name": "string",
"Category": "string",
"Description": "string",
"Moderators": "string",
"GroupAccesses": "string",
"ForumModerators": "string",
"ForumAccessibleGroups": "string"
}
GET /api/forum/settings
200 OK
OK
Response Example (200 OK)
{
"MemberForumEnabled": "boolean",
"TermsConditionId": "string"
}
POST /api/forum/settings/savemodel
undefined
Request Example
{
"MemberForumEnabled": "boolean",
"TermsConditionId": "string"
}
200 OK
OK
Schema Definitions
ForumCategoryAddEditModel: object
- ForumCategoryId: integer
- Name: string
- Description: string
Example
{
"ForumCategoryId": "integer",
"Name": "string",
"Description": "string"
}
ListViewReturnModel<ForumCategoryListCollectionItemModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GenericLookUpChoice<Int32>: object
- Id: integer
- Name: string
- ExtraData: string
- CssColor: string
- IsSelected: boolean
- IsDeleted: boolean
- Order: integer
Example
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
ForumAddEditModel: object
- ForumId: integer
- Name: string
- Description: string
- CategoryId: string
- Moderators: string
- GroupsAccesses: string
Example
{
"ForumId": "integer",
"Name": "string",
"Description": "string",
"CategoryId": "string",
"Moderators": "string",
"GroupsAccesses": "string"
}
ForumsListItem: object
- ForumId: integer
- Name: string
- Category: string
- Description: string
- Moderators: string
- GroupAccesses: string
- ForumModerators: string
- ForumAccessibleGroups: string
Example
{
"ForumId": "integer",
"Name": "string",
"Category": "string",
"Description": "string",
"Moderators": "string",
"GroupAccesses": "string",
"ForumModerators": "string",
"ForumAccessibleGroups": "string"
}
ListViewReturnModel<ForumsListItem>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
ForumListItemFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- Criteria: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"Criteria": "string"
}
ForumSettingsAddEditModel: object
- MemberForumEnabled: boolean
- TermsConditionId: string
Example
{
"MemberForumEnabled": "boolean",
"TermsConditionId": "string"
}