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

Exchange

DELETE /api/exchange/{exchangeid}

exchangeid: integer
in path

(no description)

200 OK

OK

Exchange

GET /api/exchange/{exchangeid}

exchangeid: integer
in path

(no description)

200 OK
ExchangeAddEditModel

OK

Response Example (200 OK) 
{
  "ExchangeId": "integer",
  "ExchangeName": "string",
  "TargetTenants": "string",
  "SourceTenants": "string",
  "ForceSave": "boolean"
}
Exchange

POST /api/exchange/{exchangeid}

ExchangeAddEditModel

undefined

exchangeid: string
in path

(no description)

Request Example
{
  "ExchangeId": "integer",
  "ExchangeName": "string",
  "TargetTenants": "string",
  "SourceTenants": "string",
  "ForceSave": "boolean"
}
200 OK
ExchangeCollectionItemModel

OK

Response Example (200 OK) 
{
  "Id": "integer",
  "ExchangeId": "integer",
  "ExchangeName": "string",
  "SourceTenants": "string",
  "TargetTenants": "string",
  "TargetTenantsList": "string",
  "SourceTenantsList": "string",
  "DeleteConfirm": "string",
  "Actions": "string"
}
Exchange

GET /api/exchange/all

options: string
in query

(no description)

200 OK
ExchangeCollectionItemModel

OK

type
ExchangeCollectionItemModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "ExchangeId": "integer",
    "ExchangeName": "string",
    "SourceTenants": "string",
    "TargetTenants": "string",
    "TargetTenantsList": "string",
    "SourceTenantsList": "string",
    "DeleteConfirm": "string",
    "Actions": "string"
  }
]
Exchange

POST /api/exchange/all

ExchangeListViewItemAdvancedFilter

undefined

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

OK

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

GET /api/exchange/sourcetenants/lookup/{search}

search: string
in path

(no description)

200 OK
TenantsForSyncItemModel

OK

type
TenantsForSyncItemModel
Response Example (200 OK) 
[
  {
    "TenantKey": "string",
    "HubTenantKey": "string",
    "TenantName": "string",
    "Name": "string"
  }
]
Exchange

GET /api/exchange/targettenants/lookup/{search}

search: string
in path

(no description)

200 OK
TenantsForSyncItemModel

OK

type
TenantsForSyncItemModel
Response Example (200 OK) 
[
  {
    "TenantKey": "string",
    "HubTenantKey": "string",
    "TenantName": "string",
    "Name": "string"
  }
]

Schema Definitions

ExchangeCollectionItemModel: object

Id: integer
ExchangeId: integer
ExchangeName: string
SourceTenants: string
TargetTenants: string
TargetTenantsList: string
SourceTenantsList: string
DeleteConfirm: string
Actions: string
Example
{
  "Id": "integer",
  "ExchangeId": "integer",
  "ExchangeName": "string",
  "SourceTenants": "string",
  "TargetTenants": "string",
  "TargetTenantsList": "string",
  "SourceTenantsList": "string",
  "DeleteConfirm": "string",
  "Actions": "string"
}

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

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

Boolean: object

Example
"object"

ExchangeAddEditModel: object

ExchangeId: integer
ExchangeName: string
TargetTenants: string
SourceTenants: string
ForceSave: boolean
Example
{
  "ExchangeId": "integer",
  "ExchangeName": "string",
  "TargetTenants": "string",
  "SourceTenants": "string",
  "ForceSave": "boolean"
}

TenantsForSyncItemModel: object

TenantKey: string
HubTenantKey: string
TenantName: string
Name: string
Example
{
  "TenantKey": "string",
  "HubTenantKey": "string",
  "TenantName": "string",
  "Name": "string"
}
Documentation by Spectacle