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

DocumentGenerationTemplate

GET /api/documentgenerationtemplates

200 OK
DocumentGenerationTemplates

OK

Response Example (200 OK) 
{
  "Instruction": "string",
  "Items": "string"
}
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/{documentgenerationtemplateid}

documentgenerationtemplateid: integer
in path

(no description)

200 OK
DocumentGenerationTemplateAddEditModel

OK

Response Example (200 OK) 
{
  "DocumentGenerationTemplateId": "integer",
  "AuditId": "integer",
  "DocumentGenerationTypeId": "string",
  "Name": "string",
  "FileId": "string",
  "FileExists": "boolean"
}
DocumentGenerationTemplate

POST /api/documentgenerationtemplates/{documentgenerationtemplateid}

DocumentGenerationTemplateAddEditModel

undefined

documentgenerationtemplateid: string
in path

(no description)

Request Example
{
  "DocumentGenerationTemplateId": "integer",
  "AuditId": "integer",
  "DocumentGenerationTypeId": "string",
  "Name": "string",
  "FileId": "string",
  "FileExists": "boolean"
}
200 OK
DocumentGenerationTemplateCollectionItemModel

OK

Response Example (200 OK) 
{
  "DocumentGenerationTemplateId": "integer",
  "DocumentGenerationTypeId": "string",
  "AuditId": "integer",
  "TemplateType": "string",
  "Name": "string",
  "AllowEdit": "boolean",
  "FileId": "string",
  "FileName": "string",
  "FileEditUrl": "string",
  "Actions": "string"
}
DocumentGenerationTemplate

DELETE /api/documentgenerationtemplates/{documentgenerationtemplateid}/{auditid}

documentgenerationtemplateid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

DocumentGenerationTemplate

GET /api/documentgenerationtemplates/availablemergefields/{documentgenerationtypeid}

documentgenerationtypeid: string
in path

(no description)

200 OK
AvailableDocumentMergeFieldsModel

OK

Response Example (200 OK) 
{
  "DocumentGenerationTypeId": "string",
  "AvailableFieldsGroup": "string"
}
DocumentGenerationTemplate

POST /api/documentgenerationtemplates/copy/{documentgenerationtemplateid}

documentgenerationtemplateid: integer
in path

(no description)

200 OK
DocumentGenerationTemplateCollectionItemModel

OK

Response Example (200 OK) 
{
  "DocumentGenerationTemplateId": "integer",
  "DocumentGenerationTypeId": "string",
  "AuditId": "integer",
  "TemplateType": "string",
  "Name": "string",
  "AllowEdit": "boolean",
  "FileId": "string",
  "FileName": "string",
  "FileEditUrl": "string",
  "Actions": "string"
}
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/download/{documentgenerationtemplateid}/{fileid}

documentgenerationtemplateid: integer
in path

(no description)

fileid: integer
in path

(no description)

200 OK
HttpResponseMessage

OK

Response Example (200 OK) 
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}
DocumentGenerationTemplate

Lookup based on a specific document generation type.

GET /api/documentgenerationtemplates/lookup/{documentgenerationtype}

Lookup based on a specific document generation type.

documentgenerationtype: string
in path

The SystemDocumentGenerationTypeOption

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/attendeebadge

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/brokeragestatement

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/brokerstatementbyoffice

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/certificate

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/certificate/component

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/contactletter

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/coverletter

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/credits

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/defaultstatement

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/invoices

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/member

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/membershiptypeactivecensus

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/payments

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/refunds

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/sales

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/salesproposal

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
DocumentGenerationTemplate

GET /api/documentgenerationtemplates/lookup/singleattendeebadge

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]

Schema Definitions

DocumentGenerationTemplates: object

Instruction: string
Items: string
Example
{
  "Instruction": "string",
  "Items": "string"
}

AvailableDocumentMergeFieldsModel: object

DocumentGenerationTypeId: string
AvailableFieldsGroup: string
Example
{
  "DocumentGenerationTypeId": "string",
  "AvailableFieldsGroup": "string"
}

DocumentGenerationTemplateAddEditModel: object

DocumentGenerationTemplateId: integer
AuditId: integer
DocumentGenerationTypeId: string
Name: string
FileId: string
FileExists: boolean
Example
{
  "DocumentGenerationTemplateId": "integer",
  "AuditId": "integer",
  "DocumentGenerationTypeId": "string",
  "Name": "string",
  "FileId": "string",
  "FileExists": "boolean"
}

DocumentGenerationTemplateCollectionItemModel: object

DocumentGenerationTemplateId: integer
DocumentGenerationTypeId: string
AuditId: integer
TemplateType: string
Name: string
AllowEdit: boolean
FileId: string
FileName: string
FileEditUrl: string
Actions: string
Example
{
  "DocumentGenerationTemplateId": "integer",
  "DocumentGenerationTypeId": "string",
  "AuditId": "integer",
  "TemplateType": "string",
  "Name": "string",
  "AllowEdit": "boolean",
  "FileId": "string",
  "FileName": "string",
  "FileEditUrl": "string",
  "Actions": "string"
}

Object: object

Example
"object"

HttpResponseMessage: object

Version: string
Content: string
StatusCode: string
ReasonPhrase: string
Headers: string
RequestMessage: string
IsSuccessStatusCode: boolean
Example
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

IQueryable: object

Expression: string
ElementType: string
Provider: string
Example
{
  "Expression": "string",
  "ElementType": "string",
  "Provider": "string"
}
Documentation by Spectacle