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

Chapter

GET /api/chapters/{chapterid}

chapterid: integer
in path

(no description)

200 OK
ChapterAddEditModel

OK

Response Example (200 OK) 
{
  "ChapterId": "integer",
  "OrganizationId": "integer",
  "ChapterName": "string",
  "ChapterNumber": "string",
  "ChapterDescription": "string",
  "OrganizationContactId": "string",
  "ParentOrganizationId": "integer",
  "PrimaryCalenderId": "string",
  "CalendarDescription": "string",
  "GroupTypeId": "string",
  "PrimaryGroupId": "string",
  "DirectoryId": "string",
  "PaymentGatewayId": "string",
  "PaymentGatewayType": "string",
  "PreviousDirectoryId": "string",
  "RemoveContactsFromPreviousDirectory": "boolean",
  "Owners": "string",
  "PostalCodesJson": "string",
  "IsDefaultPostalCodeEmpty": "boolean",
  "AffiliateTenantModel": "string",
  "ShouldAllowChapterTenantEditing": "boolean",
  "ForceSave": "boolean"
}
Chapter

DELETE /api/chapters/{chapterid}

chapterid: integer
in path

(no description)

200 OK

OK

Chapter

POST /api/chapters/{chapterid}/{forcesave}

ChapterAddEditModel

undefined

chapterid: integer
in path

(no description)

forcesave: boolean
in path

(no description)

Request Example
{
  "ChapterId": "integer",
  "OrganizationId": "integer",
  "ChapterName": "string",
  "ChapterNumber": "string",
  "ChapterDescription": "string",
  "OrganizationContactId": "string",
  "ParentOrganizationId": "integer",
  "PrimaryCalenderId": "string",
  "CalendarDescription": "string",
  "GroupTypeId": "string",
  "PrimaryGroupId": "string",
  "DirectoryId": "string",
  "PaymentGatewayId": "string",
  "PaymentGatewayType": "string",
  "PreviousDirectoryId": "string",
  "RemoveContactsFromPreviousDirectory": "boolean",
  "Owners": "string",
  "PostalCodesJson": "string",
  "IsDefaultPostalCodeEmpty": "boolean",
  "AffiliateTenantModel": "string",
  "ShouldAllowChapterTenantEditing": "boolean",
  "ForceSave": "boolean"
}
200 OK
ChapterCollectionModel

OK

Response Example (200 OK) 
{
  "ChapterId": "integer",
  "AuditId": "integer",
  "OrganizationName": "string",
  "ParentOrganizationId": "integer",
  "ParentOrganizationName": "string",
  "City": "string",
  "State": "string"
}
Chapter

GET /api/chapters/chapters/contacts/lookup/{includeparent}

includeparent: string
in path

(no description)

200 OK
ChapterContactSelectModel

OK

type
ChapterContactSelectModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "PaymentGatewayId": "string"
  }
]
Chapter

GET /api/chapters/chapters/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"
  }
]
Chapter

GET /api/chapters/chaptersformembership/contacts/lookup

200 OK
ChapterContactSelectModel

OK

type
ChapterContactSelectModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "PaymentGatewayId": "string"
  }
]
Chapter

GET /api/chapters/chaptersformembership/lookup

200 OK
ChapterContactSelectModel

OK

type
ChapterContactSelectModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "PaymentGatewayId": "string"
  }
]
Chapter

GET /api/chapters/childchapterids/lookup

200 OK
GenericLookUpChoice<Nullable>

OK

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

GET /api/chapters/childchapters/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"
  }
]
Chapter

POST /api/chapters/contactchapter

ContactChapterAddEditModel

undefined

Request Example
{
  "ContactId": "integer",
  "ChapterId": "integer",
  "MarkAsPrimary": "boolean",
  "ContactHasPrimary": "boolean"
}
200 OK

OK

Chapter

GET /api/chapters/contactchapter/{contactid}

contactid: integer
in path

(no description)

200 OK
ContactChapterAddEditModel

OK

Response Example (200 OK) 
{
  "ContactId": "integer",
  "ChapterId": "integer",
  "MarkAsPrimary": "boolean",
  "ContactHasPrimary": "boolean"
}
Chapter

GET /api/chapters/contactchapter/assignzipcodes

