GrowthZone REST API API Reference

undefined

API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0

Paths

Roles

GET /api/roles

200 OK
RoleCollectionItemModel

OK

type
RoleCollectionItemModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "RoleId": "integer",
    "Name": "string",
    "RoleTypeId": "string",
    "Description": "string",
    "UsersCount": "integer",
    "Actions": "string"
  }
]
Roles

GET /api/roles/{roleid}

roleid: integer
in path

(no description)

200 OK
RoleAddEditModel

OK

Response Example (200 OK) 
{
  "Name": "string",
  "Description": "string",
  "RoleId": "integer",
  "AuditId": "integer",
  "UserNotInDev": "boolean",
  "HasChapters": "boolean",
  "HideChapterStaff": "boolean",
  "RoleTypeId": "string",
  "HasContactRelationshipRestriction": "boolean",
  "Areas": "string",
  "CssClass": "string"
}
Roles

POST /api/roles/{roleid}

RoleAddEditModel

undefined

roleid: string
in path

(no description)

Request Example
{
  "Name": "string",
  "Description": "string",
  "RoleId": "integer",
  "AuditId": "integer",
  "UserNotInDev": "boolean",
  "HasChapters": "boolean",
  "HideChapterStaff": "boolean",
  "RoleTypeId": "string",
  "HasContactRelationshipRestriction": "boolean",
  "Areas": "string",
  "CssClass": "string"
}
200 OK
RoleCollectionItemModel

OK

Response Example (200 OK) 
{
  "Id": "integer",
  "RoleId": "integer",
  "Name": "string",
  "RoleTypeId": "string",
  "Description": "string",
  "UsersCount": "integer",
  "Actions": "string"
}
Roles

DELETE /api/roles/{roleid}/{auditid}

roleid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

Roles

POST /api/roles/accessroles/masssupdate/load

AccessLevelMassUpdateViewModel

undefined

Request Example
{
  "SelectedIds": "string",
  "CurrentAdvancedFilter": "string",
  "RecordsToUpdate": "integer",
  "RoleId": "string"
}
200 OK
AccessLevelMassUpdateViewModel

OK

Response Example (200 OK) 
{
  "SelectedIds": "string",
  "CurrentAdvancedFilter": "string",
  "RecordsToUpdate": "integer",
  "RoleId": "string"
}
Roles

POST /api/roles/accessroles/massupdate/save

AccessLevelMassUpdateViewModel

undefined

Request Example
{
  "SelectedIds": "string",
  "CurrentAdvancedFilter": "string",
  "RecordsToUpdate": "integer",
  "RoleId": "string"
}
200 OK

OK

Roles

GET /api/roles/lookup

200 OK
RoleChoiceCollectionItemModel

OK

type
RoleChoiceCollectionItemModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "RoleId": "integer",
    "Name": "string",
    "RoleTypeId": "string",
    "ExtraData": "string"
  }
]
Roles

GET /api/roles/lookup/drop/membership/roles

200 OK
RoleChoiceCollectionItemModel

OK

type
RoleChoiceCollectionItemModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "RoleId": "integer",
    "Name": "string",
    "RoleTypeId": "string",
    "ExtraData": "string"
  }
]
Roles

GET /api/roles/lookup/member

200 OK
RoleChoiceCollectionItemModel

OK

type
RoleChoiceCollectionItemModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "RoleId": "integer",
    "Name": "string",
    "RoleTypeId": "string",
    "ExtraData": "string"
  }
]
Roles

GET /api/roles/lookup/roletype

200 OK
ItemChoiceModel

OK

type
ItemChoiceModel
Response Example (200 OK) 
[
  {
    "IsSelected": "boolean",
    "PreviouslySelected": "boolean",
    "Id": "integer",
    "Name": "string",
    "Order": "integer"
  }
]
Roles

GET /api/roles/lookup/staff

200 OK
RoleChoiceCollectionItemModel

OK

type
RoleChoiceCollectionItemModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "RoleId": "integer",
    "Name": "string",
    "RoleTypeId": "string",
    "ExtraData": "string"
  }
]
Roles

POST /api/roles/massupdate

AccessLevelsMassUpdateContactAdvancedFilter

undefined

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContactType": "string",
  "MembershipTypeId": "string",
  "MembershipLevelId": "string",
  "StatusTypeOptions": "string",
  "OrganizationContact": "string",
  "IsPrimaryContact": "boolean",
  "NonPrimaryContact": "boolean",
  "ExcludeStaff": "boolean",
  "Criteria": "string",
  "HideContactTypeFilterField": "boolean"
}
200 OK
ListViewReturnModel<AccessLevelsMassUpdateContactModel>

OK

Response Example (200 OK) 
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}
Roles

POST /api/roles/massupdate/load/contacts

