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

ScheduledBilling

POST /api/scheduledbilling/membershiptype/items

ScheduledBillingUpdateMembershipTypeItemsAdvancedFilter

undefined

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "MembershipTypeIds": "string",
  "SaleableItemId": "string",
  "SaleableItemType": "string",
  "StatusTypeOptions": "string",
  "AmountBetween": "string",
  "DateRange": "string",
  "NextBillDate": "string",
  "DescriptionEquals": "string",
  "DescriptionLike": "string",
  "MembershipTypeId": "string",
  "MembershipLevelId": "string",
  "GroupId": "string",
  "CategoryItemId": "string",
  "EventId": "string",
  "Tags": "string",
  "HasProfile": "boolean",
  "HasNoProfile": "boolean",
  "HasNoMembership": "boolean",
  "Criteria": "string"
}
200 OK
ListViewReturnModel<ScheduledBillingUpdateMembershipTypeItems>

OK

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

POST /api/scheduledbilling/membershiptype/items/export

ScheduledBillingUpdateMembershipTypeItemsAdvancedFilter

undefined

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "MembershipTypeIds": "string",
  "SaleableItemId": "string",
  "SaleableItemType": "string",
  "StatusTypeOptions": "string",
  "AmountBetween": "string",
  "DateRange": "string",
  "NextBillDate": "string",
  "DescriptionEquals": "string",
  "DescriptionLike": "string",
  "MembershipTypeId": "string",
  "MembershipLevelId": "string",
  "GroupId": "string",
  "CategoryItemId": "string",
  "EventId": "string",
  "Tags": "string",
  "HasProfile": "boolean",
  "HasNoProfile": "boolean",
  "HasNoMembership": "boolean",
  "Criteria": "string"
}
200 OK
HttpResponseMessage

OK

Response Example (200 OK) 
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}
ScheduledBilling

POST /api/scheduledbilling/membershiptype/items/run

ScheduledBillingUpdateMembershipTypeItemsModal

undefined

Request Example
{
  "CurrentAdvancedFilter": "string",
  "MembershipTypeId": "integer",
  "MembershipLevelId": "string",
  "ChangeCurrentMembership": "boolean",
  "CreateMembership": "boolean",
  "RemoveMembership": "boolean",
  "RecordCount": "integer",
  "ScheduledBillings": "string"
}
200 OK

OK

ScheduledBilling

POST /api/scheduledbilling/membershiptype/items/run/setup

ScheduledBillingUpdateMembershipTypeItemsModal

undefined

Request Example
{
  "CurrentAdvancedFilter": "string",
  "MembershipTypeId": "integer",
  "MembershipLevelId": "string",
  "ChangeCurrentMembership": "boolean",
  "CreateMembership": "boolean",
  "RemoveMembership": "boolean",
  "RecordCount": "integer",
  "ScheduledBillings": "string"
}
200 OK
ScheduledBillingUpdateMembershipTypeItemsModal

OK

Response Example (200 OK) 
{
  "CurrentAdvancedFilter": "string",
  "MembershipTypeId": "integer",
  "MembershipLevelId": "string",
  "ChangeCurrentMembership": "boolean",
  "CreateMembership": "boolean",
  "RemoveMembership": "boolean",
  "RecordCount": "integer",
  "ScheduledBillings": "string"
}
ScheduledBilling

GET /api/scheduledbilling/membershiptype/run/history

200 OK
ScheduledBillingUpdateMembershipTypeHistoryModel

OK

Response Example (200 OK) 
{
  "HistoryItems": "string"
}
ScheduledBilling

POST /api/scheduledbilling/membershiptype/run/history/download/{systemjobid}

systemjobid: integer
in path

(no description)

200 OK
PendingFileDownloadResult

OK

Response Example (200 OK) 
{
  "JobType": "string",
  "Message": "string",
  "Result": "string",
  "BackgroundJobEstimatedSeconds": "integer",
  "JobId": "string",
  "PendingDownloadFileId": "integer"
}

Schema Definitions

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

ScheduledBillingUpdateMembershipTypeItemsAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
MembershipTypeIds: string
SaleableItemId: string
SaleableItemType: string
StatusTypeOptions: string
AmountBetween: string
DateRange: string
NextBillDate: string
DescriptionEquals: string
DescriptionLike: string
MembershipTypeId: string
MembershipLevelId: string
GroupId: string
CategoryItemId: string
EventId: string
Tags: string
HasProfile: boolean
HasNoProfile: boolean
HasNoMembership: boolean
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "MembershipTypeIds": "string",
  "SaleableItemId": "string",
  "SaleableItemType": "string",
  "StatusTypeOptions": "string",
  "AmountBetween": "string",
  "DateRange": "string",
  "NextBillDate": "string",
  "DescriptionEquals": "string",
  "DescriptionLike": "string",
  "MembershipTypeId": "string",
  "MembershipLevelId": "string",
  "GroupId": "string",
  "CategoryItemId": "string",
  "EventId": "string",
  "Tags": "string",
  "HasProfile": "boolean",
  "HasNoProfile": "boolean",
  "HasNoMembership": "boolean",
  "Criteria": "string"
}

HttpResponseMessage: object

Version: string
Content: string
StatusCode: string
ReasonPhrase: string
Headers: string
RequestMessage: string
IsSuccessStatusCode: boolean
Example
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

ScheduledBillingUpdateMembershipTypeItemsModal: object

CurrentAdvancedFilter: string
MembershipTypeId: integer
MembershipLevelId: string
ChangeCurrentMembership: boolean
CreateMembership: boolean
RemoveMembership: boolean
RecordCount: integer
ScheduledBillings: string
Example
{
  "CurrentAdvancedFilter": "string",
  "MembershipTypeId": "integer",
  "MembershipLevelId": "string",
  "ChangeCurrentMembership": "boolean",
  "CreateMembership": "boolean",
  "RemoveMembership": "boolean",
  "RecordCount": "integer",
  "ScheduledBillings": "string"
}

ScheduledBillingUpdateMembershipTypeHistoryModel: object

HistoryItems: string
Example
{
  "HistoryItems": "string"
}

PendingFileDownloadResult: object

JobType: string
Message: string
Result: string
BackgroundJobEstimatedSeconds: integer
JobId: string
PendingDownloadFileId: integer
Example
{
  "JobType": "string",
  "Message": "string",
  "Result": "string",
  "BackgroundJobEstimatedSeconds": "integer",
  "JobId": "string",
  "PendingDownloadFileId": "integer"
}
Documentation by Spectacle