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

Sponsorship

GET /api/sponsorships/adlocations

options: string
in query

(no description)

200 OK
ListViewReturnModel<AdLocationsCollectionModel>

OK

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

POST /api/sponsorships/adlocations

AdLocationsAdvanceFilter

undefined

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "Criteria": "string",
  "HasAdsAssigned": "boolean",
  "Type": "string",
  "DomainId": "string"
}
200 OK
ListViewReturnModel<AdLocationsCollectionModel>

OK

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

GET /api/sponsorships/adlocations/adtypeplacement/{siteid}/{sitepageid}/{positiontypeid}

siteid: integer
in path

(no description)

sitepageid: integer
in path

(no description)

positiontypeid: string
in path

(no description)

200 OK
AdLocationAdPlacementViewModel

OK

Response Example (200 OK) 
{
  "SiteId": "integer",
  "SitePageId": "integer",
  "PositionTypeId": "string",
  "AdvertisingTypeId": "string"
}
Sponsorship

POST /api/sponsorships/adlocations/adtypeplacement/save

AdLocationAdPlacementViewModel

undefined

Request Example
{
  "SiteId": "integer",
  "SitePageId": "integer",
  "PositionTypeId": "string",
  "AdvertisingTypeId": "string"
}
200 OK
AdLocationsCollectionModel

OK

Response Example (200 OK) 
{
  "SitePageId": "integer",
  "DomainId": "string",
  "SiteId": "integer",
  "Domain": "string",
  "Type": "string",
  "Title": "string",
  "RelativePath": "string",
  "TotalRecordAvailable": "integer",
  "TopOfPageAd": "string",
  "BottomOfPageAd": "string"
}
Sponsorship

GET /api/sponsorships/adlocations/allowedsitemodule/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"
  }
]
Sponsorship

GET /api/sponsorships/customadlocations

options: string
in query

(no description)

200 OK
CustomAdLocationItemModel

OK

type
CustomAdLocationItemModel
Response Example (200 OK) 
[
  {
    "CustomAdLocationId": "integer",
    "Name": "string",
    "Actions": "string"
  }
]
Sponsorship

GET /api/sponsorships/customadlocations/{customadlocationid}

customadlocationid: integer
in path

(no description)

200 OK
AddEditCustomAdLocationViewModel

OK

Response Example (200 OK) 
{
  "CustomAdLocationId": "integer",
  "Name": "string"
}
Sponsorship

DELETE /api/sponsorships/customadlocations/{customadlocationid}

customadlocationid: integer
in path

(no description)

200 OK

OK

Sponsorship

POST /api/sponsorships/customadlocations/save

AddEditCustomAdLocationViewModel

undefined

Request Example
{
  "CustomAdLocationId": "integer",
  "Name": "string"
}
200 OK
CustomAdLocationItemModel

OK

Response Example (200 OK) 
{
  "CustomAdLocationId": "integer",
  "Name": "string",
  "Actions": "string"
}
Sponsorship

GET /api/sponsorships/displayad/{adid}

adid: integer
in path

(no description)

200 OK
AddEditDisplayAdModel

OK

Response Example (200 OK) 
{
  "AdId": "integer",
  "AuditId": "integer",
  "ContactId": "string",
  "ContactName": "string",
  "Title": "string",
  "StartDate": "string",
  "EndDate": "string",
  "DestinationUrl": "string",
  "OpenInNewWindow": "boolean",
  "AdAreaId": "string",
  "Width": "integer",
  "Height": "integer",
  "BannerImage": "string",
  "Placements": "string"
}
Sponsorship

POST /api/sponsorships/displayad/save

AddEditDisplayAdModel

undefined

Request Example
{
  "AdId": "integer",
  "AuditId": "integer",
  "ContactId": "string",
  "ContactName": "string",
  "Title": "string",
  "StartDate": "string",
  "EndDate": "string",
  "DestinationUrl": "string",
  "OpenInNewWindow": "boolean",
  "AdAreaId": "string",
  "Width": "integer",
  "Height": "integer",
  "BannerImage": "string",
  "Placements": "string"
}
200 OK
DisplayAdsCollectionItemModel

OK

Response Example (200 OK) 
{
  "AdId": "integer",
  "Contact": "string",
  "Description": "string",
  "IsActive": "boolean",
  "EndDate": "string",
  "ActivePlacements": "integer",
  "TotalRecordAvailable": "integer",
  "TotalPlacements": "integer"
}
Sponsorship

GET /api/sponsorships/displayads

DisplayAdsAdvancedFilter

undefined

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "Active": "boolean",
  "ExpiredWithinTheLastTwoWeeks": "boolean",
  "AllExpired": "boolean",
  "Criteria": "string"
}
200 OK
ListViewReturnModel<DisplayAdsCollectionItemModel>

