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

Connection

GET /api/connection/{connectionid}

connectionid: integer
in path

(no description)

200 OK
ConnectionAddEditModel

OK

Response Example (200 OK) 
{
  "Id": "integer",
  "ConnectionId": "integer",
  "IsActive": "boolean",
  "MembershipFeedId": "integer",
  "CreatedDate": "string",
  "ExchangeId": "integer",
  "ConectedTenantName": "string",
  "ReadOnly": "boolean",
  "IsDeleted": "boolean",
  "ForceSave": "boolean",
  "IsContactFeedReadOnly": "boolean",
  "SourceTenantKey": "string",
  "IsMembershipsSync": "boolean",
  "IsMemberShipOwnerContactInSync": "boolean",
  "MembershipFeeds": "string",
  "IsContactFeedSync": "boolean",
  "IsIndividualGeneralInfo": "boolean",
  "IsIndividualPhonesEmailsSites": "boolean",
  "IsIndividualAddresses": "boolean",
  "IsIndividualCustomFields": "boolean",
  "IndividualCustomFields": "string",
  "IsBusinessGeneralInfo": "boolean",
  "IsBusinessPhonesEmailsSites": "boolean",
  "IsBusinessAddresses": "boolean",
  "IsBusinessCustomFields": "boolean",
  "BusinessCustomFields": "string"
}
Connection

POST /api/connection/{connectionid}

ConnectionAddEditModel

undefined

connectionid: string
in path

(no description)

forcesave: boolean
in query

(no description)

Request Example
{
  "Id": "integer",
  "ConnectionId": "integer",
  "IsActive": "boolean",
  "MembershipFeedId": "integer",
  "CreatedDate": "string",
  "ExchangeId": "integer",
  "ConectedTenantName": "string",
  "ReadOnly": "boolean",
  "IsDeleted": "boolean",
  "ForceSave": "boolean",
  "IsContactFeedReadOnly": "boolean",
  "SourceTenantKey": "string",
  "IsMembershipsSync": "boolean",
  "IsMemberShipOwnerContactInSync": "boolean",
  "MembershipFeeds": "string",
  "IsContactFeedSync": "boolean",
  "IsIndividualGeneralInfo": "boolean",
  "IsIndividualPhonesEmailsSites": "boolean",
  "IsIndividualAddresses": "boolean",
  "IsIndividualCustomFields": "boolean",
  "IndividualCustomFields": "string",
  "IsBusinessGeneralInfo": "boolean",
  "IsBusinessPhonesEmailsSites": "boolean",
  "IsBusinessAddresses": "boolean",
  "IsBusinessCustomFields": "boolean",
  "BusinessCustomFields": "string"
}
200 OK
ConnectionCollectionItemModel

OK

Response Example (200 OK) 
{
  "Id": "integer",
  "ConnectionId": "integer",
  "IsDeleted": "boolean",
  "SourceTenantKey": "string",
  "TargetTenantKey": "string",
  "SourceTenantName": "string",
  "TargetTenantName": "string",
  "IsActive": "boolean",
  "IsStaff": "boolean",
  "IsSource": "boolean",
  "HideDelete": "boolean",
  "HideView": "boolean",
  "HideEdit": "boolean",
  "HideEnable": "boolean",
  "HideDisable": "boolean",
  "CssClass": "string",
  "SyncRole": "string",
  "ConnectedTenant": "string",
  "CreatedDate": "string",
  "ConnectionStatusTypeId": "string",
  "LastDisabled": "string",
  "LastEnabled": "string",
  "Actions": "string"
}
Connection

DELETE /api/connection/{connectionid}

connectionid: integer
in path

(no description)

200 OK

OK

Connection

GET /api/connection/all

options: string
in query

(no description)

200 OK
ListViewReturnModel<ConnectionCollectionItemModel>

OK

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

POST /api/connection/disable/{connectionid}

connectionid: integer
in path

(no description)

200 OK

OK

Connection

POST /api/connection/enable/{connectionid}

connectionid: integer
in path

(no description)

200 OK

OK

Connection

GET /api/connection/individualcustomfield/lookup/{sourcetenantkey}

sourcetenantkey: string
in path

(no description)

200 OK
ItemChoiceModel

OK

type
ItemChoiceModel
Response Example (200 OK) 
[
  {
    "IsSelected": "boolean",
    "PreviouslySelected": "boolean",
    "Id": "integer",
    "Name": "string",
    "Order": "integer"
  }
]
Connection

GET /api/connection/membershiptype/lookup

200 OK
MembershipTypeMappingDataModel

OK

type
MembershipTypeMappingDataModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "OwnedByType": "string",
    "InheritanceType": "string"
  }
]
Connection

GET /api/connection/membershiptype/lookup/{sourcetenantkey}

sourcetenantkey: string
in path

(no description)

200 OK
MembershipTypeMappingDataModel

OK

type
MembershipTypeMappingDataModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "OwnedByType": "string",
    "InheritanceType": "string"
  }
]
Connection

GET /api/connection/membershiptypelevel/lookup/{sourcetenantkey}

sourcetenantkey: 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"
  }
]
Connection

