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

Directory

POST /api/directory/adddirectorylistingsbymembershiptype/save

AddDirectoryListingsByMembershipTypeModel

undefined

Request Example
{
  "DirectoryItems": "string"
}
200 OK

OK

Directory

GET /api/directory/all/{modifiedsince}

modifiedsince: string
in path

(no description)

200 OK
DirectoryContactsViewModel

OK

type
DirectoryContactsViewModel
Response Example (200 OK) 
[
  {
    "ContactId": "integer",
    "DisplayName": "string",
    "CommonName": "string",
    "ShortDescription": "string",
    "Description": "string",
    "Keywords": "string",
    "Highlights": "string",
    "LastModifiedDate": "string",
    "SystemContactTypeId": "string",
    "Images": "string",
    "Addresses": "string",
    "EmailAddresses": "string",
    "PhoneNumbers": "string",
    "Directories": "string",
    "WebAddresses": "string",
    "Categories": "string"
  }
]
Directory

GET /api/directory/directories

200 OK
DirectoriesListItem

OK

type
DirectoriesListItem
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "DirectoryId": "integer",
    "Name": "string",
    "AuditId": "integer",
    "Localize": "string",
    "Description": "string",
    "DirectoryListingTypeId": "integer",
    "DirectoryListingTypeName": "string",
    "IsPublic": "boolean",
    "ExtraData": "boolean",
    "IsVisibleToMembers": "boolean",
    "Availability": "string",
    "AutomaticallyAddRemoveMembers": "boolean",
    "Actions": "string"
  }
]
Directory

GET /api/directory/directories/{directoryid}

directoryid: string
in path

(no description)

200 OK
AddEditDirectoryModel

OK

Response Example (200 OK) 
{
  "DirectoryId": "integer",
  "Name": "string",
  "DisplayName": "string",
  "Description": "string",
  "DirectoryListingTypeId": "integer",
  "SortOrder": "integer",
  "CategoryListId": "integer",
  "CatLists": "string",
  "OrderCategoryResults": "string",
  "IsPublic": "boolean",
  "IsHub": "boolean",
  "HubIconCssClass": "string",
  "SearchFilterOptions": "string",
  "KeywordSearchOptions": "string",
  "CustomFields": "string",
  "IsMultiTenant": "boolean",
  "AutomaticallyAddRemoveMembers": "boolean",
  "ObjectTypeId": "string",
  "SearchObjectTypeId": "string",
  "ShowIsPublicProperty": "boolean",
  "InDevelopment": "boolean"
}
Directory

POST /api/directory/directories/{directoryid}

AddEditDirectoryModel

undefined

directoryid: integer
in path

(no description)

Request Example
{
  "DirectoryId": "integer",
  "Name": "string",
  "DisplayName": "string",
  "Description": "string",
  "DirectoryListingTypeId": "integer",
  "SortOrder": "integer",
  "CategoryListId": "integer",
  "CatLists": "string",
  "OrderCategoryResults": "string",
  "IsPublic": "boolean",
  "IsHub": "boolean",
  "HubIconCssClass": "string",
  "SearchFilterOptions": "string",
  "KeywordSearchOptions": "string",
  "CustomFields": "string",
  "IsMultiTenant": "boolean",
  "AutomaticallyAddRemoveMembers": "boolean",
  "ObjectTypeId": "string",
  "SearchObjectTypeId": "string",
  "ShowIsPublicProperty": "boolean",
  "InDevelopment": "boolean"
}
200 OK
DirectoriesListItem

OK

Response Example (200 OK) 
{
  "Id": "integer",
  "DirectoryId": "integer",
  "Name": "string",
  "AuditId": "integer",
  "Localize": "string",
  "Description": "string",
  "DirectoryListingTypeId": "integer",
  "DirectoryListingTypeName": "string",
  "IsPublic": "boolean",
  "ExtraData": "boolean",
  "IsVisibleToMembers": "boolean",
  "Availability": "string",
  "AutomaticallyAddRemoveMembers": "boolean",
  "Actions": "string"
}
Directory

DELETE /api/directory/directories/{directoryid}

directoryid: integer
in path

(no description)

200 OK

OK

Directory

GET /api/directory/directories/{directoryid}/public/details/{id}

directoryid: integer
in path

(no description)

id: integer
in path

(no description)

200 OK
DirectoryContactDetailViewModel

OK

