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

ContactRelationshipTypes

GET /api/contactrelationshiptypes

options: string
in query

(no description)

200 OK
ContactRelationshipTypeCollectionItemModel

OK

type
ContactRelationshipTypeCollectionItemModel
Response Example (200 OK) 
[
  {
    "ContactRelationshipTypeId": "integer",
    "AuditId": "integer",
    "SystemRelationshipTypeId": "string",
    "SystemRelationshipType": "string",
    "Name": "string",
    "Description": "string"
  }
]
ContactRelationshipTypes

GET /api/contactrelationshiptypes/{contactrelationshiptypeid}

contactrelationshiptypeid: integer
in path

(no description)

200 OK
ContactRelationshipTypeAddEditModel

OK

Response Example (200 OK) 
{
  "Instruction": "string",
  "ContactRelationshipTypeId": "integer",
  "AuditId": "integer",
  "SystemRelationshipTypeId": "string",
  "Name": "string",
  "Description": "string",
  "Id": "integer"
}
ContactRelationshipTypes

POST /api/contactrelationshiptypes/{contactrelationshiptypeid}

ContactRelationshipTypeAddEditModel

undefined

contactrelationshiptypeid: integer
in path

(no description)

Request Example
{
  "Instruction": "string",
  "ContactRelationshipTypeId": "integer",
  "AuditId": "integer",
  "SystemRelationshipTypeId": "string",
  "Name": "string",
  "Description": "string",
  "Id": "integer"
}
200 OK
ContactRelationshipTypeCollectionItemModel

OK

Response Example (200 OK) 
{
  "ContactRelationshipTypeId": "integer",
  "AuditId": "integer",
  "SystemRelationshipTypeId": "string",
  "SystemRelationshipType": "string",
  "Name": "string",
  "Description": "string"
}
ContactRelationshipTypes

DELETE /api/contactrelationshiptypes/{contactrelationshiptypeid}/{auditid}

contactrelationshiptypeid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

ContactRelationshipTypes

GET /api/contactrelationshiptypes/lookup/individual

200 OK
GenericLookUpChoice<Int32>

OK

type
GenericLookUpChoice<Int32>
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]
ContactRelationshipTypes

GET /api/contactrelationshiptypes/lookup/organization

200 OK
GenericLookUpChoice<Int32>

OK

type
GenericLookUpChoice<Int32>
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]
ContactRelationshipTypes

GET /api/contactrelationshiptypes/lookup/staff

200 OK
GenericLookUpChoice<Int32>

OK

type
GenericLookUpChoice<Int32>
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

Schema Definitions

ContactRelationshipTypeCollectionItemModel: object

ContactRelationshipTypeId: integer
AuditId: integer
SystemRelationshipTypeId: string
SystemRelationshipType: string
Name: string
Description: string
Example
{
  "ContactRelationshipTypeId": "integer",
  "AuditId": "integer",
  "SystemRelationshipTypeId": "string",
  "SystemRelationshipType": "string",
  "Name": "string",
  "Description": "string"
}

ContactRelationshipTypeAddEditModel: object

Instruction: string
ContactRelationshipTypeId: integer
AuditId: integer
SystemRelationshipTypeId: string
Name: string
Description: string
Id: integer
Example
{
  "Instruction": "string",
  "ContactRelationshipTypeId": "integer",
  "AuditId": "integer",
  "SystemRelationshipTypeId": "string",
  "Name": "string",
  "Description": "string",
  "Id": "integer"
}

Object: object

Example
"object"

GenericLookUpChoice<Int32>: object

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