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

LandingPages

GET /api/landingpages

options: string

in query

(no description)

200 OK

ListViewReturnModel<LandingPageCollectionItemModel>

Response Example (200 OK)

{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

LandingPages

POST /api/landingpages

LandingPageCollectionItemModelFilter

undefined

Request Example

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

200 OK

ListViewReturnModel<LandingPageCollectionItemModel>

Response Example (200 OK)

{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

LandingPages

GET /api/landingpages/getlandingpage/{landingpageid}

landingpageid: string

in path

(no description)

200 OK

AddEditLandingPageDialog

Response Example (200 OK)

{
  "LandingPageId": "integer",
  "Title": "string",
  "SiteId": "string",
  "RelativePath": "string",
  "EntireUrl": "string",
  "IsActive": "boolean",
  "PrimaryDomain": "string",
  "FormActionVerbiage": "string",
  "LandingPageFormAction": "string",
  "Page": "string"
}

LandingPages

POST /api/landingpages/landingpage/{landingpageid}

AddEditLandingPageDialog

undefined

landingpageid: string

in path

(no description)

Request Example

{
  "LandingPageId": "integer",
  "Title": "string",
  "SiteId": "string",
  "RelativePath": "string",
  "EntireUrl": "string",
  "IsActive": "boolean",
  "PrimaryDomain": "string",
  "FormActionVerbiage": "string",
  "LandingPageFormAction": "string",
  "Page": "string"
}

200 OK

LandingPageCollectionItemModel

Response Example (200 OK)

{
  "LandingPageId": "integer",
  "SiteId": "integer",
  "Name": "string",
  "Title": "string",
  "IsActive": "boolean",
  "FormId": "string",
  "Form": "string",
  "FormQuestions": "string",
  "ResponseCount": "integer",
  "LandingPageResponseCount": "integer",
  "Path": "string",
  "RelativePath": "string",
  "Visits": "integer",
  "TotalRecordAvailable": "integer",
  "Actions": "string"
}

LandingPages

DELETE /api/landingpages/landingpage/{landingpageid}

landingpageid: integer

in path

(no description)

200 OK

LandingPages

GET /api/landingpages/landingpage/{landingpageid}/copy

landingpageid: integer

in path

(no description)

200 OK

LandingPages

GET /api/landingpages/landingpage/{landingpageid}/responses

landingpageid: integer

in path

(no description)

200 OK

LandingPageResponseItems

type

LandingPageResponseItems

Response Example (200 OK)

[
  {
    "TenantId": "integer",
    "LandingPageId": "integer",
    "ResponseId": "string",
    "Name": "string",
    "Email": "string",
    "Company": "string",
    "DateTime": "string",
    "IPAddress": "string",
    "Source": "string",
    "Referrer": "string"
  }
]

LandingPages

GET /api/landingpages/landingpage/response/{responseid}

responseid: string

in path

(no description)

200 OK

LandingPageResponseValuesModel

Response Example (200 OK)

{
  "ResponseId": "string",
  "Items": "string"
}

LandingPages

GET /api/landingpages/landingpagechoices

200 OK

LandingPageChoiceViewModel

type

LandingPageChoiceViewModel

Response Example (200 OK)

[
  {
    "Id": "integer",
    "Name": "string",
    "LandingPageName": "string"
  }
]

Schema Definitions

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

LandingPageCollectionItemModelFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
Criteria: string

Example

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

AddEditLandingPageDialog: object

LandingPageId: integer
Title: string
SiteId: string
RelativePath: string
EntireUrl: string
IsActive: boolean
PrimaryDomain: string
FormActionVerbiage: string
LandingPageFormAction: string
Page: string

Example

{
  "LandingPageId": "integer",
  "Title": "string",
  "SiteId": "string",
  "RelativePath": "string",
  "EntireUrl": "string",
  "IsActive": "boolean",
  "PrimaryDomain": "string",
  "FormActionVerbiage": "string",
  "LandingPageFormAction": "string",
  "Page": "string"
}

LandingPageCollectionItemModel: object

LandingPageId: integer
SiteId: integer
Name: string
Title: string
IsActive: boolean
FormId: string
Form: string
FormQuestions: string
ResponseCount: integer
LandingPageResponseCount: integer
Path: string
RelativePath: string
Visits: integer
TotalRecordAvailable: integer
Actions: string

Example

{
  "LandingPageId": "integer",
  "SiteId": "integer",
  "Name": "string",
  "Title": "string",
  "IsActive": "boolean",
  "FormId": "string",
  "Form": "string",
  "FormQuestions": "string",
  "ResponseCount": "integer",
  "LandingPageResponseCount": "integer",
  "Path": "string",
  "RelativePath": "string",
  "Visits": "integer",
  "TotalRecordAvailable": "integer",
  "Actions": "string"
}

LandingPageChoiceViewModel: object

Id: integer
Name: string
LandingPageName: string

Example

{
  "Id": "integer",
  "Name": "string",
  "LandingPageName": "string"
}

Boolean: object

Example

"object"

LandingPageResponseItems: object

TenantId: integer
LandingPageId: integer
ResponseId: string
Name: string
Email: string
Company: string
DateTime: string
IPAddress: string
Source: string
Referrer: string

Example

{
  "TenantId": "integer",
  "LandingPageId": "integer",
  "ResponseId": "string",
  "Name": "string",
  "Email": "string",
  "Company": "string",
  "DateTime": "string",
  "IPAddress": "string",
  "Source": "string",
  "Referrer": "string"
}

LandingPageResponseValuesModel: object

ResponseId: string
Items: string

Example

{
  "ResponseId": "string",
  "Items": "string"
}

Documentation by Spectacle