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

Flatfile

GET /api/integration/flatfile/obtaintoken/{embedid}

embedid: string
in path

(no description)

200 OK
JsonWebTokenModel

OK

Response Example (200 OK) 
{
  "Token": "string"
}
Flatfile

POST /api/integration/flatfile/verify/accountnumberuniqueness/{contacttype}

String
contacttype: string
in path

(no description)

Request Example
[
  {
    "this[]": "string",
    "Length": "integer"
  }
]
200 OK
String

OK

type
String
Response Example (200 OK) 
[
  {
    "this[]": "string",
    "Length": "integer"
  }
]
Flatfile

POST /api/integration/flatfile/verify/businessbyaccountnumber

String
Request Example
[
  {
    "this[]": "string",
    "Length": "integer"
  }
]
200 OK
ContactValidationModel

OK

type
ContactValidationModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "MatchCriteria": "string",
    "MatchCount": "integer"
  }
]
Flatfile

GET /api/integration/flatfile/verify/categorylists

ids: string
in query

(no description)

200 OK
CategoryListValidationModel

OK

type
CategoryListValidationModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "Items": "string"
  }
]
Flatfile

POST /api/integration/flatfile/verify/contactsbyid

Int32
Request Example
[
  "object"
]
200 OK
ContactValidationModel

OK

type
ContactValidationModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "MatchCriteria": "string",
    "MatchCount": "integer"
  }
]
Flatfile

POST /api/integration/flatfile/verify/contactsbyname

String
Request Example
[
  {
    "this[]": "string",
    "Length": "integer"
  }
]
200 OK
ContactValidationModel

OK

type
ContactValidationModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "MatchCriteria": "string",
    "MatchCount": "integer"
  }
]
Flatfile

POST /api/integration/flatfile/verify/contactsbynameandinfo

ContactValidationCriteriaModel
Request Example
[
  {
    "Name": "string",
    "Info": "string"
  }
]
200 OK
ContactValidationModel

OK

type
ContactValidationModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "MatchCriteria": "string",
    "MatchCount": "integer"
  }
]
Flatfile

GET /api/integration/flatfile/verify/customfields

ids: string
in query

(no description)

200 OK
CustomFieldValidationModel

OK

type
CustomFieldValidationModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "ValidOptions": "string",
    "DataTypeId": "string"
  }
]
Flatfile

POST /api/integration/flatfile/verify/membershiplevelsbyid

Int32
Request Example
[
  "object"
]
200 OK
MembershipLevelValidationModel

OK

type
MembershipLevelValidationModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "MembershipTypeId": "integer",
    "MatchCount": "integer"
  }
]
Flatfile

POST /api/integration/flatfile/verify/membershiplevelsbyname

String
Request Example
[
  {
    "this[]": "string",
    "Length": "integer"
  }
]
200 OK
MembershipLevelValidationModel

OK

type
MembershipLevelValidationModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "MembershipTypeId": "integer",
    "MatchCount": "integer"
  }
]
Flatfile

POST /api/integration/flatfile/verify/membershiptypesbyid

Int32
Request Example
[
  "object"
]
200 OK
MembershipTypeValidationModel

OK

type
MembershipTypeValidationModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "MatchCount": "integer"
  }
]
Flatfile

POST /api/integration/flatfile/verify/membershiptypesbyname

String
Request Example
[
  {
    "this[]": "string",
    "Length": "integer"
  }
]
200 OK
MembershipTypeValidationModel

OK

type
MembershipTypeValidationModel
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "MatchCount": "integer"
  }
]

Schema Definitions

JsonWebTokenModel: object

Token: string
Example
{
  "Token": "string"
}

CustomFieldValidationModel: object

Id: integer
Name: string
ValidOptions: string
DataTypeId: string
Example
{
  "Id": "integer",
  "Name": "string",
  "ValidOptions": "string",
  "DataTypeId": "string"
}

CategoryListValidationModel: object

Id: integer
Name: string
Items: string
Example
{
  "Id": "integer",
  "Name": "string",
  "Items": "string"
}

ContactValidationModel: object

Id: integer
Name: string
MatchCriteria: string
MatchCount: integer
Example
{
  "Id": "integer",
  "Name": "string",
  "MatchCriteria": "string",
  "MatchCount": "integer"
}

Int32: object

Example
"object"

String: object

this[]: string
Length: integer
Example
{
  "this[]": "string",
  "Length": "integer"
}

MembershipTypeValidationModel: object

Id: integer
Name: string
MatchCount: integer
Example
{
  "Id": "integer",
  "Name": "string",
  "MatchCount": "integer"
}

MembershipLevelValidationModel: object

Id: integer
Name: string
MembershipTypeId: integer
MatchCount: integer
Example
{
  "Id": "integer",
  "Name": "string",
  "MembershipTypeId": "integer",
  "MatchCount": "integer"
}

ContactValidationCriteriaModel: object

Name: string
Info: string
Example
{
  "Name": "string",
  "Info": "string"
}
Documentation by Spectacle