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

BenefitLedger

GET /api/benefitledger/contact/{contactid}/{benefititemid}/entries

contactid: integer
in path

(no description)

benefititemid: integer
in path

(no description)

200 OK
BenefitLedgerTransactionsViewModel

OK

Response Example (200 OK) 
{
  "ContactId": "integer",
  "BenefitItemId": "integer",
  "BenefitName": "string",
  "Transactions": "string"
}
BenefitLedger

GET /api/benefitledger/contact/{contactid}/adjustment

contactid: integer
in path

(no description)

200 OK
AdjustContactBenefitsModel

OK

Response Example (200 OK) 
{
  "ContactId": "integer",
  "ContactName": "string",
  "ActiveMembershipCount": "integer",
  "MembershipId": "integer",
  "BenefitItems": "string",
  "AdjustmentDescription": "string",
  "ForceSave": "boolean"
}
BenefitLedger

POST /api/benefitledger/contact/adjustment

AdjustContactBenefitsModel

undefined

Request Example
{
  "ContactId": "integer",
  "ContactName": "string",
  "ActiveMembershipCount": "integer",
  "MembershipId": "integer",
  "BenefitItems": "string",
  "AdjustmentDescription": "string",
  "ForceSave": "boolean"
}
200 OK

OK

BenefitLedger

Get list of Transaction Types for populating dropdown.

GET /api/benefitledger/lookup/transactiontypes/{defaulttransactiontype}

Used for dynamically populating dropdown based on up to date Transaction Types.

defaulttransactiontype: string
in path

Value to be selected by default

200 OK
ItemChoiceModel

OK

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

POST /api/benefitledger/manualusage

ManualBenefitUsageModel

undefined

Request Example
{
  "BenefitItemId": "integer",
  "ContactId": "integer",
  "Name": "string",
  "UsageDate": "string",
  "UsageQuantity": "integer",
  "Description": "string"
}
200 OK
BenefitSummaryItem

OK

Response Example (200 OK) 
{
  "Actions": "string",
  "States": "string",
  "BenefitItemId": "integer",
  "Name": "string",
  "Used": "integer",
  "Remaining": "integer"
}
BenefitLedger

POST /api/benefitledger/mass/load/adjustment

MassAdjustContactBenefitsModel

undefined

Request Example
{
  "SelectedIds": "string",
  "ForceSave": "boolean",
  "BenefitItemId": "string",
  "AdjustmentQuantity": "integer",
  "AdjustmentDirection": "string",
  "AdjustmentDescription": "string"
}
200 OK
MassAdjustContactBenefitsModel

OK

Response Example (200 OK) 
{
  "SelectedIds": "string",
  "ForceSave": "boolean",
  "BenefitItemId": "string",
  "AdjustmentQuantity": "integer",
  "AdjustmentDirection": "string",
  "AdjustmentDescription": "string"
}
BenefitLedger

POST /api/benefitledger/mass/load/recordusage

MassBenefitUsageModel

undefined

Request Example
{
  "SelectedIds": "string",
  "BenefitItemId": "integer",
  "UsageQuantity": "integer",
  "Description": "string",
  "ForceSave": "boolean"
}
200 OK
MassBenefitUsageModel

OK

Response Example (200 OK) 
{
  "SelectedIds": "string",
  "BenefitItemId": "integer",
  "UsageQuantity": "integer",
  "Description": "string",
  "ForceSave": "boolean"
}
BenefitLedger

POST /api/benefitledger/mass/save/adjustment

MassAdjustContactBenefitsModel

undefined

Request Example
{
  "SelectedIds": "string",
  "ForceSave": "boolean",
  "BenefitItemId": "string",
  "AdjustmentQuantity": "integer",
  "AdjustmentDirection": "string",
  "AdjustmentDescription": "string"
}
200 OK

OK

BenefitLedger

POST /api/benefitledger/mass/save/recordusage

MassBenefitUsageModel

undefined

Request Example
{
  "SelectedIds": "string",
  "BenefitItemId": "integer",
  "UsageQuantity": "integer",
  "Description": "string",
  "ForceSave": "boolean"
}
200 OK

OK

Schema Definitions

BenefitSummaryItem: object

Actions: string
States: string
BenefitItemId: integer
Name: string
Used: integer
Remaining: integer
Example
{
  "Actions": "string",
  "States": "string",
  "BenefitItemId": "integer",
  "Name": "string",
  "Used": "integer",
  "Remaining": "integer"
}

ManualBenefitUsageModel: object

BenefitItemId: integer
ContactId: integer
Name: string
UsageDate: string
UsageQuantity: integer
Description: string
Example
{
  "BenefitItemId": "integer",
  "ContactId": "integer",
  "Name": "string",
  "UsageDate": "string",
  "UsageQuantity": "integer",
  "Description": "string"
}

AdjustContactBenefitsModel: object

ContactId: integer
ContactName: string
ActiveMembershipCount: integer
MembershipId: integer
BenefitItems: string
AdjustmentDescription: string
ForceSave: boolean
Example
{
  "ContactId": "integer",
  "ContactName": "string",
  "ActiveMembershipCount": "integer",
  "MembershipId": "integer",
  "BenefitItems": "string",
  "AdjustmentDescription": "string",
  "ForceSave": "boolean"
}

MassAdjustContactBenefitsModel: object

SelectedIds: string
ForceSave: boolean
BenefitItemId: string
AdjustmentQuantity: integer
AdjustmentDirection: string
AdjustmentDescription: string
Example
{
  "SelectedIds": "string",
  "ForceSave": "boolean",
  "BenefitItemId": "string",
  "AdjustmentQuantity": "integer",
  "AdjustmentDirection": "string",
  "AdjustmentDescription": "string"
}

BenefitLedgerTransactionsViewModel: object

ContactId: integer
BenefitItemId: integer
BenefitName: string
Transactions: string
Example
{
  "ContactId": "integer",
  "BenefitItemId": "integer",
  "BenefitName": "string",
  "Transactions": "string"
}

MassBenefitUsageModel: object

SelectedIds: string
BenefitItemId: integer
UsageQuantity: integer
Description: string
ForceSave: boolean
Example
{
  "SelectedIds": "string",
  "BenefitItemId": "integer",
  "UsageQuantity": "integer",
  "Description": "string",
  "ForceSave": "boolean"
}

ItemChoiceModel: object

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