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

GET /api/login/aboutme

200 OK

AboutMeViewModel

Response Example (200 OK)

{
  "FirstName": "string",
  "Name": "string",
  "ContactId": "integer",
  "TenantId": "integer",
  "TenantName": "string",
  "TenantDomain": "string",
  "TenantKey": "string",
  "CurrentOrganizationId": "integer",
  "CurrentOrganizationName": "string",
  "LastName": "string",
  "HasAgreedOnBackOfficeTerms": "boolean",
  "TermsContent": "string",
  "TermsOfUseId": "string",
  "TenantLogoUrl": "string",
  "TenantLogoShortDescription": "string",
  "ContactLogoUrl": "string",
  "ContactLogoShortDescription": "string",
  "AllRoles": "string",
  "DirectoryModuleItems": "string",
  "ContentModuleItems": "string",
  "InfoHubTermsOfUseId": "string",
  "HasAgreedOnInfoHubTerms": "boolean",
  "InfoHubTermsOfUseContent": "string"
}

GET /api/login/clientauthcheck/{loginid}/{tenantkey}

loginid: integer

in path

(no description)

tenantkey: string

in path

(no description)

200 OK

KB: This method hard deletes the user from central database. This was introduced for cleaning up the test user for API testing workflow - MZ-2506 Secured the API with an masterkey to ensure malicious usage. The masterkey is hardcoded for now since only the API testing tool uses this API

DELETE /api/login/delete

KB: This method hard deletes the user from central database. This was introduced for cleaning up the test user for API testing workflow - MZ-2506 Secured the API with an masterkey to ensure malicious usage. The masterkey is hardcoded for now since only the API testing tool uses this API

username: string

in query

(no description)

masterkey: string

in query

(no description)

200 OK

HttpResponseMessage

Response Example (200 OK)

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

GET /api/login/logincheck

200 OK

POST /api/login/requestmagiclink

String

type: string

in query

(no description)

Request Example

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

200 OK

GET /api/login/securityquestions/lookup

200 OK

SecurityQuestion

type

SecurityQuestion

Response Example (200 OK)

[
  {
    "Id": "integer",
    "Name": "string"
  }
]

Schema Definitions

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"
}

AboutMeViewModel: object

FirstName: string
Name: string
ContactId: integer
TenantId: integer
TenantName: string
TenantDomain: string
TenantKey: string
CurrentOrganizationId: integer
CurrentOrganizationName: string
LastName: string
HasAgreedOnBackOfficeTerms: boolean
TermsContent: string
TermsOfUseId: string
TenantLogoUrl: string
TenantLogoShortDescription: string
ContactLogoUrl: string
ContactLogoShortDescription: string
AllRoles: string
DirectoryModuleItems: string
ContentModuleItems: string
InfoHubTermsOfUseId: string
HasAgreedOnInfoHubTerms: boolean
InfoHubTermsOfUseContent: string

Example

{
  "FirstName": "string",
  "Name": "string",
  "ContactId": "integer",
  "TenantId": "integer",
  "TenantName": "string",
  "TenantDomain": "string",
  "TenantKey": "string",
  "CurrentOrganizationId": "integer",
  "CurrentOrganizationName": "string",
  "LastName": "string",
  "HasAgreedOnBackOfficeTerms": "boolean",
  "TermsContent": "string",
  "TermsOfUseId": "string",
  "TenantLogoUrl": "string",
  "TenantLogoShortDescription": "string",
  "ContactLogoUrl": "string",
  "ContactLogoShortDescription": "string",
  "AllRoles": "string",
  "DirectoryModuleItems": "string",
  "ContentModuleItems": "string",
  "InfoHubTermsOfUseId": "string",
  "HasAgreedOnInfoHubTerms": "boolean",
  "InfoHubTermsOfUseContent": "string"
}

IHttpActionResult: object

Example

"object"

String: object

this[]: string
Length: integer

Example

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

SecurityQuestion: object

Id: integer
Name: string

Example

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

JObject: object

Example

"object"

Documentation by Spectacle