Response Example (200 OK) 
{
  "DirectoryContactId": "integer",
  "DirectoryId": "integer",
  "ContactId": "integer",
  "HashedContactId": "string",
  "Name": "string",
  "MainImage": "string",
  "ImageUrl": "string",
  "ImageShortDescription": "string",
  "GalleryImages": "string",
  "GalleryImageDetails": "string",
  "contactFields": "string",
  "directoryFields": "string",
  "fieldOrder": "string",
  "CustomFields": "string",
  "ShortDescription": "string",
  "Description": "string",
  "Bio": "string",
  "Highlights": "string",
  "Keywords": "string",
  "CommonName": "string",
  "ContactCommonName": "string",
  "OrgName": "string",
  "Categories": "string",
  "PrimaryAddress": "string",
  "primaryAddressId": "string",
  "Addresses": "string",
  "primaryPhoneId": "string",
  "PrimaryPhone": "string",
  "Phones": "string",
  "primaryWebsiteId": "string",
  "PrimaryWebsite": "string",
  "Websites": "string",
  "PrimaryEmail": "string",
  "primaryEmailId": "string",
  "EmailAddresses": "string",
  "images": "string",
  "Videos": "string",
  "EnhancedOnMap": "boolean",
  "ShowRelatedContacts": "boolean",
  "ShowPrimaryContact": "boolean",
  "visibilityJson": "string",
  "visibility": "string",
  "Visibility": "string",
  "settingsJson": "string",
  "settings": "string",
  "Settings": "string",
  "RelatedContacts": "string",
  "RelatedOrgs": "string",
  "RelatedOrgsAndContactsSorted": "string",
  "ContactTypeId": "string",
  "MembershipType": "string",
  "MembershipTypes": "string",
  "PublicContent": "string",
  "Prefix": "string",
  "FirstName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "Suffix": "string",
  "Title": "string",
  "PrimaryOrg": "string",
  "PrimaryContactId": "string",
  "IsAddressValid": "boolean",
  "MLSId": "string",
  "RETSVendorId": "string",
  "EditionFieldsJson": "string",
  "DirectoryListingTypeId": "string"
}
Directory

GET /api/directory/directories/{directoryid}/public/find

directoryid: string
in path

(no description)

pid: string
in query

(no description)

term: string
in query

(no description)

namestartswithterm: string
in query

(no description)

returngeodata: string
in query

(no description)

advfilter: string
in query

(no description)

tenantid: string
in query

(no description)

showpostalcodefilter: string
in query

(no description)

organizationid: string
in query

Added for default Geodata filtering on GZ-19858

defaultlayout: string
in query

(no description)

parsedfilter: string
in query

(no description)

200 OK
DirectorySearchViewModel

OK

Response Example (200 OK) 
{
  "DefaultListingTypeId": "integer",
  "Description": "string",
  "settingsJson": "string",
  "displayName": "string",
  "name": "string",
  "Name": "string",
  "AlphabetizeResults": "boolean",
  "ShowRelatedContacts": "boolean",
  "ShowPrimaryContact": "boolean",
  "CategoryItemId": "string",
  "ShowPostalCodeFilter": "boolean",
  "ListItems": "string",
  "DisplayRadiusSearch": "boolean",
  "AdvancedSearchFilter": "string",
  "ResultCount": "string",
  "DefaultLayout": "string"
}
Directory

GET /api/directory/directories/{directoryid}/public/index

directoryid: integer
in path

(no description)

200 OK
DirectoryDetailViewModel

OK

Response Example (200 OK) 
{
  "DirectoryId": "integer",
  "displayName": "string",
  "name": "string",
  "Name": "string",
  "Description": "string",
  "ShowCategoryImages": "boolean",
  "OGMeta": "string",
  "TotalEntries": "integer",
  "Categories": "string",
  "ShowPostalCodeFilter": "boolean",
  "DisplayRadiusSearch": "boolean"
}
Directory

GET /api/directory/directories/chapters/{chapterid}

chapterid: integer
in path

(no description)

200 OK
DirectoriesListItem

OK

type
DirectoriesListItem
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "DirectoryId": "integer",
    "Name": "string",
    "AuditId": "integer",
    "Localize": "string",
    "Description": "string",
    "DirectoryListingTypeId": "integer",
    "DirectoryListingTypeName": "string",
    "IsPublic": "boolean",
    "ExtraData": "boolean",
    "IsVisibleToMembers": "boolean",
    "Availability": "string",
    "AutomaticallyAddRemoveMembers": "boolean",
    "Actions": "string"
  }
]
Directory

GET /api/directory/directories/setup

DirectoriesListItemFilter