200 OK

OK

Chapter

DELETE /api/chapters/contactchapter/delete/{contactid}/{chapterid}

contactid: integer
in path

(no description)

chapterid: integer
in path

(no description)

200 OK

OK

Chapter

GET /api/chapters/contactchapter/lookup/{contactid}

contactid: integer
in path

(no description)

200 OK
ChapterContactSelectModel

OK

type
ChapterContactSelectModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "PaymentGatewayId": "string"
  }
]
Chapter

POST /api/chapters/contactchapter/markasprimary/{contactid}/{chapterid}

contactid: integer
in path

(no description)

chapterid: integer
in path

(no description)

200 OK

OK

Chapter

GET /api/chapters/items

options: string
in query

(no description)

200 OK
ChapterCollectionModel

OK

type
ChapterCollectionModel
Response Example (200 OK) 
[
  {
    "ChapterId": "integer",
    "AuditId": "integer",
    "OrganizationName": "string",
    "ParentOrganizationId": "integer",
    "ParentOrganizationName": "string",
    "City": "string",
    "State": "string"
  }
]
Chapter

GET /api/chapters/membershiptypeoptionchildchapterids/lookup/{includetoplevelselection}

includetoplevelselection: boolean
in path

(no description)

200 OK
GenericLookUpChoice<Nullable>

OK

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

GET /api/chapters/parentchapter/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

ChapterCollectionModel: object

ChapterId: integer
AuditId: integer
OrganizationName: string
ParentOrganizationId: integer
ParentOrganizationName: string
City: string
State: string
Example
{
  "ChapterId": "integer",
  "AuditId": "integer",
  "OrganizationName": "string",
  "ParentOrganizationId": "integer",
  "ParentOrganizationName": "string",
  "City": "string",
  "State": "string"
}

ChapterAddEditModel: object

ChapterId: integer
OrganizationId: integer
ChapterName: string
ChapterNumber: string
ChapterDescription: string
OrganizationContactId: string
ParentOrganizationId: integer
PrimaryCalenderId: string
CalendarDescription: string
GroupTypeId: string
PrimaryGroupId: string
DirectoryId: string
PaymentGatewayId: string
PaymentGatewayType: string
PreviousDirectoryId: string
RemoveContactsFromPreviousDirectory: boolean
Owners: string
PostalCodesJson: string
IsDefaultPostalCodeEmpty: boolean
AffiliateTenantModel: string
ShouldAllowChapterTenantEditing: boolean
ForceSave: boolean
Example
{
  "ChapterId": "integer",
  "OrganizationId": "integer",
  "ChapterName": "string",
  "ChapterNumber": "string",
  "ChapterDescription": "string",
  "OrganizationContactId": "string",
  "ParentOrganizationId": "integer",
  "PrimaryCalenderId": "string",
  "CalendarDescription": "string",
  "GroupTypeId": "string",
  "PrimaryGroupId": "string",
  "DirectoryId": "string",
  "PaymentGatewayId": "string",
  "PaymentGatewayType": "string",
  "PreviousDirectoryId": "string",
  "RemoveContactsFromPreviousDirectory": "boolean",
  "Owners": "string",
  "PostalCodesJson": "string",
  "IsDefaultPostalCodeEmpty": "boolean",
  "AffiliateTenantModel": "string",
  "ShouldAllowChapterTenantEditing": "boolean",
  "ForceSave": "boolean"
}

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

GenericLookUpChoice<Nullable>: object

Id: string
Name: string
ExtraData: string
CssColor: string
IsSelected: boolean
IsDeleted: boolean
Order: integer
Example
{
  "Id": "string",
  "Name": "string",
  "ExtraData": "string",
  "CssColor": "string",
  "IsSelected": "boolean",
  "IsDeleted": "boolean",
  "Order": "integer"
}

ChapterContactSelectModel: object

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

ContactChapterAddEditModel: object

ContactId: integer
ChapterId: integer
MarkAsPrimary: boolean
ContactHasPrimary: boolean
Example
{
  "ContactId": "integer",
  "ChapterId": "integer",
  "MarkAsPrimary": "boolean",
  "ContactHasPrimary": "boolean"
}

Boolean: object

Example
"object"
Documentation by Spectacle