GET /api/connection/organizationcustomfield/lookup/{sourcetenantkey}

sourcetenantkey: string
in path

(no description)

200 OK
ItemChoiceModel

OK

type
ItemChoiceModel
Response Example (200 OK) 
[
  {
    "IsSelected": "boolean",
    "PreviouslySelected": "boolean",
    "Id": "integer",
    "Name": "string",
    "Order": "integer"
  }
]
Connection

GET /api/connection/tenants/lookup

200 OK
TenantForConnectionItemModel

OK

type
TenantForConnectionItemModel
Response Example (200 OK) 
[
  {
    "Id": "string",
    "SyncFromTenantKey": "string",
    "ExchangeId": "integer",
    "Name": "string",
    "ConectedTenantName": "string"
  }
]

Schema Definitions

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

ConnectionAddEditModel: object

Id: integer
ConnectionId: integer
IsActive: boolean
MembershipFeedId: integer
CreatedDate: string
ExchangeId: integer
ConectedTenantName: string
ReadOnly: boolean
IsDeleted: boolean
ForceSave: boolean
IsContactFeedReadOnly: boolean
SourceTenantKey: string
IsMembershipsSync: boolean
IsMemberShipOwnerContactInSync: boolean
MembershipFeeds: string
IsContactFeedSync: boolean
IsIndividualGeneralInfo: boolean
IsIndividualPhonesEmailsSites: boolean
IsIndividualAddresses: boolean
IsIndividualCustomFields: boolean
IndividualCustomFields: string
IsBusinessGeneralInfo: boolean
IsBusinessPhonesEmailsSites: boolean
IsBusinessAddresses: boolean
IsBusinessCustomFields: boolean
BusinessCustomFields: string
Example
{
  "Id": "integer",
  "ConnectionId": "integer",
  "IsActive": "boolean",
  "MembershipFeedId": "integer",
  "CreatedDate": "string",
  "ExchangeId": "integer",
  "ConectedTenantName": "string",
  "ReadOnly": "boolean",
  "IsDeleted": "boolean",
  "ForceSave": "boolean",
  "IsContactFeedReadOnly": "boolean",
  "SourceTenantKey": "string",
  "IsMembershipsSync": "boolean",
  "IsMemberShipOwnerContactInSync": "boolean",
  "MembershipFeeds": "string",
  "IsContactFeedSync": "boolean",
  "IsIndividualGeneralInfo": "boolean",
  "IsIndividualPhonesEmailsSites": "boolean",
  "IsIndividualAddresses": "boolean",
  "IsIndividualCustomFields": "boolean",
  "IndividualCustomFields": "string",
  "IsBusinessGeneralInfo": "boolean",
  "IsBusinessPhonesEmailsSites": "boolean",
  "IsBusinessAddresses": "boolean",
  "IsBusinessCustomFields": "boolean",
  "BusinessCustomFields": "string"
}

ConnectionCollectionItemModel: object

Id: integer
ConnectionId: integer
IsDeleted: boolean
SourceTenantKey: string
TargetTenantKey: string
SourceTenantName: string
TargetTenantName: string
IsActive: boolean
IsStaff: boolean
IsSource: boolean
HideDelete: boolean
HideView: boolean
HideEdit: boolean
HideEnable: boolean
HideDisable: boolean
CssClass: string
SyncRole: string
ConnectedTenant: string
CreatedDate: string
ConnectionStatusTypeId: string
LastDisabled: string
LastEnabled: string
Actions: string
Example
{
  "Id": "integer",
  "ConnectionId": "integer",
  "IsDeleted": "boolean",
  "SourceTenantKey": "string",
  "TargetTenantKey": "string",
  "SourceTenantName": "string",
  "TargetTenantName": "string",
  "IsActive": "boolean",
  "IsStaff": "boolean",
  "IsSource": "boolean",
  "HideDelete": "boolean",
  "HideView": "boolean",
  "HideEdit": "boolean",
  "HideEnable": "boolean",
  "HideDisable": "boolean",
  "CssClass": "string",
  "SyncRole": "string",
  "ConnectedTenant": "string",
  "CreatedDate": "string",
  "ConnectionStatusTypeId": "string",
  "LastDisabled": "string",
  "LastEnabled": "string",
  "Actions": "string"
}

TenantForConnectionItemModel: object

Id: string
SyncFromTenantKey: string
ExchangeId: integer
Name: string
ConectedTenantName: string
Example
{
  "Id": "string",
  "SyncFromTenantKey": "string",
  "ExchangeId": "integer",
  "Name": "string",
  "ConectedTenantName": "string"
}

MembershipTypeMappingDataModel: object

Id: integer
Name: string
OwnedByType: string
InheritanceType: string
Example
{
  "Id": "integer",
  "Name": "string",
  "OwnedByType": "string",
  "InheritanceType": "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"
}

ItemChoiceModel: object

IsSelected: boolean
PreviouslySelected: boolean
Id: integer
Name: string
Order: integer
Example
{
  "IsSelected": "boolean",
  "PreviouslySelected": "boolean",
  "Id": "integer",
  "Name": "string",
  "Order": "integer"
}

Boolean: object

Example
"object"
Documentation by Spectacle