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

ReportCatalog

GET /api/reporting

options: string
in query

(no description)

category: string
in query

(no description)

200 OK
ListViewReturnModel<ReportCollectionModel>

OK

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

POST /api/reporting

ReportAdvancedFilter

undefined

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ReportCategoryId": "string",
  "IsCustom": "boolean",
  "IsPrivate": "boolean",
  "IsFavorite": "boolean",
  "Criteria": "string",
  "ShowCustomReportsAcrossCustomers": "boolean"
}
200 OK
ListViewReturnModel<ReportCollectionModel>

OK

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

DELETE /api/reporting/{reportid}/{auditid}

reportid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

ReportCatalog

POST /api/reporting/add

ReportAddModel

undefined

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

OK

Response Example (200 OK) 
{
  "ImageUrl": "string",
  "ImageShortDescription": "string",
  "ReportId": "integer",
  "AuditId": "integer",
  "IsSystem": "boolean",
  "Name": "string",
  "Description": "string",
  "ReportTypeId": "string",
  "ReportCategoryId": "string",
  "DateAdded": "string",
  "LastUsed": "string",
  "IsFavorite": "boolean",
  "Path": "string",
  "IsPrivateForUser": "boolean",
  "CreatedBy": "integer",
  "Parameters": "string",
  "Actions": "string",
  "SecurableAreaId": "string",
  "SecurableItemId": "string",
  "IsChapterSafe": "boolean",
  "RequiredModules": "string",
  "UserHaveDeleteAccess": "boolean"
}
ReportCatalog

POST /api/reporting/contactreports/{contactid}

ODataQueryOptions<ReportCollectionModel>

undefined

contactid: string
in path

(no description)

category: string
in query

(no description)

Request Example
"object"
200 OK
InnerModuleReportCollectionModel

OK

type
InnerModuleReportCollectionModel
Response Example (200 OK) 
[
  {
    "ImageUrl": "string",
    "ImageShortDescription": "string",
    "ReportId": "integer",
    "AuditId": "integer",
    "IsSystem": "boolean",
    "ContactId": "integer",
    "Name": "string",
    "Description": "string",
    "ReportTypeId": "string",
    "Path": "string"
  }
]
ReportCatalog

GET /api/reporting/contactreports/{contactid}

contactid: string
in path

(no description)

200 OK
ContactReportsModel

OK

Response Example (200 OK) 
{
  "ContactId": "string",
  "ReportsList": "string"
}
ReportCatalog

GET /api/reporting/tenantreports

this[]: string
in query

(no description)

length: string
in query

(no description)

200 OK
ItemChoiceModel

OK

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

GET /api/reporting/widget/reportfavorites

200 OK
ReportFavoritesKeyValueData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string"
}

Schema Definitions

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

ReportFavoritesKeyValueData: object

ModelType: string
Items: string
TotalRecordAvailable: string
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string"
}

ItemChoiceModel: object

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

InnerModuleReportCollectionModel: object

ImageUrl: string
ImageShortDescription: string
ReportId: integer
AuditId: integer
IsSystem: boolean
ContactId: integer
Name: string
Description: string
ReportTypeId: string
Path: string
Example
{
  "ImageUrl": "string",
  "ImageShortDescription": "string",
  "ReportId": "integer",
  "AuditId": "integer",
  "IsSystem": "boolean",
  "ContactId": "integer",
  "Name": "string",
  "Description": "string",
  "ReportTypeId": "string",
  "Path": "string"
}

ODataQueryOptions<ReportCollectionModel>: object

Example
"object"

ContactReportsModel: object

ContactId: string
ReportsList: string
Example
{
  "ContactId": "string",
  "ReportsList": "string"
}

ReportAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
ReportCategoryId: string
IsCustom: boolean
IsPrivate: boolean
IsFavorite: boolean
Criteria: string
ShowCustomReportsAcrossCustomers: boolean
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ReportCategoryId": "string",
  "IsCustom": "boolean",
  "IsPrivate": "boolean",
  "IsFavorite": "boolean",
  "Criteria": "string",
  "ShowCustomReportsAcrossCustomers": "boolean"
}

ReportCollectionModel: object

ImageUrl: string
ImageShortDescription: string
ReportId: integer
AuditId: integer
IsSystem: boolean
Name: string
Description: string
ReportTypeId: string
ReportCategoryId: string
DateAdded: string
LastUsed: string
IsFavorite: boolean
Path: string
IsPrivateForUser: boolean
CreatedBy: integer
Parameters: string
Actions: string
SecurableAreaId: string
SecurableItemId: string
IsChapterSafe: boolean
RequiredModules: string
UserHaveDeleteAccess: boolean
Example
{
  "ImageUrl": "string",
  "ImageShortDescription": "string",
  "ReportId": "integer",
  "AuditId": "integer",
  "IsSystem": "boolean",
  "Name": "string",
  "Description": "string",
  "ReportTypeId": "string",
  "ReportCategoryId": "string",
  "DateAdded": "string",
  "LastUsed": "string",
  "IsFavorite": "boolean",
  "Path": "string",
  "IsPrivateForUser": "boolean",
  "CreatedBy": "integer",
  "Parameters": "string",
  "Actions": "string",
  "SecurableAreaId": "string",
  "SecurableItemId": "string",
  "IsChapterSafe": "boolean",
  "RequiredModules": "string",
  "UserHaveDeleteAccess": "boolean"
}

ReportAddModel: object

Name: string
Description: string
Example
{
  "Name": "string",
  "Description": "string"
}
Documentation by Spectacle