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

Task

DELETE /api/task/{taskitemid}/{auditid}

taskitemid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

Task

GET /api/task/currentusersummary

200 OK
CurrentUserTaskSummary

OK

Response Example (200 OK) 
{
  "TotalOverdueTasks": "integer",
  "CurrentUserOverdueTasks": "integer"
}
Task

GET /api/task/item/tooltip/{taskitemid}

taskitemid: integer
in path

(no description)

200 OK
HttpResponseMessage

OK

Response Example (200 OK) 
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}
Task

POST /api/task/items/{taskitemid}

TaskItemAddEditModel

undefined

taskitemid: string
in path

(no description)

Request Example
{
  "TaskItemId": "integer",
  "AuditId": "integer",
  "AssignedToContactId": "string",
  "Name": "string",
  "AuditInfo": "string",
  "TaskTypeId": "string",
  "TaskPriorityId": "string",
  "ProjectName": "string",
  "ProjectMilestoneId": "string",
  "Contact": "string",
  "ProjectId": "string",
  "Description": "string",
  "TaskItems": "string",
  "SystemTaskTypeId": "string",
  "StartDate": "string",
  "DueDate": "string",
  "EstimatedHours": "number",
  "DependentOnTaskId": "string",
  "IsComplete": "boolean",
  "CompletedDate": "string",
  "PercentComplete": "string",
  "ContactId": "string",
  "TaskItemInfoJson": "string",
  "TaskData": "string"
}
200 OK
TaskItemCollectionItemModel

OK

Response Example (200 OK) 
{
  "TaskItemId": "integer",
  "ContactCount": "string",
  "ContactId": "string",
  "Name": "string",
  "TaskPriorityId": "string",
  "TaskPriority": "string",
  "SystemTaskTypeId": "string",
  "TaskType": "string",
  "Contact": "string",
  "AssignedToContactId": "string",
  "AssignedToContact": "string",
  "StartDate": "string",
  "DueDate": "string",
  "CompletedDate": "string",
  "PercentComplete": "string",
  "ProjectId": "string",
  "ProjectName": "string",
  "EventId": "string",
  "EventName": "string",
  "TaskItemInfoJson": "string",
  "TotalRecordAvailable": "integer"
}
Task

GET /api/task/items/{taskitemid}/{projectid}/{contactid}

taskitemid: integer
in path

(no description)

projectid: string
in path

(no description)

contactid: string
in path

(no description)

200 OK
TaskItemAddEditModel

OK

Response Example (200 OK) 
{
  "TaskItemId": "integer",
  "AuditId": "integer",
  "AssignedToContactId": "string",
  "Name": "string",
  "AuditInfo": "string",
  "TaskTypeId": "string",
  "TaskPriorityId": "string",
  "ProjectName": "string",
  "ProjectMilestoneId": "string",
  "Contact": "string",
  "ProjectId": "string",
  "Description": "string",
  "TaskItems": "string",
  "SystemTaskTypeId": "string",
  "StartDate": "string",
  "DueDate": "string",
  "EstimatedHours": "number",
  "DependentOnTaskId": "string",
  "IsComplete": "boolean",
  "CompletedDate": "string",
  "PercentComplete": "string",
  "ContactId": "string",
  "TaskItemInfoJson": "string",
  "TaskData": "string"
}
Task

GET /api/task/items/all

options: string
in query

(no description)

200 OK
ListViewReturnModel<TaskItemCollectionItemModel>

OK

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

POST /api/task/items/all

TaskItemAdvancedFilter

undefined

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ProjectId": "integer",
  "TaskTypeId": "string",
  "AssignedToContactId": "string",
  "StartDateBetween": "string",
  "DueDateBetween": "string",
  "CompletedDateBetween": "string",
  "IsOverdue": "boolean",
  "HasDueDate": "boolean",
  "IsOpen": "boolean",
  "IsComplete": "boolean",
  "Criteria": "string",
  "ProjectName": "string"
}
200 OK
ListViewReturnModel<TaskItemCollectionItemModel>

OK

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

GET /api/task/items/calendar/all

