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

Calendar

GET /api/calendars/{calendarid}

calendarid: integer
in path

(no description)

200 OK
CalendarAddEditModel

OK

Response Example (200 OK) 
{
  "CalendarId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "IsActive": "boolean",
  "IsPublicViewable": "boolean",
  "IsMemberViewable": "boolean",
  "AllowPublicSubmission": "boolean",
  "AllowMemberSubmission": "boolean",
  "IsICalPublishingEnabled": "boolean",
  "PrimaryDomain": "string",
  "EntireUrl": "string",
  "AddCalendarICalMessage": "string",
  "GroupId": "string"
}
Calendar

POST /api/calendars/{calendarid}

CalendarAddEditModel

undefined

calendarid: integer
in path

(no description)

Request Example
{
  "CalendarId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "IsActive": "boolean",
  "IsPublicViewable": "boolean",
  "IsMemberViewable": "boolean",
  "AllowPublicSubmission": "boolean",
  "AllowMemberSubmission": "boolean",
  "IsICalPublishingEnabled": "boolean",
  "PrimaryDomain": "string",
  "EntireUrl": "string",
  "AddCalendarICalMessage": "string",
  "GroupId": "string"
}
200 OK
CalendarCollectionItemModel

OK

Response Example (200 OK) 
{
  "CalendarId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "GroupName": "string",
  "IsActive": "boolean",
  "Actions": "string"
}
Calendar

DELETE /api/calendars/{calendarid}/{auditid}

calendarid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

Calendar

GET /api/calendars/items

options: string
in query

(no description)

200 OK
CalendarCollectionItemModel

OK

type
CalendarCollectionItemModel
Response Example (200 OK) 
[
  {
    "CalendarId": "integer",
    "AuditId": "integer",
    "Name": "string",
    "Description": "string",
    "GroupName": "string",
    "IsActive": "boolean",
    "Actions": "string"
  }
]
Calendar

GET /api/calendars/lookup

200 OK
GenericLookUpChoice<Int32>

OK

type
GenericLookUpChoice<Int32>
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]
Calendar

GET /api/calendars/lookup/chapters/{chapterid}

chapterid: integer
in path

(no description)

200 OK
CalendarChoiceItemModel

OK

type
CalendarChoiceItemModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "CalendarDescription": "string"
  }
]

Schema Definitions

CalendarCollectionItemModel: object

CalendarId: integer
AuditId: integer
Name: string
Description: string
GroupName: string
IsActive: boolean
Actions: string
Example
{
  "CalendarId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "GroupName": "string",
  "IsActive": "boolean",
  "Actions": "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"
}

CalendarChoiceItemModel: object

Id: integer
Name: string
CalendarDescription: string
Example
{
  "Id": "integer",
  "Name": "string",
  "CalendarDescription": "string"
}

CalendarAddEditModel: object

CalendarId: integer
AuditId: integer
Name: string
Description: string
IsActive: boolean
IsPublicViewable: boolean
IsMemberViewable: boolean
AllowPublicSubmission: boolean
AllowMemberSubmission: boolean
IsICalPublishingEnabled: boolean
PrimaryDomain: string
EntireUrl: string
AddCalendarICalMessage: string
GroupId: string
Example
{
  "CalendarId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "IsActive": "boolean",
  "IsPublicViewable": "boolean",
  "IsMemberViewable": "boolean",
  "AllowPublicSubmission": "boolean",
  "AllowMemberSubmission": "boolean",
  "IsICalPublishingEnabled": "boolean",
  "PrimaryDomain": "string",
  "EntireUrl": "string",
  "AddCalendarICalMessage": "string",
  "GroupId": "string"
}

Object: object

Example
"object"
Documentation by Spectacle