OK

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

GET /api/sponsorships/pages/sp-cp

200 OK
SitePagesAndCustomPages

OK

type
SitePagesAndCustomPages
Response Example (200 OK) 
[
  {
    "Id": "string",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer",
    "SiteModuleTypeId": "string"
  }
]
Sponsorship

GET /api/sponsorships/sponsors

options: string
in query

(no description)

200 OK
ListViewReturnModel<SponsorshipListItem>

OK

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

POST /api/sponsorships/sponsors

SponsorsAdvancedFilter

undefined

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

OK

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

GET /api/sponsorships/sponsors/{sponsorid}

sponsorid: integer
in path

(no description)

200 OK
SponsorAddEditModel

OK

Response Example (200 OK) 
{
  "SponsorId": "integer",
  "AuditId": "integer",
  "ContactId": "integer",
  "Contact": "string",
  "SponsorshipTypeId": "integer",
  "Price": "string",
  "StartDate": "string",
  "EndDate": "string"
}
Sponsorship

POST /api/sponsorships/sponsors/{sponsorid}

SponsorAddEditModel

undefined

sponsorid: integer
in path

(no description)

Request Example
{
  "SponsorId": "integer",
  "AuditId": "integer",
  "ContactId": "integer",
  "Contact": "string",
  "SponsorshipTypeId": "integer",
  "Price": "string",
  "StartDate": "string",
  "EndDate": "string"
}
200 OK
SponsorshipListItem

OK

Response Example (200 OK) 
{
  "SponsorId": "integer",
  "SponsorName": "string",
  "Level": "string",
  "StartDate": "string",
  "EndDate": "string",
  "Price": "number",
  "TotalRecordAvailable": "integer",
  "Actions": "string"
}
Sponsorship

DELETE /api/sponsorships/sponsors/{sponsorid}/{auditid}

sponsorid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

Sponsorship

GET /api/sponsorships/sponsors/banners/{sponsorid}

sponsorid: integer
in path

(no description)

200 OK
SponsorBannersModel

OK

Response Example (200 OK) 
{
  "SponsorId": "integer",
  "Banners": "string"
}
Sponsorship

GET /api/sponsorships/types

options: string
in query

(no description)

200 OK
SponsorshipTypeListItem

OK

type
SponsorshipTypeListItem
Response Example (200 OK) 
[
  {
    "SponsorshipTypeId": "integer",
    "SponsorshipLevel": "string",
    "BenefitPackage": "string",
    "Price": "number",
    "TotalQuantity": "integer",
    "CurrentlyActive": "boolean"
  }
]
Sponsorship

GET /api/sponsorships/types/{sponsorshiptypeid}

sponsorshiptypeid: integer
in path

(no description)

200 OK
SponsorshipTypeAddEditModel

OK

Response Example (200 OK) 
{
  "SponsorshipTypeId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "SponsorBenefitId": "string",
  "MaxQuantity": "integer",
  "LengthInMonths": "string",
  "SaleableItem": "string"
}
Sponsorship

POST /api/sponsorships/types/{sponsorshiptypeid}

SponsorshipTypeAddEditModel

undefined

sponsorshiptypeid: integer
in path

(no description)

Request Example
{
  "SponsorshipTypeId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "SponsorBenefitId": "string",
  "MaxQuantity": "integer",
  "LengthInMonths": "string",
  "SaleableItem": "string"
}
200 OK
SponsorshipTypeListItem

OK

Response Example (200 OK) 
{
  "SponsorshipTypeId": "integer",
  "SponsorshipLevel": "string",
  "BenefitPackage": "string",
  "Price": "number",
  "TotalQuantity": "integer",
  "CurrentlyActive": "boolean"
}
Sponsorship

DELETE /api/sponsorships/types/{sponsorshiptypeid}/{auditid}

sponsorshiptypeid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

Sponsorship

GET /api/sponsorships/types/lookup

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]

Schema Definitions

SponsorshipTypeListItem: object

SponsorshipTypeId: integer
SponsorshipLevel: string
BenefitPackage: string
Price: number
TotalQuantity: integer
CurrentlyActive: boolean
Example
{
  "SponsorshipTypeId": "integer",
  "SponsorshipLevel": "string",
  "BenefitPackage": "string",
  "Price": "number",
  "TotalQuantity": "integer",
  "CurrentlyActive": "boolean"
}

SponsorshipTypeAddEditModel: object