undefined

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "Criteria": "string"
}
200 OK
ListViewReturnModel<DirectoriesListItem>

OK

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

GET /api/directory/directorylistingtypes

200 OK
DirectoryListingTypeListItem

OK

type
DirectoryListingTypeListItem
Response Example (200 OK) 
[
  {
    "DirectoryListingTypeId": "integer",
    "Id": "integer",
    "AuditId": "integer",
    "Name": "string",
    "Description": "string",
    "Count": "integer",
    "Actions": "string"
  }
]
Directory

POST /api/directory/directorylistingtypes

AddEditDirectoryListingTypeModel

undefined

Request Example
{
  "DirectoryListingTypeId": "integer",
  "Id": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "DefaultRank": "string",
  "ShowIndividualDetails": "string",
  "ShowContactDetails": "string",
  "ShowCustomFields": "string",
  "ShowRelatedContacts": "boolean",
  "ShowContactsWithMemberships": "boolean",
  "ShowPrimaryContact": "boolean",
  "DirectLinkToDestinationSite": "boolean",
  "OpenLinksInNewTab": "boolean",
  "Options": "string",
  "Retargeting": "string",
  "EnhancedOnMap": "boolean",
  "IsDeletable": "boolean",
  "Count": "integer",
  "ShowRETSDirectoryLinkOption": "boolean"
}
200 OK
AddEditDirectoryListingTypeModel

OK

Response Example (200 OK) 
{
  "DirectoryListingTypeId": "integer",
  "Id": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "DefaultRank": "string",
  "ShowIndividualDetails": "string",
  "ShowContactDetails": "string",
  "ShowCustomFields": "string",
  "ShowRelatedContacts": "boolean",
  "ShowContactsWithMemberships": "boolean",
  "ShowPrimaryContact": "boolean",
  "DirectLinkToDestinationSite": "boolean",
  "OpenLinksInNewTab": "boolean",
  "Options": "string",
  "Retargeting": "string",
  "EnhancedOnMap": "boolean",
  "IsDeletable": "boolean",
  "Count": "integer",
  "ShowRETSDirectoryLinkOption": "boolean"
}
Directory

GET /api/directory/directorylistingtypes/{directorylistingtypeid}

directorylistingtypeid: integer
in path

(no description)

200 OK
AddEditDirectoryListingTypeModel

OK

Response Example (200 OK) 
{
  "DirectoryListingTypeId": "integer",
  "Id": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "DefaultRank": "string",
  "ShowIndividualDetails": "string",
  "ShowContactDetails": "string",
  "ShowCustomFields": "string",
  "ShowRelatedContacts": "boolean",
  "ShowContactsWithMemberships": "boolean",
  "ShowPrimaryContact": "boolean",
  "DirectLinkToDestinationSite": "boolean",
  "OpenLinksInNewTab": "boolean",
  "Options": "string",
  "Retargeting": "string",
  "EnhancedOnMap": "boolean",
  "IsDeletable": "boolean",
  "Count": "integer",
  "ShowRETSDirectoryLinkOption": "boolean"
}
Directory

DELETE /api/directory/directorylistingtypes/{directorylistingtypeid}/{auditid}

directorylistingtypeid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

Schema Definitions

DirectoriesListItem: object

Id: integer
DirectoryId: integer
Name: string
AuditId: integer
Localize: string
Description: string
DirectoryListingTypeId: integer
DirectoryListingTypeName: string
IsPublic: boolean
ExtraData: boolean
IsVisibleToMembers: boolean
Availability: string
AutomaticallyAddRemoveMembers: boolean
Actions: string
Example
{
  "Id": "integer",
  "DirectoryId": "integer",
  "Name": "string",
  "AuditId": "integer",
  "Localize": "string",
  "Description": "string",
  "DirectoryListingTypeId": "integer",
  "DirectoryListingTypeName": "string",
  "IsPublic": "boolean",
  "ExtraData": "boolean",
  "IsVisibleToMembers": "boolean",
  "Availability": "string",
  "AutomaticallyAddRemoveMembers": "boolean",
  "Actions": "string"
}

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

DirectoriesListItemFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "Criteria": "string"
}

AddEditDirectoryModel: object

