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

SignUp

POST /api/signup/beginsignup

SignUpMinimalForm

undefined

Request Example
{
  "Email": "string"
}
200 OK
StandardJsonResult

OK

Response Example (200 OK) 
{
  "ErrorMessages": "string"
}
SignUp

Setup a new account and all applicable data

POST /api/signup/completesignup

Setup a new account and all applicable data

SoftwareSignupForm

undefined

Request Example
{
  "AssociationName": "string",
  "OrganizationType": "string",
  "Name": "string",
  "NewUsername": "string",
  "NewPassword": "string",
  "Email": "string",
  "TrialKey": "string",
  "BrowserTimeZone": "string",
  "CustomFields": "string",
  "IsUsed": "boolean",
  "IsExpired": "boolean"
}
200 OK
StandardJsonResult

OK

Response Example (200 OK) 
{
  "ErrorMessages": "string"
}
SignUp

GET /api/signup/parsename/{fullname}

fullname: string
in path

(no description)

200 OK
StandardJsonResult

OK

Response Example (200 OK) 
{
  "ErrorMessages": "string"
}
SignUp

GET /api/signup/suggestdomainname/{orgname}

orgname: string
in path

(no description)

200 OK
Task<dynamic>

OK

Response Example (200 OK) 
{
  "ShouldNotifyDebuggerOfWaitCompletion": "boolean",
  "Id": "integer",
  "CurrentId": "string",
  "Exception": "string",
  "Status": "string",
  "IsCanceled": "boolean",
  "IsCompleted": "boolean",
  "CreationOptions": "string",
  "System.IAsyncResult.AsyncWaitHandle": "string",
  "AsyncState": "string",
  "System.IAsyncResult.CompletedSynchronously": "boolean",
  "Factory": "string",
  "CompletedTask": "string",
  "IsFaulted": "boolean",
  "SavedStateForNextReplica": "string",
  "SavedStateFromPreviousReplica": "string",
  "HandedOverChildReplica": "string",
  "Result": "string"
}
SignUp

GET /api/signup/trialkey/{id}/isvalid

id: string
in path

(no description)

200 OK

OK

SignUp

POST /api/signup/validateuseraccountbytoken

UserLoginData

undefined

Request Example
{
  "UserName": "string",
  "Token": "string",
  "Password": "string"
}
200 OK
StandardJsonResult

OK

Response Example (200 OK) 
{
  "ErrorMessages": "string"
}
SignUp

GET /api/signup/validateusername/{username}

username: string
in path

(no description)

200 OK
StandardJsonResult

OK

Response Example (200 OK) 
{
  "ErrorMessages": "string"
}
SignUp

GET /api/signup/validateusernamebytoken/{username}/{token}

username: string
in path

(no description)

token: string
in path

(no description)

200 OK
StandardJsonResult

OK

Response Example (200 OK) 
{
  "ErrorMessages": "string"
}

Schema Definitions

StandardJsonResult: object

ErrorMessages: string
Example
{
  "ErrorMessages": "string"
}

SignUpMinimalForm: object

Email: string
Example
{
  "Email": "string"
}

SoftwareSignupForm: object

AssociationName: string
OrganizationType: string
Name: string
NewUsername: string
NewPassword: string
Email: string
TrialKey: string
BrowserTimeZone: string
CustomFields: string
IsUsed: boolean
IsExpired: boolean
Example
{
  "AssociationName": "string",
  "OrganizationType": "string",
  "Name": "string",
  "NewUsername": "string",
  "NewPassword": "string",
  "Email": "string",
  "TrialKey": "string",
  "BrowserTimeZone": "string",
  "CustomFields": "string",
  "IsUsed": "boolean",
  "IsExpired": "boolean"
}

Boolean: object

Example
"object"

Task<dynamic>: object

ShouldNotifyDebuggerOfWaitCompletion: boolean
Id: integer
CurrentId: string
Exception: string
Status: string
IsCanceled: boolean
IsCompleted: boolean
CreationOptions: string
System.IAsyncResult.AsyncWaitHandle: string
AsyncState: string
System.IAsyncResult.CompletedSynchronously: boolean
Factory: string
CompletedTask: string
IsFaulted: boolean
SavedStateForNextReplica: string
SavedStateFromPreviousReplica: string
HandedOverChildReplica: string
Result: string
Example
{
  "ShouldNotifyDebuggerOfWaitCompletion": "boolean",
  "Id": "integer",
  "CurrentId": "string",
  "Exception": "string",
  "Status": "string",
  "IsCanceled": "boolean",
  "IsCompleted": "boolean",
  "CreationOptions": "string",
  "System.IAsyncResult.AsyncWaitHandle": "string",
  "AsyncState": "string",
  "System.IAsyncResult.CompletedSynchronously": "boolean",
  "Factory": "string",
  "CompletedTask": "string",
  "IsFaulted": "boolean",
  "SavedStateForNextReplica": "string",
  "SavedStateFromPreviousReplica": "string",
  "HandedOverChildReplica": "string",
  "Result": "string"
}

UserLoginData: object

UserName: string
Token: string
Password: string
Example
{
  "UserName": "string",
  "Token": "string",
  "Password": "string"
}
Documentation by Spectacle