options: string
in query

(no description)

200 OK
ListViewReturnModel<TaskItemCalendarItemModel>

OK

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

POST /api/task/items/calendar/all

TaskItemAdvancedFilter

undefined

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ProjectId": "integer",
  "TaskTypeId": "string",
  "AssignedToContactId": "string",
  "StartDateBetween": "string",
  "DueDateBetween": "string",
  "CompletedDateBetween": "string",
  "IsOverdue": "boolean",
  "HasDueDate": "boolean",
  "IsOpen": "boolean",
  "IsComplete": "boolean",
  "Criteria": "string",
  "ProjectName": "string"
}
200 OK
ListViewReturnModel<TaskItemCalendarItemModel>

OK

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

GET /api/task/items/lookup/{taskitemid}/{projectid}

taskitemid: integer
in path

(no description)

projectid: string
in path

(no description)

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"
  }
]
Task

POST /api/task/milestones/addedit

ProjectMilestoneAddEditModel

undefined

Request Example
{
  "Id": "integer",
  "ProjectMilestoneId": "integer",
  "TenantId": "integer",
  "ProjectId": "integer",
  "Name": "string"
}
200 OK
ProjectMilestoneAddEditModel

OK

Response Example (200 OK) 
{
  "Id": "integer",
  "ProjectMilestoneId": "integer",
  "TenantId": "integer",
  "ProjectId": "integer",
  "Name": "string"
}
Task

GET /api/task/milestones/lookup/{projectid}

projectid: string
in path

(no description)

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"
  }
]
Task

GET /api/task/priorities/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"
  }
]
Task

GET /api/task/project/{projectid}/items/all

projectid: integer
in path

(no description)

options: string
in query

(no description)

200 OK
ProjectTaskItemCollectionItemModel

OK

type
ProjectTaskItemCollectionItemModel
Response Example (200 OK) 
[
  {
    "TaskItemId": "integer",
    "ContactCount": "string",
    "ContactId": "string",
    "Name": "string",
    "TaskPriorityId": "string",
    "TaskPriority": "string",
    "SystemTaskTypeId": "string",
    "TaskType": "string",
    "Contact": "string",
    "AssignedToContactId": "string",
    "AssignedToContact": "string",
    "StartDate": "string",
    "DueDate": "string",
    "CompletedDate": "string",
    "PercentComplete": "string"
  }
]
Task

POST /api/task/project/{projectid}/items/all

ProjectTaskItemAdvancedFilter

undefined

projectid: integer
in path

(no description)

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ProjectId": "integer",
  "TaskTypeId": "string",
  "AssignedToContactId": "string",
  "StartDateBetween": "string",
  "DueDateBetween": "string",
  "CompletedDateBetween": "string",
  "IsOverdue": "boolean",
  "HasDueDate": "boolean",
  "IsOpen": "boolean",
  "IsComplete": "boolean",
  "Criteria": "string"
}
200 OK
ListViewReturnModel<ProjectTaskItemCollectionItemModel>

OK

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

POST /api/task/template/milestones/addedit

ProjectTemplateMilestoneAddEditModel

undefined

Request Example
{
  "Id": "integer",
  "ProjectTemplateMilestoneId": "integer",
  "TenantId": "integer",
  "ProjectTemplateId": "integer",
  "Name": "string"
}
200 OK
ProjectTemplateMilestoneAddEditModel

OK

Response Example (200 OK) 
{
  "Id": "integer",
  "ProjectTemplateMilestoneId": "integer",
  "TenantId": "integer",
  "ProjectTemplateId": "integer",
  "Name": "string"
}
Task

GET /api/task/templates/milestones/lookup/{projecttemplateid}

projecttemplateid: string
in path

(no description)

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"
  }
]
Task

GET /api/task/types/{tasktypeid}

tasktypeid: integer
in path

(no description)

200 OK
AddEditTaskTypeModel

OK

Response Example (200 OK) 
{
  "TaskTypeId": "integer",
  "AuditId": "integer",
  "SystemTaskTypeId": "string",
  "Name": "string",
  "Description": "string",
  "CssColor": "string",
  "IsActive": "boolean"
}
Task