SponsorshipTypeId: integer
AuditId: integer
Name: string
Description: string
SponsorBenefitId: string
MaxQuantity: integer
LengthInMonths: string
SaleableItem: string
Example
{
  "SponsorshipTypeId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "SponsorBenefitId": "string",
  "MaxQuantity": "integer",
  "LengthInMonths": "string",
  "SaleableItem": "string"
}

Object: object

Example
"object"

IQueryable: object

Expression: string
ElementType: string
Provider: string
Example
{
  "Expression": "string",
  "ElementType": "string",
  "Provider": "string"
}

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

SponsorsAdvancedFilter: object

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

SponsorAddEditModel: object

SponsorId: integer
AuditId: integer
ContactId: integer
Contact: string
SponsorshipTypeId: integer
Price: string
StartDate: string
EndDate: string
Example
{
  "SponsorId": "integer",
  "AuditId": "integer",
  "ContactId": "integer",
  "Contact": "string",
  "SponsorshipTypeId": "integer",
  "Price": "string",
  "StartDate": "string",
  "EndDate": "string"
}

SponsorshipListItem: object

SponsorId: integer
SponsorName: string
Level: string
StartDate: string
EndDate: string
Price: number
TotalRecordAvailable: integer
Actions: string
Example
{
  "SponsorId": "integer",
  "SponsorName": "string",
  "Level": "string",
  "StartDate": "string",
  "EndDate": "string",
  "Price": "number",
  "TotalRecordAvailable": "integer",
  "Actions": "string"
}

SponsorBannersModel: object

SponsorId: integer
Banners: string
Example
{
  "SponsorId": "integer",
  "Banners": "string"
}

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

DisplayAdsAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
Active: boolean
ExpiredWithinTheLastTwoWeeks: boolean
AllExpired: boolean
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "Active": "boolean",
  "ExpiredWithinTheLastTwoWeeks": "boolean",
  "AllExpired": "boolean",
  "Criteria": "string"
}

AddEditDisplayAdModel: object

AdId: integer
AuditId: integer
ContactId: string
ContactName: string
Title: string
StartDate: string
EndDate: string
DestinationUrl: string
OpenInNewWindow: boolean
AdAreaId: string
Width: integer
Height: integer
BannerImage: string
Placements: string
Example
{
  "AdId": "integer",
  "AuditId": "integer",
  "ContactId": "string",
  "ContactName": "string",
  "Title": "string",
  "StartDate": "string",
  "EndDate": "string",
  "DestinationUrl": "string",
  "OpenInNewWindow": "boolean",
  "AdAreaId": "string",
  "Width": "integer",
  "Height": "integer",
  "BannerImage": "string",
  "Placements": "string"
}

DisplayAdsCollectionItemModel: object

AdId: integer
Contact: string
Description: string
IsActive: boolean
EndDate: string
ActivePlacements: integer
TotalRecordAvailable: integer
TotalPlacements: integer
Example
{
  "AdId": "integer",
  "Contact": "string",
  "Description": "string",
  "IsActive": "boolean",
  "EndDate": "string",
  "ActivePlacements": "integer",
  "TotalRecordAvailable": "integer",
  "TotalPlacements": "integer"
}

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

AdLocationsAdvanceFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
Criteria: string
HasAdsAssigned: boolean
Type: string
DomainId: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "Criteria": "string",
  "HasAdsAssigned": "boolean",
  "Type": "string",
  "DomainId": "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"
}

AdLocationAdPlacementViewModel: object

SiteId: integer
SitePageId: integer
PositionTypeId: string
AdvertisingTypeId: string
Example
{
  "SiteId": "integer",
  "SitePageId": "integer",
  "PositionTypeId": "string",
  "AdvertisingTypeId": "string"
}

AdLocationsCollectionModel: object

SitePageId: integer
DomainId: string
SiteId: integer
Domain: string
Type: string
Title: string
RelativePath: string
TotalRecordAvailable: integer
TopOfPageAd: string
BottomOfPageAd: string
Example
{
  "SitePageId": "integer",
  "DomainId": "string",
  "SiteId": "integer",
  "Domain": "string",
  "Type": "string",
  "Title": "string",
  "RelativePath": "string",
  "TotalRecordAvailable": "integer",
  "TopOfPageAd": "string",
  "BottomOfPageAd": "string"
}

SitePagesAndCustomPages: object

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

CustomAdLocationItemModel: object

CustomAdLocationId: integer
Name: string
Actions: string
Example
{
  "CustomAdLocationId": "integer",
  "Name": "string",
  "Actions": "string"
}

AddEditCustomAdLocationViewModel: object

CustomAdLocationId: integer
Name: string
Example
{
  "CustomAdLocationId": "integer",
  "Name": "string"
}

Boolean: object

Example
"object"
Documentation by Spectacle