IndividualsMassUpdateRoleId

undefined

Request Example
{
  "CurrentAdvancedFilter": "string",
  "TotalRecordAvailable": "string",
  "RoleId": "string"
}
200 OK
IndividualsMassUpdateRoleId

OK

Response Example (200 OK) 
{
  "CurrentAdvancedFilter": "string",
  "TotalRecordAvailable": "string",
  "RoleId": "string"
}
Roles

POST /api/roles/massupdate/save/contacts

IndividualsMassUpdateRoleId

undefined

Request Example
{
  "CurrentAdvancedFilter": "string",
  "TotalRecordAvailable": "string",
  "RoleId": "string"
}
200 OK

OK

Roles

POST /api/roles/massupdate/view/contacts

IndividualToMassUpdateRoleIdItemFilter

undefined

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "MembershipTypeId": "string",
  "MembershipLevelId": "string",
  "StatusTypeOptions": "string",
  "OrganizationContact": "string",
  "IsPrimaryContact": "boolean",
  "NonPrimaryContact": "boolean",
  "ExcludeStaff": "boolean",
  "Criteria": "string"
}
200 OK
ListViewReturnModel<IndividualToMassUpdateRoleIdItem>

OK

Response Example (200 OK) 
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}
Roles

GET /api/roles/user

200 OK
RoleCollectionItemModel

OK

type
RoleCollectionItemModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "RoleId": "integer",
    "Name": "string",
    "RoleTypeId": "string",
    "Description": "string",
    "UsersCount": "integer",
    "Actions": "string"
  }
]
Roles

POST /api/roles/user/{roleid}

BaseRoleAddEditModel

undefined

roleid: string
in path

(no description)

Request Example
{
  "Name": "string",
  "Description": "string"
}
200 OK
RoleCollectionItemModel

OK

Response Example (200 OK) 
{
  "Id": "integer",
  "RoleId": "integer",
  "Name": "string",
  "RoleTypeId": "string",
  "Description": "string",
  "UsersCount": "integer",
  "Actions": "string"
}
Roles

POST /api/roles/user/{roleid}/access

UserRoleAddEditModel

undefined

roleid: integer
in path

(no description)

Request Example
{
  "Name": "string",
  "Description": "string",
  "RoleId": "integer",
  "AuditId": "integer",
  "UserNotInDev": "boolean",
  "HasChapters": "boolean",
  "HideChapterStaff": "boolean",
  "RoleTypeId": "string",
  "HasContactRelationshipRestriction": "boolean",
  "Areas": "string",
  "CssClass": "string",
  "ShowAllAreas": "boolean"
}
200 OK
RoleCollectionItemModel

OK

Response Example (200 OK) 
{
  "Id": "integer",
  "RoleId": "integer",
  "Name": "string",
  "RoleTypeId": "string",
  "Description": "string",
  "UsersCount": "integer",
  "Actions": "string"
}
Roles

GET /api/roles/userrole/{roleid}

roleid: integer
in path

(no description)

200 OK
UserRoleAddEditModel

OK

Response Example (200 OK) 
{
  "Name": "string",
  "Description": "string",
  "RoleId": "integer",
  "AuditId": "integer",
  "UserNotInDev": "boolean",
  "HasChapters": "boolean",
  "HideChapterStaff": "boolean",
  "RoleTypeId": "string",
  "HasContactRelationshipRestriction": "boolean",
  "Areas": "string",
  "CssClass": "string",
  "ShowAllAreas": "boolean"
}
Roles

GET /api/roles/userrolelookup

200 OK
RoleChoiceCollectionItemModel

OK

type
RoleChoiceCollectionItemModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "RoleId": "integer",
    "Name": "string",
    "RoleTypeId": "string",
    "ExtraData": "string"
  }
]
Roles

GET /api/roles/users/{roleid}

roleid: integer
in path

(no description)

200 OK
RoleUsersViewModel

OK

Response Example (200 OK) 
{
  "RoleId": "integer",
  "RoleTypeId": "string",
  "IsStaffRole": "boolean",
  "Name": "string",
  "Users": "string"
}
Roles

POST /api/roles/users/{roleid}/list

RoleUsersAdvancesFilter

undefined

roleid: integer
in path

(no description)

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "RoleId": "integer",
  "Criteria": "string"
}
200 OK
ListViewReturnModel<RoleUsers>

OK

Response Example (200 OK) 
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

Schema Definitions

RoleCollectionItemModel: object

Id: integer
RoleId: integer
Name: string
RoleTypeId: string
Description: string
UsersCount: integer
Actions: string
Example
{
  "Id": "integer",
  "RoleId": "integer",
  "Name": "string",
  "RoleTypeId": "string",
  "Description": "string",
  "UsersCount": "integer",
  "Actions": "string"
}

