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

TermsOfUse

GET /api/setup/termsofuse

200 OK
TermsOfUseCollectionItemModel

OK

type
TermsOfUseCollectionItemModel
Response Example (200 OK) 
[
  {
    "TermsOfUseId": "integer",
    "Name": "string"
  }
]
TermsOfUse

GET /api/setup/termsofuse/{termsofuseid}

termsofuseid: integer
in path

(no description)

200 OK
TermsOfUseAddEditModel

OK

Response Example (200 OK) 
{
  "TermsOfUseId": "integer",
  "Name": "string",
  "Description": "string",
  "AuditId": "integer",
  "LoginType": "string",
  "OriginalDescription": "string",
  "forceSave": "boolean"
}
TermsOfUse

POST /api/setup/termsofuse/{termsofuseid}

TermsOfUseAddEditModel

undefined

termsofuseid: integer
in path

(no description)

Request Example
{
  "TermsOfUseId": "integer",
  "Name": "string",
  "Description": "string",
  "AuditId": "integer",
  "LoginType": "string",
  "OriginalDescription": "string",
  "forceSave": "boolean"
}
200 OK
TermsOfUseCollectionItemModel

OK

Response Example (200 OK) 
{
  "TermsOfUseId": "integer",
  "Name": "string"
}
TermsOfUse

DELETE /api/setup/termsofuse/{termsofuseid}/{auditid}

termsofuseid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

TermsOfUse

GET /api/setup/termsofuse/gdpr/backoffice

200 OK
TermsOfUseAddEditModel

OK

Response Example (200 OK) 
{
  "TermsOfUseId": "integer",
  "Name": "string",
  "Description": "string",
  "AuditId": "integer",
  "LoginType": "string",
  "OriginalDescription": "string",
  "forceSave": "boolean"
}
TermsOfUse

GET /api/setup/termsofuse/lookup

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
TermsOfUse

POST /api/setup/termsofuse/terms/takeaction

TermsUsersResponseModel

undefined

Request Example
{
  "TermUserResponseId": "integer",
  "ContactId": "integer",
  "LoginId": "integer",
  "TenantId": "integer",
  "UserLoginTypeId": "string",
  "IsAccepted": "boolean",
  "TermsOfUseId": "integer",
  "ActionDate": "string",
  "IpBrowserInfo": "string"
}
200 OK

OK

TermsOfUse

GET /api/setup/termsofuse/usertermsacceptance/hub

options: string
in query

(no description)

200 OK
ListViewReturnModel<UserTermsAcceptance>

OK

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

POST /api/setup/termsofuse/usertermsacceptance/hub

UserTermsAcceptanceAdvancedFilter

undefined

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

OK

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

GET /api/setup/termsofuse/usertermsacceptance/staff

options: string
in query

(no description)

200 OK
ListViewReturnModel<UserTermsAcceptance>

OK

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

POST /api/setup/termsofuse/usertermsacceptance/staff

UserTermsAcceptanceAdvancedFilter

undefined

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

OK

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

GET /api/setup/termsofuse/view/{termsofuseid}

termsofuseid: integer
in path

(no description)

200 OK
TermsOfUseViewModel

OK

Response Example (200 OK) 
{
  "TermsOfUseId": "integer",
  "TermsDescription": "string"
}

Schema Definitions

TermsOfUseCollectionItemModel: object

TermsOfUseId: integer
Name: string
Example
{
  "TermsOfUseId": "integer",
  "Name": "string"
}

TermsOfUseAddEditModel: object

TermsOfUseId: integer
Name: string
Description: string
AuditId: integer
LoginType: string
OriginalDescription: string
forceSave: boolean
Example
{
  "TermsOfUseId": "integer",
  "Name": "string",
  "Description": "string",
  "AuditId": "integer",
  "LoginType": "string",
  "OriginalDescription": "string",
  "forceSave": "boolean"
}

TermsOfUseViewModel: object

TermsOfUseId: integer
TermsDescription: string
Example
{
  "TermsOfUseId": "integer",
  "TermsDescription": "string"
}

Object: object

Example
"object"

IQueryable: object

Expression: string
ElementType: string
Provider: string
Example
{
  "Expression": "string",
  "ElementType": "string",
  "Provider": "string"
}

Boolean: object

Example
"object"

TermsUsersResponseModel: object

TermUserResponseId: integer
ContactId: integer
LoginId: integer
TenantId: integer
UserLoginTypeId: string
IsAccepted: boolean
TermsOfUseId: integer
ActionDate: string
IpBrowserInfo: string
Example
{
  "TermUserResponseId": "integer",
  "ContactId": "integer",
  "LoginId": "integer",
  "TenantId": "integer",
  "UserLoginTypeId": "string",
  "IsAccepted": "boolean",
  "TermsOfUseId": "integer",
  "ActionDate": "string",
  "IpBrowserInfo": "string"
}

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

UserTermsAcceptanceAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
LoginTypes: string
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "LoginTypes": "string",
  "Criteria": "string"
}
Documentation by Spectacle