Request Data

Request Data Specification

This document defines the format of the request data to be sent to the API through the URIs defined on the URI page. API call parameters should be passed in the body of the request as a valid JSON object string. Request parameters (GET parameters, POST parameters, etc) are not used in the API.

The JSON should not contain nested objects or arrays (objects inside of objects, objects inside of arrays, etc). The outermost object should contain keys that only map to values of 'primitive' types like numbers and strings.

Example

{
    "companyID": "SomeCompany",
    "password": "companypassword"
}

Important Note

All requests other than the initial "Authentication" request must pass an additional parameter defined here.

Parameter (key)	Type	Max Length	Description	Required
authKey	string	N/A	uuid provided by authentication request	Yes

---

Authentication

Parameter (key)	Type	Max Length	Description	Required
companyID	string	64	'username' field of the authentication	Yes
password	string	16	'password' field of the authentication	Yes

---

Employee Information Storage

Parameter (key)	Type	Max Length	Description	Required
firstName	string	32	First name of the employee	No
lastName	string	32	Last name of the employee	No
email	string	64	Email of the employee	No
phoneNumber	string	32	Phone number of the employee	No

---

Ticket Submission

Parameter (key)	Type	Max Length	Description	Required
location	string	64	Location/site where the issue is occurring	No
description	string	1024	Description of the issue	Yes
photo	string (base64)	N/A	Image taken by the employee as a base64 encoded string	No (but highly recommended)