POST /api/task/types/{tasktypeid}

AddEditTaskTypeModel

undefined

tasktypeid: string
in path

(no description)

Request Example
{
  "TaskTypeId": "integer",
  "AuditId": "integer",
  "SystemTaskTypeId": "string",
  "Name": "string",
  "Description": "string",
  "CssColor": "string",
  "IsActive": "boolean"
}
200 OK
TaskTypeCollectionItem

OK

Response Example (200 OK) 
{
  "TaskTypeId": "integer",
  "SystemTaskTypeId": "string",
  "Name": "string",
  "Description": "string",
  "CssColor": "string",
  "IsActive": "boolean"
}
Task

DELETE /api/task/types/{tasktypeid}/{auditid}

tasktypeid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

Task

GET /api/task/types/all

filter: string
in query

(no description)

200 OK
TaskTypeCollectionItem

OK

type
TaskTypeCollectionItem
Response Example (200 OK) 
[
  {
    "TaskTypeId": "integer",
    "SystemTaskTypeId": "string",
    "Name": "string",
    "Description": "string",
    "CssColor": "string",
    "IsActive": "boolean"
  }
]
Task

GET /api/task/types/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"
  }
]

Schema Definitions

CurrentUserTaskSummary: object

TotalOverdueTasks: integer
CurrentUserOverdueTasks: integer
Example
{
  "TotalOverdueTasks": "integer",
  "CurrentUserOverdueTasks": "integer"
}

HttpResponseMessage: object

Version: string
Content: string
StatusCode: string
ReasonPhrase: string
Headers: string
RequestMessage: string
IsSuccessStatusCode: boolean
Example
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

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

TaskItemAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
ProjectId: integer
TaskTypeId: string
AssignedToContactId: string
StartDateBetween: string
DueDateBetween: string
CompletedDateBetween: string
IsOverdue: boolean
HasDueDate: boolean
IsOpen: boolean
IsComplete: boolean
Criteria: string
ProjectName: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ProjectId": "integer",
  "TaskTypeId": "string",
  "AssignedToContactId": "string",
  "StartDateBetween": "string",
  "DueDateBetween": "string",
  "CompletedDateBetween": "string",
  "IsOverdue": "boolean",
  "HasDueDate": "boolean",
  "IsOpen": "boolean",
  "IsComplete": "boolean",
  "Criteria": "string",
  "ProjectName": "string"
}

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

ProjectTaskItemCollectionItemModel: object

TaskItemId: integer
ContactCount: string
ContactId: string
Name: string
TaskPriorityId: string
TaskPriority: string
SystemTaskTypeId: string
TaskType: string
Contact: string
AssignedToContactId: string
AssignedToContact: string
StartDate: string
DueDate: string
CompletedDate: string
PercentComplete: string
Example
{
  "TaskItemId": "integer",
  "ContactCount": "string",
  "ContactId": "string",
  "Name": "string",
  "TaskPriorityId": "string",
  "TaskPriority": "string",
  "SystemTaskTypeId": "string",
  "TaskType": "string",
  "Contact": "string",
  "AssignedToContactId": "string",
  "AssignedToContact": "string",
  "StartDate": "string",
  "DueDate": "string",
  "CompletedDate": "string",
  "PercentComplete": "string"
}

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

ProjectTaskItemAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
ProjectId: integer
TaskTypeId: string
AssignedToContactId: string
StartDateBetween: string
DueDateBetween: string
CompletedDateBetween: string
IsOverdue: boolean
HasDueDate: boolean
IsOpen: boolean
IsComplete: boolean
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ProjectId": "integer",
  "TaskTypeId": "string",
  "AssignedToContactId": "string",
  "StartDateBetween": "string",
  "DueDateBetween": "string",
  "CompletedDateBetween": "string",
  "IsOverdue": "boolean",
  "HasDueDate": "boolean",
  "IsOpen": "boolean",
  "IsComplete": "boolean",
  "Criteria": "string"
}

TaskItemAddEditModel: object

