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

BenefitAssignment

GET /api/benefitassignments

BenefitAssignmentsAdvancedFilter

undefined

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "HasBenefits": "boolean",
  "DoesNotHaveBenefits": "boolean",
  "HasRemainingBenefits": "boolean",
  "HasUsedBenefits": "boolean",
  "ContactBenefitStatusId": "string",
  "BenefitItemId": "string",
  "BenefitType": "string",
  "CategoryId": "string",
  "StatusTypeOptions": "string",
  "MembershipTypeId": "string",
  "UsageRangeQuickOptions": "string",
  "UsedDateRange": "string",
  "Criteria": "string"
}
200 OK
ListViewReturnModel<BenefitAssignmentItemModel>

OK

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

Return BenefitItems

GET /api/benefitassignments/lookup/benefititems

Return BenefitItems

200 OK
ItemChoiceModel

OK

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

POST /api/benefitassignments/massassignbenefitpackages

MassAssignBenefitPackagesModel

undefined

Request Example
{
  "SelectedIds": "string",
  "MembershipTypeId": "string",
  "BenefitPackageItems": "string",
  "ForceSave": "boolean"
}
200 OK
MassAssignBenefitPackagesModel

OK

Response Example (200 OK) 
{
  "SelectedIds": "string",
  "MembershipTypeId": "string",
  "BenefitPackageItems": "string",
  "ForceSave": "boolean"
}
BenefitAssignment

POST /api/benefitassignments/massassignbenefitpackages/save

MassAssignBenefitPackagesModel

undefined

Request Example
{
  "SelectedIds": "string",
  "MembershipTypeId": "string",
  "BenefitPackageItems": "string",
  "ForceSave": "boolean"
}
200 OK

OK

Schema Definitions

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

BenefitAssignmentsAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
HasBenefits: boolean
DoesNotHaveBenefits: boolean
HasRemainingBenefits: boolean
HasUsedBenefits: boolean
ContactBenefitStatusId: string
BenefitItemId: string
BenefitType: string
CategoryId: string
StatusTypeOptions: string
MembershipTypeId: string
UsageRangeQuickOptions: string
UsedDateRange: string
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "HasBenefits": "boolean",
  "DoesNotHaveBenefits": "boolean",
  "HasRemainingBenefits": "boolean",
  "HasUsedBenefits": "boolean",
  "ContactBenefitStatusId": "string",
  "BenefitItemId": "string",
  "BenefitType": "string",
  "CategoryId": "string",
  "StatusTypeOptions": "string",
  "MembershipTypeId": "string",
  "UsageRangeQuickOptions": "string",
  "UsedDateRange": "string",
  "Criteria": "string"
}

ItemChoiceModel: object

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

MassAssignBenefitPackagesModel: object

SelectedIds: string
MembershipTypeId: string
BenefitPackageItems: string
ForceSave: boolean
Example
{
  "SelectedIds": "string",
  "MembershipTypeId": "string",
  "BenefitPackageItems": "string",
  "ForceSave": "boolean"
}
Documentation by Spectacle