DirectoryId: integer
Name: string
DisplayName: string
Description: string
DirectoryListingTypeId: integer
SortOrder: integer
CategoryListId: integer
CatLists: string
OrderCategoryResults: string
IsPublic: boolean
IsHub: boolean
HubIconCssClass: string
SearchFilterOptions: string
KeywordSearchOptions: string
CustomFields: string
IsMultiTenant: boolean
AutomaticallyAddRemoveMembers: boolean
ObjectTypeId: string
SearchObjectTypeId: string
ShowIsPublicProperty: boolean
InDevelopment: boolean
Example
{
  "DirectoryId": "integer",
  "Name": "string",
  "DisplayName": "string",
  "Description": "string",
  "DirectoryListingTypeId": "integer",
  "SortOrder": "integer",
  "CategoryListId": "integer",
  "CatLists": "string",
  "OrderCategoryResults": "string",
  "IsPublic": "boolean",
  "IsHub": "boolean",
  "HubIconCssClass": "string",
  "SearchFilterOptions": "string",
  "KeywordSearchOptions": "string",
  "CustomFields": "string",
  "IsMultiTenant": "boolean",
  "AutomaticallyAddRemoveMembers": "boolean",
  "ObjectTypeId": "string",
  "SearchObjectTypeId": "string",
  "ShowIsPublicProperty": "boolean",
  "InDevelopment": "boolean"
}

DirectoryDetailViewModel: object

DirectoryId: integer
displayName: string
name: string
Name: string
Description: string
ShowCategoryImages: boolean
OGMeta: string
TotalEntries: integer
Categories: string
ShowPostalCodeFilter: boolean
DisplayRadiusSearch: boolean
Example
{
  "DirectoryId": "integer",
  "displayName": "string",
  "name": "string",
  "Name": "string",
  "Description": "string",
  "ShowCategoryImages": "boolean",
  "OGMeta": "string",
  "TotalEntries": "integer",
  "Categories": "string",
  "ShowPostalCodeFilter": "boolean",
  "DisplayRadiusSearch": "boolean"
}

DirectorySearchViewModel: object

DefaultListingTypeId: integer
Description: string
settingsJson: string
displayName: string
name: string
Name: string
AlphabetizeResults: boolean
ShowRelatedContacts: boolean
ShowPrimaryContact: boolean
CategoryItemId: string
ShowPostalCodeFilter: boolean
ListItems: string
DisplayRadiusSearch: boolean
AdvancedSearchFilter: string
ResultCount: string
DefaultLayout: string
Example
{
  "DefaultListingTypeId": "integer",
  "Description": "string",
  "settingsJson": "string",
  "displayName": "string",
  "name": "string",
  "Name": "string",
  "AlphabetizeResults": "boolean",
  "ShowRelatedContacts": "boolean",
  "ShowPrimaryContact": "boolean",
  "CategoryItemId": "string",
  "ShowPostalCodeFilter": "boolean",
  "ListItems": "string",
  "DisplayRadiusSearch": "boolean",
  "AdvancedSearchFilter": "string",
  "ResultCount": "string",
  "DefaultLayout": "string"
}

DirectoryContactDetailViewModel: object