TaskItemId: integer
AuditId: integer
AssignedToContactId: string
Name: string
AuditInfo: string
TaskTypeId: string
TaskPriorityId: string
ProjectName: string
ProjectMilestoneId: string
Contact: string
ProjectId: string
Description: string
TaskItems: string
SystemTaskTypeId: string
StartDate: string
DueDate: string
EstimatedHours: number
DependentOnTaskId: string
IsComplete: boolean
CompletedDate: string
PercentComplete: string
ContactId: string
TaskItemInfoJson: string
TaskData: string
Example
{
  "TaskItemId": "integer",
  "AuditId": "integer",
  "AssignedToContactId": "string",
  "Name": "string",
  "AuditInfo": "string",
  "TaskTypeId": "string",
  "TaskPriorityId": "string",
  "ProjectName": "string",
  "ProjectMilestoneId": "string",
  "Contact": "string",
  "ProjectId": "string",
  "Description": "string",
  "TaskItems": "string",
  "SystemTaskTypeId": "string",
  "StartDate": "string",
  "DueDate": "string",
  "EstimatedHours": "number",
  "DependentOnTaskId": "string",
  "IsComplete": "boolean",
  "CompletedDate": "string",
  "PercentComplete": "string",
  "ContactId": "string",
  "TaskItemInfoJson": "string",
  "TaskData": "string"
}

TaskItemCollectionItemModel: object

TaskItemId: integer
ContactCount: string
ContactId: string
Name: string
TaskPriorityId: string
TaskPriority: string
SystemTaskTypeId: string
TaskType: string
Contact: string
AssignedToContactId: string
AssignedToContact: string
StartDate: string
DueDate: string
CompletedDate: string
PercentComplete: string
ProjectId: string
ProjectName: string
EventId: string
EventName: string
TaskItemInfoJson: string
TotalRecordAvailable: integer
Example
{
  "TaskItemId": "integer",
  "ContactCount": "string",
  "ContactId": "string",
  "Name": "string",
  "TaskPriorityId": "string",
  "TaskPriority": "string",
  "SystemTaskTypeId": "string",
  "TaskType": "string",
  "Contact": "string",
  "AssignedToContactId": "string",
  "AssignedToContact": "string",
  "StartDate": "string",
  "DueDate": "string",
  "CompletedDate": "string",
  "PercentComplete": "string",
  "ProjectId": "string",
  "ProjectName": "string",
  "EventId": "string",
  "EventName": "string",
  "TaskItemInfoJson": "string",
  "TotalRecordAvailable": "integer"
}

Object: object

Example
"object"

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"
}

TaskTypeCollectionItem: object

TaskTypeId: integer
SystemTaskTypeId: string
Name: string
Description: string
CssColor: string
IsActive: boolean
Example
{
  "TaskTypeId": "integer",
  "SystemTaskTypeId": "string",
  "Name": "string",
  "Description": "string",
  "CssColor": "string",
  "IsActive": "boolean"
}

AddEditTaskTypeModel: object

TaskTypeId: integer
AuditId: integer
SystemTaskTypeId: string
Name: string
Description: string
CssColor: string
IsActive: boolean
Example
{
  "TaskTypeId": "integer",
  "AuditId": "integer",
  "SystemTaskTypeId": "string",
  "Name": "string",
  "Description": "string",
  "CssColor": "string",
  "IsActive": "boolean"
}

ProjectMilestoneAddEditModel: object

Id: integer
ProjectMilestoneId: integer
TenantId: integer
ProjectId: integer
Name: string
Example
{
  "Id": "integer",
  "ProjectMilestoneId": "integer",
  "TenantId": "integer",
  "ProjectId": "integer",
  "Name": "string"
}

ProjectTemplateMilestoneAddEditModel: object

Id: integer
ProjectTemplateMilestoneId: integer
TenantId: integer
ProjectTemplateId: integer
Name: string
Example
{
  "Id": "integer",
  "ProjectTemplateMilestoneId": "integer",
  "TenantId": "integer",
  "ProjectTemplateId": "integer",
  "Name": "string"
}
Documentation by Spectacle