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

CategoryList

POST /api/categorylists/{categorylistid}

CategoryListAddEditModel

undefined

categorylistid: integer
in path

(no description)

Request Example
{
  "CategoryListId": "integer",
  "AuditId": "integer",
  "IsSystem": "boolean",
  "CategoryTypeId": "string",
  "Name": "string",
  "Description": "string",
  "IsActive": "boolean",
  "IsPublic": "boolean",
  "IsMemberViewable": "boolean",
  "IsMemberEditable": "boolean",
  "IsRequired": "boolean",
  "MinQuantity": "string",
  "MaxQuantity": "string"
}
200 OK
CategoryListCollectionItemModel

OK

Response Example (200 OK) 
{
  "Id": "integer",
  "CategoryListId": "integer",
  "AuditId": "integer",
  "IsSystem": "boolean",
  "CategoryTypeId": "string",
  "CategoryTypeName": "string",
  "Name": "string",
  "Description": "string",
  "IsPublic": "boolean",
  "ObjectTypeId": "string",
  "ObjectType": "string",
  "ItemsCount": "integer",
  "Actions": "string",
  "IsReadOnly": "boolean",
  "HideDelete": "boolean",
  "IsStaff": "boolean",
  "TotalRecordAvailable": "integer"
}
CategoryList

DELETE /api/categorylists/{categorylistid}/{auditid}

categorylistid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

CategoryList

GET /api/categorylists/{categorylistid}/{auditid}/items

categorylistid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK
CategoryListAddEditModel

OK

Response Example (200 OK) 
{
  "CategoryListId": "integer",
  "AuditId": "integer",
  "IsSystem": "boolean",
  "CategoryTypeId": "string",
  "Name": "string",
  "Description": "string",
  "IsActive": "boolean",
  "IsPublic": "boolean",
  "IsMemberViewable": "boolean",
  "IsMemberEditable": "boolean",
  "IsRequired": "boolean",
  "MinQuantity": "string",
  "MaxQuantity": "string"
}
CategoryList

GET /api/categorylists/all

options: string
in query

(no description)

200 OK
ListViewReturnModel<CategoryListCollectionItemModel>

OK

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

GET /api/categorylists/certificationcategoryitem/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"
  }
]
CategoryList

GET /api/categorylists/contactcategoryitem/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"
  }
]
CategoryList

GET /api/categorylists/lookup/{categorytypeid}/{showemptylists}

categorytypeid: string
in path

(no description)

showemptylists: boolean
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"
  }
]
CategoryList

GET /api/categorylists/lookup/categorytypeid

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

GET /api/categorylists/lookup/reassigncategorylist/{categorytypeid}

categorytypeid: 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"
  }
]
CategoryList

GET /api/categorylists/productcategoryitems/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"
  }
]
CategoryList

GET /api/categorylists/projectcategoryitem/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"
  }
]
CategoryList

GET /api/categorylists/publiccontactcategoryitem/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"
  }
]
CategoryList

POST /api/categorylists/salescategory/{categorylistid}

SalesOpportunityCategoryListAddEditModel

undefined

categorylistid: integer
in path

(no description)

Request Example
{
  "CategoryListId": "integer",
  "AuditId": "integer",
  "IsSystem": "boolean",
  "CategoryTypeId": "string",
  "Name": "string",
  "Description": "string",
  "IsActive": "boolean",
  "IsPublic": "boolean",
  "IsMemberViewable": "boolean",
  "IsMemberEditable": "boolean",
  "IsRequired": "boolean",
  "MinQuantity": "string",
  "MaxQuantity": "string"
}
200 OK
CategoryListCollectionItemModel

OK

Response Example (200 OK) 
{
  "Id": "integer",
  "CategoryListId": "integer",
  "AuditId": "integer",
  "IsSystem": "boolean",
  "CategoryTypeId": "string",
  "CategoryTypeName": "string",
  "Name": "string",
  "Description": "string",
  "IsPublic": "boolean",
  "ObjectTypeId": "string",
  "ObjectType": "string",
  "ItemsCount": "integer",
  "Actions": "string",
  "IsReadOnly": "boolean",
  "HideDelete": "boolean",
  "IsStaff": "boolean",
  "TotalRecordAvailable": "integer"
}
CategoryList

GET /api/categorylists/salescategory/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

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

CategoryListAddEditModel: object

CategoryListId: integer
AuditId: integer
IsSystem: boolean
CategoryTypeId: string
Name: string
Description: string
IsActive: boolean
IsPublic: boolean
IsMemberViewable: boolean
IsMemberEditable: boolean
IsRequired: boolean
MinQuantity: string
MaxQuantity: string
Example
{
  "CategoryListId": "integer",
  "AuditId": "integer",
  "IsSystem": "boolean",
  "CategoryTypeId": "string",
  "Name": "string",
  "Description": "string",
  "IsActive": "boolean",
  "IsPublic": "boolean",
  "IsMemberViewable": "boolean",
  "IsMemberEditable": "boolean",
  "IsRequired": "boolean",
  "MinQuantity": "string",
  "MaxQuantity": "string"
}

CategoryListCollectionItemModel: object

Id: integer
CategoryListId: integer
AuditId: integer
IsSystem: boolean
CategoryTypeId: string
CategoryTypeName: string
Name: string
Description: string
IsPublic: boolean
ObjectTypeId: string
ObjectType: string
ItemsCount: integer
Actions: string
IsReadOnly: boolean
HideDelete: boolean
IsStaff: boolean
TotalRecordAvailable: integer
Example
{
  "Id": "integer",
  "CategoryListId": "integer",
  "AuditId": "integer",
  "IsSystem": "boolean",
  "CategoryTypeId": "string",
  "CategoryTypeName": "string",
  "Name": "string",
  "Description": "string",
  "IsPublic": "boolean",
  "ObjectTypeId": "string",
  "ObjectType": "string",
  "ItemsCount": "integer",
  "Actions": "string",
  "IsReadOnly": "boolean",
  "HideDelete": "boolean",
  "IsStaff": "boolean",
  "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"
}

SalesOpportunityCategoryListAddEditModel: object

CategoryListId: integer
AuditId: integer
IsSystem: boolean
CategoryTypeId: string
Name: string
Description: string
IsActive: boolean
IsPublic: boolean
IsMemberViewable: boolean
IsMemberEditable: boolean
IsRequired: boolean
MinQuantity: string
MaxQuantity: string
Example
{
  "CategoryListId": "integer",
  "AuditId": "integer",
  "IsSystem": "boolean",
  "CategoryTypeId": "string",
  "Name": "string",
  "Description": "string",
  "IsActive": "boolean",
  "IsPublic": "boolean",
  "IsMemberViewable": "boolean",
  "IsMemberEditable": "boolean",
  "IsRequired": "boolean",
  "MinQuantity": "string",
  "MaxQuantity": "string"
}
Documentation by Spectacle