DirectoryContactId: integer
DirectoryId: integer
ContactId: integer
HashedContactId: string
Name: string
MainImage: string
ImageUrl: string
ImageShortDescription: string
GalleryImages: string
GalleryImageDetails: string
contactFields: string
directoryFields: string
fieldOrder: string
CustomFields: string
ShortDescription: string
Description: string
Bio: string
Highlights: string
Keywords: string
CommonName: string
ContactCommonName: string
OrgName: string
Categories: string
PrimaryAddress: string
primaryAddressId: string
Addresses: string
primaryPhoneId: string
PrimaryPhone: string
Phones: string
primaryWebsiteId: string
PrimaryWebsite: string
Websites: string
PrimaryEmail: string
primaryEmailId: string
EmailAddresses: string
images: string
Videos: string
EnhancedOnMap: boolean
ShowRelatedContacts: boolean
ShowPrimaryContact: boolean
visibilityJson: string
visibility: string
Visibility: string
settingsJson: string
settings: string
Settings: string
RelatedContacts: string
RelatedOrgs: string
RelatedOrgsAndContactsSorted: string
ContactTypeId: string
MembershipType: string
MembershipTypes: string
PublicContent: string
Prefix: string
FirstName: string
MiddleName: string
LastName: string
Suffix: string
Title: string
PrimaryOrg: string
PrimaryContactId: string
IsAddressValid: boolean
MLSId: string
RETSVendorId: string
EditionFieldsJson: string
DirectoryListingTypeId: string
Example
{
  "DirectoryContactId": "integer",
  "DirectoryId": "integer",
  "ContactId": "integer",
  "HashedContactId": "string",
  "Name": "string",
  "MainImage": "string",
  "ImageUrl": "string",
  "ImageShortDescription": "string",
  "GalleryImages": "string",
  "GalleryImageDetails": "string",
  "contactFields": "string",
  "directoryFields": "string",
  "fieldOrder": "string",
  "CustomFields": "string",
  "ShortDescription": "string",
  "Description": "string",
  "Bio": "string",
  "Highlights": "string",
  "Keywords": "string",
  "CommonName": "string",
  "ContactCommonName": "string",
  "OrgName": "string",
  "Categories": "string",
  "PrimaryAddress": "string",
  "primaryAddressId": "string",
  "Addresses": "string",
  "primaryPhoneId": "string",
  "PrimaryPhone": "string",
  "Phones": "string",
  "primaryWebsiteId": "string",
  "PrimaryWebsite": "string",
  "Websites": "string",
  "PrimaryEmail": "string",
  "primaryEmailId": "string",
  "EmailAddresses": "string",
  "images": "string",
  "Videos": "string",
  "EnhancedOnMap": "boolean",
  "ShowRelatedContacts": "boolean",
  "ShowPrimaryContact": "boolean",
  "visibilityJson": "string",
  "visibility": "string",
  "Visibility": "string",
  "settingsJson": "string",
  "settings": "string",
  "Settings": "string",
  "RelatedContacts": "string",
  "RelatedOrgs": "string",
  "RelatedOrgsAndContactsSorted": "string",
  "ContactTypeId": "string",
  "MembershipType": "string",
  "MembershipTypes": "string",
  "PublicContent": "string",
  "Prefix": "string",
  "FirstName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "Suffix": "string",
  "Title": "string",
  "PrimaryOrg": "string",
  "PrimaryContactId": "string",
  "IsAddressValid": "boolean",
  "MLSId": "string",
  "RETSVendorId": "string",
  "EditionFieldsJson": "string",
  "DirectoryListingTypeId": "string"
}

Object: object

Example
"object"

DirectoryListingTypeListItem: object

DirectoryListingTypeId: integer
Id: integer
AuditId: integer
Name: string
Description: string
Count: integer
Actions: string
Example
{
  "DirectoryListingTypeId": "integer",
  "Id": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "Count": "integer",
  "Actions": "string"
}

AddEditDirectoryListingTypeModel: object

DirectoryListingTypeId: integer
Id: integer
AuditId: integer
Name: string
Description: string
DefaultRank: string
ShowIndividualDetails: string
ShowContactDetails: string
ShowCustomFields: string
ShowRelatedContacts: boolean
ShowContactsWithMemberships: boolean
ShowPrimaryContact: boolean
DirectLinkToDestinationSite: boolean
OpenLinksInNewTab: boolean
Options: string
Retargeting: string
EnhancedOnMap: boolean
IsDeletable: boolean
Count: integer
ShowRETSDirectoryLinkOption: boolean
Example
{
  "DirectoryListingTypeId": "integer",
  "Id": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "DefaultRank": "string",
  "ShowIndividualDetails": "string",
  "ShowContactDetails": "string",
  "ShowCustomFields": "string",
  "ShowRelatedContacts": "boolean",
  "ShowContactsWithMemberships": "boolean",
  "ShowPrimaryContact": "boolean",
  "DirectLinkToDestinationSite": "boolean",
  "OpenLinksInNewTab": "boolean",
  "Options": "string",
  "Retargeting": "string",
  "EnhancedOnMap": "boolean",
  "IsDeletable": "boolean",
  "Count": "integer",
  "ShowRETSDirectoryLinkOption": "boolean"
}

DirectoryContactsViewModel: object

ContactId: integer
DisplayName: string
CommonName: string
ShortDescription: string
Description: string
Keywords: string
Highlights: string
LastModifiedDate: string
SystemContactTypeId: string
Images: string
Addresses: string
EmailAddresses: string
PhoneNumbers: string
Directories: string
WebAddresses: string
Categories: string
Example
{
  "ContactId": "integer",
  "DisplayName": "string",
  "CommonName": "string",
  "ShortDescription": "string",
  "Description": "string",
  "Keywords": "string",
  "Highlights": "string",
  "LastModifiedDate": "string",
  "SystemContactTypeId": "string",
  "Images": "string",
  "Addresses": "string",
  "EmailAddresses": "string",
  "PhoneNumbers": "string",
  "Directories": "string",
  "WebAddresses": "string",
  "Categories": "string"
}

AddDirectoryListingsByMembershipTypeModel: object

DirectoryItems: string
Example
{
  "DirectoryItems": "string"
}
Documentation by Spectacle