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

BenefitPackage

GET /api/benefitpackages

options: string
in query

(no description)

200 OK
BenefitPackageCollectionItemModel

OK

type
BenefitPackageCollectionItemModel
Response Example (200 OK) 
[
  {
    "BenefitPackageId": "integer",
    "Id": "integer",
    "Name": "string",
    "Description": "string",
    "ActivePeriodStart": "string",
    "ActivePeriodEnd": "string",
    "Assignments": "integer",
    "Actions": "string"
  }
]
BenefitPackage

GET /api/benefitpackages/{benefitpackageid}

benefitpackageid: integer
in path

(no description)

200 OK
BenefitPackageAddEditModel

OK

Response Example (200 OK) 
{
  "BenefitPackageId": "integer",
  "Name": "string",
  "Description": "string",
  "ActiveDates": "string",
  "BenefitItems": "string",
  "ForceSave": "boolean"
}
BenefitPackage

POST /api/benefitpackages/{benefitpackageid}

BenefitPackageAddEditModel

undefined

benefitpackageid: integer
in path

(no description)

Request Example
{
  "BenefitPackageId": "integer",
  "Name": "string",
  "Description": "string",
  "ActiveDates": "string",
  "BenefitItems": "string",
  "ForceSave": "boolean"
}
200 OK
BenefitPackageCollectionItemModel

OK

Response Example (200 OK) 
{
  "BenefitPackageId": "integer",
  "Id": "integer",
  "Name": "string",
  "Description": "string",
  "ActivePeriodStart": "string",
  "ActivePeriodEnd": "string",
  "Assignments": "integer",
  "Actions": "string"
}
BenefitPackage

DELETE /api/benefitpackages/{benefitpackageid}

benefitpackageid: integer
in path

(no description)

200 OK

OK

BenefitPackage

GET /api/benefitpackages/{benefitpackageid}/assignmentlist

benefitpackageid: integer
in path

(no description)

200 OK
BenefitPackageAssignmentModel

OK

Response Example (200 OK) 
{
  "BenefitPackageId": "integer",
  "AssignmentItem": "string"
}
BenefitPackage

GET /api/benefitpackages/copy/{benefitpackageid}

benefitpackageid: integer
in path

(no description)

200 OK
BenefitPackageCopyModel

OK

Response Example (200 OK) 
{
  "BenefitPackageId": "integer",
  "Name": "string",
  "Description": "string",
  "ActiveDates": "string",
  "BenefitItems": "string",
  "ForceSave": "boolean",
  "InactiveBenefitItems": "string"
}
BenefitPackage

POST /api/benefitpackages/copy/{benefitpackageid}

BenefitPackageCopyModel

undefined

benefitpackageid: integer
in path

(no description)

Request Example
{
  "BenefitPackageId": "integer",
  "Name": "string",
  "Description": "string",
  "ActiveDates": "string",
  "BenefitItems": "string",
  "ForceSave": "boolean",
  "InactiveBenefitItems": "string"
}
200 OK
BenefitPackageCollectionItemModel

OK

Response Example (200 OK) 
{
  "BenefitPackageId": "integer",
  "Id": "integer",
  "Name": "string",
  "Description": "string",
  "ActivePeriodStart": "string",
  "ActivePeriodEnd": "string",
  "Assignments": "integer",
  "Actions": "string"
}

Schema Definitions

BenefitPackageCollectionItemModel: object

BenefitPackageId: integer
Id: integer
Name: string
Description: string
ActivePeriodStart: string
ActivePeriodEnd: string
Assignments: integer
Actions: string
Example
{
  "BenefitPackageId": "integer",
  "Id": "integer",
  "Name": "string",
  "Description": "string",
  "ActivePeriodStart": "string",
  "ActivePeriodEnd": "string",
  "Assignments": "integer",
  "Actions": "string"
}

BenefitPackageAddEditModel: object

BenefitPackageId: integer
Name: string
Description: string
ActiveDates: string
BenefitItems: string
ForceSave: boolean
Example
{
  "BenefitPackageId": "integer",
  "Name": "string",
  "Description": "string",
  "ActiveDates": "string",
  "BenefitItems": "string",
  "ForceSave": "boolean"
}

Object: object

Example
"object"

BenefitPackageCopyModel: object

BenefitPackageId: integer
Name: string
Description: string
ActiveDates: string
BenefitItems: string
ForceSave: boolean
InactiveBenefitItems: string
Example
{
  "BenefitPackageId": "integer",
  "Name": "string",
  "Description": "string",
  "ActiveDates": "string",
  "BenefitItems": "string",
  "ForceSave": "boolean",
  "InactiveBenefitItems": "string"
}

BenefitPackageAssignmentModel: object

BenefitPackageId: integer
AssignmentItem: string
Example
{
  "BenefitPackageId": "integer",
  "AssignmentItem": "string"
}
Documentation by Spectacle