BaseRoleAddEditModel: object

Name: string
Description: string
Example
{
  "Name": "string",
  "Description": "string"
}

UserRoleAddEditModel: object

Name: string
Description: string
RoleId: integer
AuditId: integer
UserNotInDev: boolean
HasChapters: boolean
HideChapterStaff: boolean
RoleTypeId: string
HasContactRelationshipRestriction: boolean
Areas: string
CssClass: string
ShowAllAreas: boolean
Example
{
  "Name": "string",
  "Description": "string",
  "RoleId": "integer",
  "AuditId": "integer",
  "UserNotInDev": "boolean",
  "HasChapters": "boolean",
  "HideChapterStaff": "boolean",
  "RoleTypeId": "string",
  "HasContactRelationshipRestriction": "boolean",
  "Areas": "string",
  "CssClass": "string",
  "ShowAllAreas": "boolean"
}

RoleAddEditModel: object

Name: string
Description: string
RoleId: integer
AuditId: integer
UserNotInDev: boolean
HasChapters: boolean
HideChapterStaff: boolean
RoleTypeId: string
HasContactRelationshipRestriction: boolean
Areas: string
CssClass: string
Example
{
  "Name": "string",
  "Description": "string",
  "RoleId": "integer",
  "AuditId": "integer",
  "UserNotInDev": "boolean",
  "HasChapters": "boolean",
  "HideChapterStaff": "boolean",
  "RoleTypeId": "string",
  "HasContactRelationshipRestriction": "boolean",
  "Areas": "string",
  "CssClass": "string"
}

Object: object

Example
"object"

RoleChoiceCollectionItemModel: object

Id: integer
RoleId: integer
Name: string
RoleTypeId: string
ExtraData: string
Example
{
  "Id": "integer",
  "RoleId": "integer",
  "Name": "string",
  "RoleTypeId": "string",
  "ExtraData": "string"
}

ItemChoiceModel: object

IsSelected: boolean
PreviouslySelected: boolean
Id: integer
Name: string
Order: integer
Example
{
  "IsSelected": "boolean",
  "PreviouslySelected": "boolean",
  "Id": "integer",
  "Name": "string",
  "Order": "integer"
}

RoleUsersViewModel: object

RoleId: integer
RoleTypeId: string
IsStaffRole: boolean
Name: string
Users: string
Example
{
  "RoleId": "integer",
  "RoleTypeId": "string",
  "IsStaffRole": "boolean",
  "Name": "string",
  "Users": "string"
}

ListViewReturnModel<RoleUsers>: 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"
}

RoleUsersAdvancesFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
RoleId: integer
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "RoleId": "integer",
  "Criteria": "string"
}

ListViewReturnModel<AccessLevelsMassUpdateContactModel>: 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"
}

AccessLevelsMassUpdateContactAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
ContactType: string
MembershipTypeId: string
MembershipLevelId: string
StatusTypeOptions: string
OrganizationContact: string
IsPrimaryContact: boolean
NonPrimaryContact: boolean
ExcludeStaff: boolean
Criteria: string
HideContactTypeFilterField: boolean
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContactType": "string",
  "MembershipTypeId": "string",
  "MembershipLevelId": "string",
  "StatusTypeOptions": "string",
  "OrganizationContact": "string",
  "IsPrimaryContact": "boolean",
  "NonPrimaryContact": "boolean",
  "ExcludeStaff": "boolean",
  "Criteria": "string",
  "HideContactTypeFilterField": "boolean"
}

AccessLevelMassUpdateViewModel: object

SelectedIds: string
CurrentAdvancedFilter: string
RecordsToUpdate: integer
RoleId: string
Example
{
  "SelectedIds": "string",
  "CurrentAdvancedFilter": "string",
  "RecordsToUpdate": "integer",
  "RoleId": "string"
}

ListViewReturnModel<IndividualToMassUpdateRoleIdItem>: 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"
}

IndividualToMassUpdateRoleIdItemFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
MembershipTypeId: string
MembershipLevelId: string
StatusTypeOptions: string
OrganizationContact: string
IsPrimaryContact: boolean
NonPrimaryContact: boolean
ExcludeStaff: boolean
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "MembershipTypeId": "string",
  "MembershipLevelId": "string",
  "StatusTypeOptions": "string",
  "OrganizationContact": "string",
  "IsPrimaryContact": "boolean",
  "NonPrimaryContact": "boolean",
  "ExcludeStaff": "boolean",
  "Criteria": "string"
}

IndividualsMassUpdateRoleId: object

CurrentAdvancedFilter: string
TotalRecordAvailable: string
RoleId: string
Example
{
  "CurrentAdvancedFilter": "string",
  "TotalRecordAvailable": "string",
  "RoleId": "string"
}
Documentation by Spectacle