ApptosisAppListing
Listing of entry points into Apptosis APIs
GET /apptosis
This service returns a list of available applications.
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.apptosis.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.apptosis.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"result": [
{
"id": "The application id",
"name": "The application name",
"route": "The application route"
}
]
}
Login
Authenticate the user
POST /apptosis/user/login
Extends ZfcUserController to provide Json interaction.
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| identity | Email Address | YES | |
| credential | Password | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.apptosis.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.apptosis.v1+json
application/json |
Body
{
"identity": "Email Address",
"credential": "Password"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.apptosis.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"success": "Boolean",
"message": "string|array"
}
Logout
GET /apptosis/user/logout
Extends ZfcUserController to provide Json interaction.
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.apptosis.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.apptosis.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"success": "Boolean",
"message": "Text"
}
UserIndex
The User index route.
GET /apptosis/user
Returns the fields the logged in User is permitted to see about their identity. The created at field is formatted as DateTime::ISO8601.
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.apptosis.v1+json
application/json
application/*+json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.apptosis.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"createdAt": "YYYY-MM-DDThh:mm:ss+hhmm",
"emailAddress": "Email Address",
"userStatus": "null or String",
"displayName": "Display Name"
}
UserRegister
Create a new User account.
POST /apptosis/user/register
If the user is already logged in, or if BjyAuthorized is not enabled, "success" will be false.
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| emailAddress | The email address will also be used as the identity field for user login. | YES | |
| displayName | The user name can accept spaces and special characters. | YES | |
| password | The user's proposed password. | YES | |
| passwordVerify | Matching password | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.apptosis.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.apptosis.v1+json
application/json |
Body
{
"emailAddress": "The email address will also be used as the identity field for user login.",
"displayName": "The user name can accept spaces and special characters.",
"password": "The user's proposed password.",
"passwordVerify": "Matching password."
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.apptosis.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"success": "Boolean",
"message": "string|array",
"user": {
"createdAt": "YYYY-MM-DDThh:mm:ss+hhmm",
"emailAddress": "Email Address",
"userStatus": "null or String",
"displayName": "Display Name"
}
}
UserChangePassword
Change password.
POST /apptosis/user/change-password
Allows a user who knows the existing password to change it.
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| identity | User Email Address | YES | |
| credential | The existing password | YES | |
| newCredential | The proposed new password | YES | |
| newCredentialVerify | Matching password | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.apptosis.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.apptosis.v1+json
application/json |
Body
{
"identity": "User Email Address",
"credential": "The existing password",
"newCredential": "The proposed new password",
"newCredentialVerify": "Matching password"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.apptosis.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"success": "Boolean",
"message": "string|array"
}
UserChangeEmail
Allow logged in user to change email.
POST /apptosis/user/change-email
Requires that the user verify the password, since email address is used as the identity field for login.
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| credential | User password | YES | |
| newIdentity | New email address. | YES | |
| newIdentityVerify | Verify the email address | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.apptosis.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.apptosis.v1+json
application/json |
Body
{
"credential": "User password",
"newIdentity": "New email address.",
"newIdentityVerify": "Verify the email address"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.apptosis.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"success": "Boolean",
"message": "string|array"
}