ORCATECH API
API Endpoint
https://juno.orcatech.org/apis/orcatech/v0.7Version 0.7
This API is under active development. Changes will result in a new version to maintain backward compatibility.
Views
Authentication
An authentication token is required to access the API. In the future client secrets will be handed out so that users may refesh their tokens. In the meantime, tokens can be requested by contacting ORCATECH. This authorization token must be included in the header with all requests otherwise the server will reply with a 401 HTTP status code. Here is an example Authentication header:
Authorization: bearer 5262d64b892e8d4341000001Changes
-
0.7
- Created new endpoints for issues information.
- Created new endpoints for projects information.
- Created new endpoints for studies information.
-
0.4
- Created new endpoints for home information.
- Changed ‘devices’ to ‘items’
- Converted all timestamps to unix
-
0.3
- Created new endpoints for subject information.
-
0.2
- Timeseries are now in descending order.
- Changed timeseries ‘after’ parameter to ‘before’.
- Added nextpanicstart and nextpanicstop to medtracker status timeseries.
- Changed firmware to firmwarerevision in the medtracker status timeseries.
- Added NYCE sensors time series.
-
0.1
- First version.
Inventory ¶
The following endpoints are for collecting information about particular items such as serialnumbers, mac addresses and data collected by these items.
Item Data
If you are interested in retreiving data collected by one of these items please follow the instructions on the item data page
Item Types ¶
This url can be used to determine which types of items are available for use.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonHeaders
ContentType: application/jsonBody
[
null
]Schema
{
"type": "array",
"items": {},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Item TypesGET/items
Retrieves a list of item types
Items ¶
You can use this url to view detailed information about your inventory of items by type.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
If the item typename can not be found then the server with send a 404 response.
If the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonHeaders
ContentType: application/jsonBody
[
{
"itemid": 419,
"itemname": "MT0023",
"serialnum": "MT0023",
"macaddress": "00:A0:96:10:06:E6",
"modelid": 29,
"modelname": "V1.2",
"subjectspecific": 1,
"vendorid": 15,
"vendorname": "OHSU",
"typeid": 15,
"typename": "MedTracker",
"subtypeid": 0,
"subtypename": "null",
"currenthomeid": 0,
"currenthomestart": 1435844505,
"active": 1,
"activename": "Active",
"statusid": 1,
"statusname": "Recieved",
"batterymonths": 12,
"lastbatterychange": "null",
"hasbatteries": 1
}
]Schema
{
"type": "array",
"items": {
"type": "object",
"properties": {
"itemid": {
"type": "number",
"description": "Unique identifier"
},
"itemname": {
"type": "string",
"description": "Unique name"
},
"serialnum": {
"type": "string",
"description": "Serial number of the device"
},
"macaddress": {
"type": "string",
"description": "Hardware mac address"
},
"modelid": {
"type": "number",
"description": "Unique identifier for the model"
},
"modelname": {
"type": "string",
"description": "Name of the model"
},
"subjectspecific": {
"type": "number",
"description": "Whether the device is specific to the home or subject (0: Not specific, 1: specific)"
},
"vendorid": {
"type": "number",
"description": "Unique identifier for the vender"
},
"vendorname": {
"type": "string",
"description": "Name of the vendor"
},
"typeid": {
"type": "number",
"description": "Unique identifier for the device type"
},
"typename": {
"type": "string",
"description": "Name of the device type"
},
"subtypeid": {
"type": "number",
"description": "Unique identifier for the device sub type,"
},
"subtypename": {
"type": "string",
"description": "Name of the device sub tyoe"
},
"currenthomeid": {
"type": "number",
"description": "Unique Identifier of the home in which the device is installed"
},
"currenthomestart": {
"type": "number",
"description": "Date in which the device was installed in its home"
},
"active": {
"type": "number",
"description": "Whether or not the device is active in a home"
},
"activename": {
"type": "string",
"description": "Whether or not the item is active (Active, Inactive)"
},
"statusid": {
"type": "number",
"description": "Unique Identifier of the current status of the device"
},
"statusname": {
"type": "string",
"description": "Name of the current device status (Assigned,recieved,decommissioned)"
},
"batterymonths": {
"type": "number",
"description": "Number of months the battery will last"
},
"lastbatterychange": {
"type": "string",
"description": "Date of last recorded battery change"
},
"hasbatteries": {
"type": "number",
"description": "Whether or not the item has batteries (0: does not have batteries; 1: has batteries)"
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}ItemsGET/inventory/{typename}{?skip,limit}
Retrieves a list of items.
- typename
string(required) Example: medtrackersDevice type name returned by GET request to devices
- skip
integer(optional) Default: 0 Example: 0The number of devices to skip
- limit
integer(optional) Default: 1000 Example: 25The maximum number of devices to return, up to
1000
Item ¶
You can use this url to view detailed information about a single item that matches the itemname supplied.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
If the item typename can not be found then the server with send a 404 response.
If the item name can not be found then the server with send a 404 response.
If the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonHeaders
ContentType: application/jsonBody
{
"itemid": 419,
"itemname": "MT0023",
"serialnum": "MT0023",
"macaddress": "00:A0:96:10:06:E6",
"modelid": 29,
"modelname": "V1.2",
"subjectspecific": 1,
"vendorid": 15,
"vendorname": "OHSU",
"typeid": 15,
"typename": "MedTracker",
"subtypeid": 0,
"subtypename": "null",
"currenthomeid": 0,
"currenthomestart": 1435844505,
"active": 1,
"activename": "Active",
"statusid": 1,
"statusname": "Recieved",
"batterymonths": 12,
"lastbatterychange": "null",
"hasbatteries": 1
}Schema
{
"type": "object",
"properties": {
"itemid": {
"type": "number",
"description": "Unique identifier"
},
"itemname": {
"type": "string",
"description": "Unique name"
},
"serialnum": {
"type": "string",
"description": "Serial number of the device"
},
"macaddress": {
"type": "string",
"description": "Hardware mac address"
},
"modelid": {
"type": "number",
"description": "Unique identifier for the model"
},
"modelname": {
"type": "string",
"description": "Name of the model"
},
"subjectspecific": {
"type": "number",
"description": "Whether the device is specific to the home or subject (0: Not specific, 1: specific)"
},
"vendorid": {
"type": "number",
"description": "Unique identifier for the vender"
},
"vendorname": {
"type": "string",
"description": "Name of the vendor"
},
"typeid": {
"type": "number",
"description": "Unique identifier for the device type"
},
"typename": {
"type": "string",
"description": "Name of the device type"
},
"subtypeid": {
"type": "number",
"description": "Unique identifier for the device sub type,"
},
"subtypename": {
"type": "string",
"description": "Name of the device sub tyoe"
},
"currenthomeid": {
"type": "number",
"description": "Unique Identifier of the home in which the device is installed"
},
"currenthomestart": {
"type": "number",
"description": "Date in which the device was installed in its home"
},
"active": {
"type": "number",
"description": "Whether or not the device is active in a home"
},
"activename": {
"type": "string",
"description": "Whether or not the item is active (Active, Inactive)"
},
"statusid": {
"type": "number",
"description": "Unique Identifier of the current status of the device"
},
"statusname": {
"type": "string",
"description": "Name of the current device status (Assigned,recieved,decommissioned)"
},
"batterymonths": {
"type": "number",
"description": "Number of months the battery will last"
},
"lastbatterychange": {
"type": "string",
"description": "Date of last recorded battery change"
},
"hasbatteries": {
"type": "number",
"description": "Whether or not the item has batteries (0: does not have batteries; 1: has batteries)"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}ItemGET/inventory/{typename}/{itemname}
Retrieves information about a single item.
- typename
string(required) Example: medtrackersItem type name returned by GET request to items
- itemname
string(required) Example: MT0301Item name retured by GET request to item/{typename}
Subjects ¶
The following endpoints are for collecting information about particular subjects such as study or project enrollment.
Subjects ¶
This url can be used to get information on all subjects.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
Headers
ContentType: application/jsonBody
[
{
"subjectid": 315,
"subjectname": "Jane Doe",
"titleid": 1,
"titlename": "Mrs.",
"lname": "Doe",
"fname": "Jane",
"oadc": 10002,
"email": "janedoe24@hotmail.com",
"genderid": false,
"gendername": "Female",
"dob": 1423958400,
"dod": 1426464000
}
]Schema
{
"type": "array",
"items": {
"type": "object",
"properties": {
"subjectid": {
"type": "number",
"description": "Unique ORCATECH database identifier"
},
"subjectname": {
"type": "string",
"description": "Name of subject"
},
"titleid": {
"type": "number",
"description": "Unique identifier for subject's title (0: Mr, 1: Mrs, 3: Miss, 4:Dr, 4:Ms)"
},
"titlename": {
"type": "string",
"description": "Subject's title"
},
"lname": {
"type": "string",
"description": "Subject's last name"
},
"fname": {
"type": "string",
"description": "Subject's first name"
},
"oadc": {
"type": "number",
"description": "Unique identifier for external database"
},
"email": {
"type": "string",
"description": "Subject's email"
},
"genderid": {
"type": "boolean",
"description": "Subject's gender code - 0 for female, 1 for male"
},
"gendername": {
"type": "string",
"description": "Subject's gender"
},
"dob": {
"type": "number",
"description": "Subject's date of birth"
},
"dod": {
"type": "number",
"description": "Subject's date of death"
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}SubjectsGET/subjects/
Retrieves information about all the subjects.
Subject ¶
You can use this url to view detailed information about a specific subject that matches the subject id supplied. All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"subjectid": 315,
"subjectname": "Jane Doe",
"titleid": 1,
"titlename": "Mrs.",
"lname": "Doe",
"fname": "Jane",
"oadc": 10002,
"email": "janedoe24@hotmail.com",
"genderid": false,
"gendername": "Female",
"dob": 1423958400,
"dod": 1426464000
}Schema
{
"type": "object",
"properties": {
"subjectid": {
"type": "number",
"description": "Unique ORCATECH database identifier"
},
"subjectname": {
"type": "string",
"description": "Name of subject"
},
"titleid": {
"type": "number",
"description": "Unique identifier for subject's title (0: Mr, 1: Mrs, 3: Miss, 4:Dr, 4:Ms)"
},
"titlename": {
"type": "string",
"description": "Subject's title"
},
"lname": {
"type": "string",
"description": "Subject's last name"
},
"fname": {
"type": "string",
"description": "Subject's first name"
},
"oadc": {
"type": "number",
"description": "Unique identifier for external database"
},
"email": {
"type": "string",
"description": "Subject's email"
},
"genderid": {
"type": "boolean",
"description": "Subject's gender code - 0 for female, 1 for male"
},
"gendername": {
"type": "string",
"description": "Subject's gender"
},
"dob": {
"type": "number",
"description": "Subject's date of birth"
},
"dod": {
"type": "number",
"description": "Subject's date of death"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}SubjectGET/subjects/{id}
Retrieves information about a single subject by their id.
- id
integer(required) Example: 71The id of the study
Project Enrollment ¶
You can use this url to determine what projects a specific subject is enrolled in using the subject’s id. All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"subjectid": 277,
"projectid": 13,
"homeid": 11,
"projectname": "Life Lab",
"statename": "Active",
"stateid": 100,
"start": 1433620404,
"stop": 1433620531
}Schema
{
"type": "object",
"properties": {
"subjectid": {
"type": "number",
"description": "Unique identifier for subject enrolled in project"
},
"projectid": {
"type": "number",
"description": "Unique Identifier of Project"
},
"homeid": {
"type": "number",
"description": "Unique identifier for home enrolled in project"
},
"projectname": {
"type": "string",
"description": "Name of Project"
},
"statename": {
"type": "string",
"description": "Subject's current state of involvement with project"
},
"stateid": {
"type": "number",
"description": "Subject's current state of involvement's corresponding identifier"
},
"start": {
"type": "number",
"description": "Date and time of subject's start with project"
},
"stop": {
"type": "number",
"description": "Date and time of subject's start with project"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Project EnrollementGET/subjects/{id}/enrollment/projects/
Retrieves information on the projects that a subject is enrolled in.
- id
integer(required) Example: 71The id of the study
Study Enrollment ¶
You can use this url to determine what studies a specific subject is enrolled in using the subject’s id. All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"subjectid": 1545,
"studyid": 24,
"studyname": "In",
"studyinvestigator": "John Smith",
"studyirb": 8189,
"studycriteria": "65 years of age or older, walk independently",
"studysummary": "16 months of ORCATECH data will be analyzed from participants’ routine completion of a weekly online health questionnaire and routine telephone use.",
"studystart": 1442966400,
"studystop": 1446249600,
"studystatusid": 3,
"studystatusname": "completed",
"studystateid": 4,
"studystatename": "Eligible",
"studychangebyname": "Jane Doe",
"studystatecomment": "Completed 8/5/2016",
"studystatestart": 1454898745,
"studystatestop": 0,
"active": 1
}Schema
{
"type": "object",
"properties": {
"subjectid": {
"type": "number",
"description": "Unique ORCATECH database identifier"
},
"studyid": {
"type": "number",
"description": "Unique identifier for study"
},
"studyname": {
"type": "string",
"description": "Home Balance Study (string,fixed) - Name of study"
},
"studyinvestigator": {
"type": "string",
"description": "Name of study investigator"
},
"studyirb": {
"type": "number",
"description": "Study's irb unique identifier"
},
"studycriteria": {
"type": "string",
"description": "Criteria necessary to enroll in the study"
},
"studysummary": {
"type": "string"
},
"studystart": {
"type": "number",
"description": "Date & time of study's start"
},
"studystop": {
"type": "number",
"description": "Date & time of study's end"
},
"studystatusid": {
"type": "number",
"description": "Subject's status with study"
},
"studystatusname": {
"type": "string",
"description": "Name of subject's status with study"
},
"studystateid": {
"type": "number",
"description": "Subject's state in study described by unique identifier"
},
"studystatename": {
"type": "string",
"description": "Subject's state in study"
},
"studychangebyname": {
"type": "string",
"description": "Name of person that changed the subject's study status?"
},
"studystatecomment": {
"type": "string",
"description": "Comment on subject's study status"
},
"studystatestart": {
"type": "number",
"description": "Date and time when subject's current study status began"
},
"studystatestop": {
"type": "number",
"description": "Date and time when subject's current study status ends"
},
"active": {
"type": "number",
"description": "1 for active, 0 for not active"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Study EnrollmentGET/subjects/{id}/enrollment/studies/
Retrieves information on the studies that a subject is enrolled in.
- id
integer(required) Example: 71The id of the study
Scheduled Contacts ¶
You can use this url to get information on a subject’s scheduled contacts. All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"subjectid": 475,
"schedcontactid": 95,
"schedcontactname": "\"Clinician Visit 1.0\"",
"schedcontacttypename": "\"Clinician Vist\"",
"increment": 12,
"unitname": "Month",
"unitid": 2,
"offset": 6,
"notplanned": 0,
"notscheduled": 0,
"notcompleted": 0,
"dateplanned": "2011",
"datescheduled": "2011",
"datecompleted": "2011"
}Schema
{
"type": "object",
"properties": {
"subjectid": {
"type": "number",
"description": "Unique Identifier for Subject"
},
"schedcontactid": {
"type": "number",
"description": "Unique Identifier for Scheduled Contact"
},
"schedcontactname": {
"type": "string",
"description": "Name of Scheduled Contact"
},
"schedcontacttypename": {
"type": "string",
"description": "Type of Scheduled Contact"
},
"increment": {
"type": "number",
"description": "How many units between each contact"
},
"unitname": {
"type": "string",
"description": "Name of unit"
},
"unitid": {
"type": "number",
"description": "Unique Identifier for unit"
},
"offset": {
"type": "number",
"description": "How long after enrollment before the first contact (measured in units displayed above)"
},
"notplanned": {
"type": "number",
"description": "Whether or not the contact is planned; 0 for no and 1 for yes"
},
"notscheduled": {
"type": "number",
"description": "Whether or not the contact is sheduled; 0 for no and 1 for yes"
},
"notcompleted": {
"type": "number",
"description": "Whether or not the contact is completed; 0 for no and 1 for yes"
},
"dateplanned": {
"type": "string",
"description": "03-07 (string,fixed) - Date that the contact was planned"
},
"datescheduled": {
"type": "string",
"description": "05-18 (string,fixed) - Date that the contact was scheduled for"
},
"datecompleted": {
"type": "string",
"description": "05-18 (string,fixed) - Date that the contact was completed"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Scheduled ContactsGET/subjects/{id}/scheduled/contacts/
Retrieves information on the contacts scheduled with the given subject.
- id
integer(required) Example: 71The id of the study
Subject's Phones ¶
You can use this url to get information on a subject’s phone using the subject’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"subjectid": 372,
"phoneid": 82,
"phone": "971"
}Schema
{
"type": "object",
"properties": {
"subjectid": {
"type": "number",
"description": "Unique identifier for subject"
},
"phoneid": {
"type": "number",
"description": "Unique identifier"
},
"phone": {
"type": "string",
"description": "212-2833 (string,fixed) - Subject's phone number"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Subject's PhonesGET/subjects/{id}/phone/
Retrieves information on the given subject’s phone.
- id
integer(required) Example: 71The id of the study
Subject's Inventory ¶
You can use this url to get information on the inventory assigned to a subject using the subject’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"subjectid": 1425,
"itemid": 13716,
"itemname": "activite",
"serialnumber": "00:24:E4:30:12:85",
"macaddress": "00:24:E4:30:12:85",
"modelid": 169,
"modelname": "Activite",
"hasbatteries": 1,
"lastbatterychange": "3/14/15",
"subjectspecific": 1,
"vendorid": 51,
"vendorname": "Withings",
"typeid": 42,
"typename": "Watch",
"subtypeid": 41,
"subtypename": "Activitv",
"start": "2017",
"stop": "2017"
}Schema
{
"type": "object",
"properties": {
"subjectid": {
"type": "number",
"description": "Unique identifier for subject"
},
"itemid": {
"type": "number",
"description": "Unique identifier for item"
},
"itemname": {
"type": "string",
"description": "102 (string,fixed) - Name of item"
},
"serialnumber": {
"type": "string",
"description": "Serial number of item"
},
"macaddress": {
"type": "string",
"description": "Item's mac address"
},
"modelid": {
"type": "number",
"description": "Unique identifier for model"
},
"modelname": {
"type": "string",
"description": "Model Name"
},
"hasbatteries": {
"type": "number",
"description": "Whether or not the item has batteries; 0 for no 1 for yes"
},
"lastbatterychange": {
"type": "string",
"description": "Date of last battery change"
},
"subjectspecific": {
"type": "number",
"description": "Whether or not the item is subject specific; 0 for no 1 for yes"
},
"vendorid": {
"type": "number",
"description": "Unique identifier for vendor"
},
"vendorname": {
"type": "string",
"description": "Item's vendor"
},
"typeid": {
"type": "number",
"description": "Unique identifier for item's type"
},
"typename": {
"type": "string",
"description": "Name of item's type"
},
"subtypeid": {
"type": "number",
"description": "Unique identifier for item's subtype"
},
"subtypename": {
"type": "string",
"description": "Name of item's subtype"
},
"start": {
"type": "string",
"description": "05-18 00:40:44 (string,fixed) - Date and time when item was assigned to subject"
},
"stop": {
"type": "string",
"description": "05-18 15:46:00 (string,fixed) - Date and time when item was unassigned to subject"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Subject's InventoryGET/subjects/{id}/inventory/
Retrieves information on the given subject’s inventory.
- id
integer(required) Example: 71The id of the study
Subject's Contacts ¶
You can use this url to get information on contacts with a specific subject using the subject’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"subjectid": 372,
"contacttypename": "Phone",
"contactid": 20520,
"contacttypeid": 0,
"contactdate": 1158624000,
"contactText": "Phone monitor is connected and reporting.",
"contactstarttime": "32400",
"contactstoptime": "36000",
"durationid": 1,
"durationname": "15 min",
"reasonid": 22,
"reasonname": "\"Sensor outage\"",
"userid": 175,
"username": "John Smith"
}Schema
{
"type": "object",
"properties": {
"subjectid": {
"type": "number",
"description": "Unique identifier for subject"
},
"contacttypename": {
"type": "string",
"description": "Type of contact with subject"
},
"contactid": {
"type": "number",
"description": "Unique identifier for contact"
},
"contacttypeid": {
"type": "number",
"description": "Unique identifier for type of contact"
},
"contactdate": {
"type": "number",
"description": "Date of contact"
},
"contactText": {
"type": "string",
"description": "Description of contact"
},
"contactstarttime": {
"type": "string",
"description": "Time when contact began (Seconds past start of day)"
},
"contactstoptime": {
"type": "string",
"description": "Time when contact finished (Seconds past start of day)"
},
"durationid": {
"type": "number",
"description": "Unique identifier for duration of contact"
},
"durationname": {
"type": "string",
"description": "Duration of contact"
},
"reasonid": {
"type": "number",
"description": "Unique identifier for reason of visit"
},
"reasonname": {
"type": "string",
"description": "Reason for contact with subject"
},
"userid": {
"type": "number",
"description": "Unique identifier for user"
},
"username": {
"type": "string",
"description": "Name of user"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Subject's ContactsGET/subjects/{id}/contacts/
Retrieves information on the given subject’s contacts.
- id
integer(required) Example: 71The id of the study
Subject's Comments ¶
You can use this url to get the comments made with regard to a specific subject using the subject’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonHeaders
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Subject's CommentsGET/subjects/{id}/comments/
Retrieves information on the comments made with regard to the given subject.
- id
integer(required) Example: 71The id of the study
Subject's Alerts ¶
You can use this url to get information on alerts related a specific subject using the subject’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"subjectid": 372,
"alerttypeid": 1,
"alerttypename": "Health Form",
"alertmessage": "Last health form was done 220 days ago"
}Schema
{
"type": "object",
"properties": {
"subjectid": {
"type": "number",
"description": "Unique identifier for subject"
},
"alerttypeid": {
"type": "number",
"description": "Unique identifier for alert type"
},
"alerttypename": {
"type": "string",
"description": "The category of the alert. This will generally relate to sensor, data stream or database object"
},
"alertmessage": {
"type": "string",
"description": "A descriptive message about the alert"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Subject's AlertsGET/subjects/{id}/alerts/
Retrieves information on the alerts made with regard to the given subject.
- id
integer(required) Example: 71The id of the study
Homes ¶
The following endpoints are for collecting information about particular subject’s homes.
Homes ¶
You can use this url to get information on all homes.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
Headers
ContentType: application/jsonBody
[
{
"homeid": 14,
"address": "12705 SE River Rd.",
"cityname": "Portland",
"cityid": 1,
"citystatename": "Oregon",
"citystateid": 38,
"citystateabbr": "OR",
"countryname": "United States",
"countryabbr": "US",
"countryid": 1,
"zip": 97222,
"timezone": "America/Los Angeles",
"apartment": "509A",
"homephones": "503",
"homephoneids": 1,
"locationid": 4,
"locationname": "Willamette View",
"hometype": 0
}
]Schema
{
"type": "array",
"items": {
"type": "object",
"properties": {
"homeid": {
"type": "number",
"description": "Unique identifier for home"
},
"address": {
"type": "string",
"description": "Home's address"
},
"cityname": {
"type": "string",
"description": "Home's city"
},
"cityid": {
"type": "number",
"description": "Unique identifier for home's city"
},
"citystatename": {
"type": "string",
"description": "Home's state name"
},
"citystateid": {
"type": "number",
"description": "Unique identifier for home's state name"
},
"citystateabbr": {
"type": "string",
"description": "Home's state abbreviation"
},
"countryname": {
"type": "string",
"description": "Home's country"
},
"countryabbr": {
"type": "string",
"description": "Home's country abbreviation"
},
"countryid": {
"type": "number",
"description": "Subject's gender"
},
"zip": {
"type": "number",
"description": "Home's postal zip code"
},
"timezone": {
"type": "string",
"description": "Home's timezone"
},
"apartment": {
"type": "string",
"description": "Home's apartment number"
},
"homephones": {
"type": "string",
"description": "562-6305 (string,fixed) - Home's phone number"
},
"homephoneids": {
"type": "number",
"description": "Unique identifier for home phone"
},
"locationid": {
"type": "number",
"description": "Unique identifier for home's location"
},
"locationname": {
"type": "string",
"description": "Location's name"
},
"hometype": {
"type": "number",
"description": "Whether or not the home is an apartment (0: house, 1: apartment)"
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}HomesGET/homes/
Retrieves information about all the homes.
Home ¶
You can use this url to get information about a specific home using the home’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"homeid": 14,
"address": "12705 SE River Rd.",
"cityname": "Portland",
"cityid": 1,
"citystatename": "Oregon",
"citystateid": 38,
"citystateabbr": "OR",
"countryname": "United States",
"countryabbr": "US",
"countryid": 1,
"zip": 97222,
"timezone": "America/Los Angeles",
"apartment": "509A",
"homephones": "503",
"homephoneids": 1,
"locationid": 4,
"locationname": "Willamette View",
"hometype": 0
}Schema
{
"type": "object",
"properties": {
"homeid": {
"type": "number",
"description": "Unique identifier for home"
},
"address": {
"type": "string",
"description": "Home's address"
},
"cityname": {
"type": "string",
"description": "Home's city"
},
"cityid": {
"type": "number",
"description": "Unique identifier for home's city"
},
"citystatename": {
"type": "string",
"description": "Home's state name"
},
"citystateid": {
"type": "number",
"description": "Unique identifier for home's state name"
},
"citystateabbr": {
"type": "string",
"description": "Home's state abbreviation"
},
"countryname": {
"type": "string",
"description": "Home's country"
},
"countryabbr": {
"type": "string",
"description": "Home's country abbreviation"
},
"countryid": {
"type": "number",
"description": "Subject's gender"
},
"zip": {
"type": "number",
"description": "Home's postal zip code"
},
"timezone": {
"type": "string",
"description": "Home's timezone"
},
"apartment": {
"type": "string",
"description": "Home's apartment number"
},
"homephones": {
"type": "string",
"description": "562-6305 (string,fixed) - Home's phone number"
},
"homephoneids": {
"type": "number",
"description": "Unique identifier for home phone"
},
"locationid": {
"type": "number",
"description": "Unique identifier for home's location"
},
"locationname": {
"type": "string",
"description": "Location's name"
},
"hometype": {
"type": "number",
"description": "Whether or not the home is an apartment (0: house, 1: apartment)"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}HomeGET/homes/{id}
Retrieves information about a single home using its id.
- id
integer(required) Example: 277The id of the home
Home Inventory ¶
You can use this url to get information on a specific home’s inventory history using the home’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonHeaders
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Home InventoryGET/homes/{id}/inventory
Retrieves inventory history for items that have been assigned to the given home at one point.
- id
integer(required) Example: 277The id of the home
Inactive Home Inventory ¶
You can use this url to get information on the periods in time when an item was both inactive and in a specific home using the home’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonHeaders
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Inactive Home InventoryGET/homes/{id}/inventory/inactive
Retrieves periods when an item has been marked inactive while in the given home.
- id
integer(required) Example: 277The id of the home
Home Alerts ¶
You can use this url to get information on alerts related to specific home using the home’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"homeid": 169,
"alerttypeid": 15,
"alerttypename": "MedTracker",
"alertmessage": "MT0034 : The medtracker has not reported in"
}Schema
{
"type": "object",
"properties": {
"homeid": {
"type": "number",
"description": "Unique identifier for home"
},
"alerttypeid": {
"type": "number",
"description": "Unique identifier for alert type"
},
"alerttypename": {
"type": "string",
"description": "Name of alert type"
},
"alertmessage": {
"type": "string",
"description": "Alert message body"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Home AlertsGET/homes/{id}/alerts/
Retrieves information on alerts for a specific home.
- id
integer(required) Example: 277The id of the home
Home Issues ¶
You can use this url to get information on issues related to a specific home using the home’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"homeid": 169,
"issueid": 15,
"issuestateid": 3,
"issuestatename": "Closed",
"issuesubstateid": 0,
"issuesubstatename": "Closed",
"issuetypeid": 5,
"issuetypename": "Sensors",
"issuesubtypeid": 1,
"issuesubtypename": "Fell down",
"issuecreated": 1397043008,
"issuescheduled": 0,
"issuelastchangeid": 19906,
"issuelastchange": 1397470528,
"issuecomment": "usb was partially unplugged",
"issuecreatedbyuserid": 145,
"issuecreatedbyname": "Jane Doe",
"issuechangebyuserid": 145,
"issuechangebyname": "Jane Doe",
"issueassignedtoid": 145,
"issueassignedtoname": "Jane Doe",
"issuesourceid": 1,
"issuesourcename": "EMail",
"issuetrackinguserids": "4,153",
"issuetrackingusernames": "Jane Doe,John Smith",
"issueresolutionid": 2,
"issueresolutionname": "Fixed",
"issueresolutionpermanent": 0,
"homephones": "503"
}Schema
{
"type": "object",
"properties": {
"homeid": {
"type": "number",
"description": "Unique identifier for home"
},
"issueid": {
"type": "number",
"description": "Unique identifier for issue"
},
"issuestateid": {
"type": "number",
"description": "Unique identifier for issue state"
},
"issuestatename": {
"type": "string",
"description": "Name of issue state"
},
"issuesubstateid": {
"type": "number",
"description": "Unique identifier for issue substate"
},
"issuesubstatename": {
"type": "string",
"description": "Issue substate name"
},
"issuetypeid": {
"type": "number",
"description": "Unique identifier for issue type"
},
"issuetypename": {
"type": "string",
"description": "Name for issue type"
},
"issuesubtypeid": {
"type": "number",
"description": "Unique identifier for issue subtype"
},
"issuesubtypename": {
"type": "string",
"description": "Name of issue subtype"
},
"issuecreated": {
"type": "number",
"description": "Date & time issue was created"
},
"issuescheduled": {
"type": "number",
"description": "Date & time issue is scheduled to be resolved (null indicates the issue was not scheduled)"
},
"issuelastchangeid": {
"type": "number",
"description": "Unique identifier for last time issue state changed"
},
"issuelastchange": {
"type": "number",
"description": "Date & time issue last changed"
},
"issuecomment": {
"type": "string",
"description": "User created comment about issue resolution"
},
"issuecreatedbyuserid": {
"type": "number",
"description": "Unique identifier for user that created the issue"
},
"issuecreatedbyname": {
"type": "string",
"description": "Name of user that created issue"
},
"issuechangebyuserid": {
"type": "number",
"description": "Unique identifier for user that changed issue"
},
"issuechangebyname": {
"type": "string",
"description": "Name for user that changed issue"
},
"issueassignedtoid": {
"type": "number",
"description": "Unique identifier for user assigned to issue"
},
"issueassignedtoname": {
"type": "string",
"description": "Name of user assigned to issue"
},
"issuesourceid": {
"type": "number",
"description": "Unique identifier for source of issue"
},
"issuesourcename": {
"type": "string",
"description": "Name of source of issue"
},
"issuetrackinguserids": {
"type": "string",
"description": "List of unique identifiers for users tracking the issue"
},
"issuetrackingusernames": {
"type": "string",
"description": "List of names of users tracking the issue"
},
"issueresolutionid": {
"type": "number",
"description": "Unique identifier for issue resolution"
},
"issueresolutionname": {
"type": "string",
"description": "Name of issue resolution"
},
"issueresolutionpermanent": {
"type": "number",
"description": "Whether or not the issue resolution is permanent (0: no, 1: yes)"
},
"homephones": {
"type": "string",
"description": "652-6586 (string,fixed) - Phone number for home"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Home IssuesGET/homes/{id}/issues/
Retrieves information on issues for a specific home.
- id
integer(required) Example: 277The id of the home
Residents ¶
You can use this url to get information on residents in a specific home using the home’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"homeid": 169,
"residentid": "blah",
"residentname": "John Smith",
"oadc": "11069",
"residenttypeid": "1",
"residenttypename": "Research Subject",
"start": 1161043200,
"stop": 1396224000
}Schema
{
"type": "object",
"properties": {
"homeid": {
"type": "number",
"description": "Unique identifier for home"
},
"residentid": {
"type": "string",
"description": "Unique identifier for resident"
},
"residentname": {
"type": "string",
"description": "Name of resident"
},
"oadc": {
"type": "string",
"description": "Unique identifier for resident in external database"
},
"residenttypeid": {
"type": "string",
"description": "Either 1 or -1 (1: Not Tracked, -1: Research Subject)"
},
"residenttypename": {
"type": "string",
"description": "Name of resident type"
},
"start": {
"type": "number",
"description": "Date & time resident moved in"
},
"stop": {
"type": "number",
"description": "Date & time resident moved out"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}ResidentsGET/homes/{id}/residents/
Retrieves information on residents in the home. This will contain both subjects and residents; people who are not being tracked but we need to know they live in the home.
- id
integer(required) Example: 277The id of the home
Phones ¶
You can use this url to get information on phones in a specific home using the home’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"homeid": 1117,
"phoneid": 746,
"phone": "503"
}Schema
{
"type": "object",
"properties": {
"homeid": {
"type": "number",
"description": "Unique identifier for home"
},
"phoneid": {
"type": "number",
"description": "Unique identifier for phone"
},
"phone": {
"type": "string",
"description": "652-3302 (string,fixed) - Resident's phone number"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}PhonesGET/homes/{id}/phones/
Retrieves information on landlines in the home.
- id
integer(required) Example: 277The id of the home
Issues ¶
The following endpoints are for collecting information about issues. Issues are documented problems used to track technical difficulties and how & when they are resolved.
Issues ¶
You can use this url to get information on all documented issues.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}IssuesGET/issues/
Retrieves information about all documented issues.
Issue ¶
You can use this url to get information on a specific documented issue using the issue’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"issueid": 8402,
"issuename": "Sensors falling",
"issuestateid": 6,
"issuestatename": "Resolved",
"issuesubstateid": 2,
"issuesubstatename": "Fixed",
"issuetypeid": 2,
"issuetypename": "Internet",
"issuesubtypeid": 3,
"issuesubtypename": "Other",
"homeid": 1157,
"issuecreated": 1426464000,
"issuescheduled": 0,
"issuelastchangeid": 32113,
"issuelastchange": 1426464000,
"issuecomment": "Reinstalled platform after moving apartments.",
"issuecreatedbyuserid": 248,
"issuecreatedbyname": 0,
"issuechangebyuserid": 248,
"issuechangebyname": 0,
"issueassignedtoid": 248,
"issueassignedtoname": 0,
"issuesourceid": 4,
"issuesourcename": "Usage",
"issuetrackinguserids": "4,153",
"issuetrackingusernames": "John Doe, Jane Smith",
"issueresolutionid": 2,
"issueresolutionpermanent": 0,
"subjectids": 991
}Schema
{
"type": "object",
"properties": {
"issueid": {
"type": "number",
"description": "Unique identifier for issue"
},
"issuename": {
"type": "string",
"description": "Name of issue"
},
"issuestateid": {
"type": "number",
"description": "Unique identifier for issue's state"
},
"issuestatename": {
"type": "string",
"description": "Issue's state (Assigned, Resolved, or Updated)"
},
"issuesubstateid": {
"type": "number",
"description": "Unique identifier for issue's substate"
},
"issuesubstatename": {
"type": "string",
"description": "Issue's substate (2: Fixed, 3: Won't Fix)"
},
"issuetypeid": {
"type": "number",
"description": "Unique identifier for issue's type"
},
"issuetypename": {
"type": "string",
"description": "Issue's type (1: Software, 2: Internet, 3: SensorPC, 4: UserPC, 5: Sensors, 6: Other, 7: Install, 8: Router, 9: Ekahau, 10: Database, 11: Known Outage, 12: Coaching)"
},
"issuesubtypeid": {
"type": "number",
"description": "Unique identifier for issue's subtype"
},
"issuesubtypename": {
"type": "string",
"description": "(2: Swap, 3: Other);"
},
"homeid": {
"type": "number",
"description": "Unique identifier for issue's corresponding house"
},
"issuecreated": {
"type": "number",
"description": "Date when issue was created as a unix timestamp"
},
"issuescheduled": {
"type": "number",
"description": "Date when issue was scheduled as a unix timestamp (null indicates issue was never scheduled)"
},
"issuelastchangeid": {
"type": "number",
"description": "Unique identifier for when issue was last changed"
},
"issuelastchange": {
"type": "number",
"description": "Date when issue was last changed as a unix timestamp"
},
"issuecomment": {
"type": "string",
"description": "Comment made about the issue written by the person that the issue resolution was assigned to"
},
"issuecreatedbyuserid": {
"type": "number",
"description": "Unique identifier for user that created the issue"
},
"issuecreatedbyname": {
"type": "number",
"description": "User tha tcreated the issue"
},
"issuechangebyuserid": {
"type": "number",
"description": "Unique identifier for user that changed the issue"
},
"issuechangebyname": {
"type": "number",
"description": "User that changed the issue"
},
"issueassignedtoid": {
"type": "number",
"description": "Unique identifier for user that was assigned the issue"
},
"issueassignedtoname": {
"type": "number",
"description": "User that the issue was assigned to"
},
"issuesourceid": {
"type": "number",
"description": "Unique identifier for the source of the issue (1: EMail, 3: Other, 4: Usage)"
},
"issuesourcename": {
"type": "string",
"description": "Source of the issue"
},
"issuetrackinguserids": {
"type": "string",
"description": "Unique identifiers for users tracking the issues"
},
"issuetrackingusernames": {
"type": "string",
"description": "Users tracking the issue"
},
"issueresolutionid": {
"type": "number",
"description": "Unique identifier for resolution id"
},
"issueresolutionpermanent": {
"type": "number",
"description": "Whether or not the resolution for the issue is permanent (0: not permanent, 1: permanent)"
},
"subjectids": {
"type": "number",
"description": "Unique identifiers of subjects related to issue"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}IssueGET/issues/{id}
Retrieves information about a single issue using its id.
- id
integer(required) Example: 277The id of the issue
Projects ¶
The following endpoints are for collecting information about projects.
Projects ¶
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
Headers
ContentType: application/jsonBody
[
{
"projectid": 5,
"projectname": "Sandbox",
"projectdesc": "Test Project",
"active": 1,
"enrolling": 1,
"homestotalcount": 61,
"homesenrolledcount": 32,
"subjectstotalcount": 86,
"subjectsenrolledcount": 58,
"subjectsmalecount": 40,
"subjectsfemalecount": 46,
"subjectsdeceasedcount": 6,
"subjectsage": 39.013,
"equipmentrequiredcount": 2,
"homesmissingequipment": 31
}
]Schema
{
"type": "array",
"items": {
"type": "object",
"properties": {
"projectid": {
"type": "number",
"description": "Unique identifier for project"
},
"projectname": {
"type": "string",
"description": "Name of project"
},
"projectdesc": {
"type": "string",
"description": "Project description"
},
"active": {
"type": "number",
"description": "Whether or not the project is active (0: inactive, 1: active)"
},
"enrolling": {
"type": "number",
"description": "Whether or not the project is enrolling (0: inactive, 1: active)"
},
"homestotalcount": {
"type": "number",
"description": "Total number of homes in project"
},
"homesenrolledcount": {
"type": "number",
"description": "Total number of homes currently enrolled in project"
},
"subjectstotalcount": {
"type": "number",
"description": "Total number of subjects in project"
},
"subjectsenrolledcount": {
"type": "number",
"description": "Total number of subjects currently enrolled in project"
},
"subjectsmalecount": {
"type": "number",
"description": "Total number of male subjects in project"
},
"subjectsfemalecount": {
"type": "number",
"description": "Total number of female subjects in project"
},
"subjectsdeceasedcount": {
"type": "number",
"description": "Total number of deceased subjects in project"
},
"subjectsage": {
"type": "number",
"description": "Average age of subject's in project"
},
"equipmentrequiredcount": {
"type": "number",
"description": "Total number of equipment pieces needed for project"
},
"homesmissingequipment": {
"type": "number",
"description": "Total number of homes in project missing equipment"
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}ProjectsGET/projects/
Retrieves information about all projects.
Project ¶
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"homeid": 14,
"address": "12705 SE River Rd.",
"cityname": "Portland",
"cityid": 1,
"citystatename": "Oregon",
"citystateid": 38,
"citystateabbr": "OR",
"countryname": "United States",
"countryabbr": "US",
"countryid": 1,
"zip": 97222,
"timezone": "America/Los Angeles",
"apartment": "509A",
"homephones": "503",
"homephoneids": 1,
"locationid": 4,
"locationname": "Willamette View",
"hometype": 0
}Schema
{
"type": "object",
"properties": {
"homeid": {
"type": "number",
"description": "Unique identifier for home"
},
"address": {
"type": "string",
"description": "Home's address"
},
"cityname": {
"type": "string",
"description": "Home's city"
},
"cityid": {
"type": "number",
"description": "Unique identifier for home's city"
},
"citystatename": {
"type": "string",
"description": "Home's state name"
},
"citystateid": {
"type": "number",
"description": "Unique identifier for home's state name"
},
"citystateabbr": {
"type": "string",
"description": "Home's state abbreviation"
},
"countryname": {
"type": "string",
"description": "Home's country"
},
"countryabbr": {
"type": "string",
"description": "Home's country abbreviation"
},
"countryid": {
"type": "number",
"description": "Subject's gender"
},
"zip": {
"type": "number",
"description": "Home's postal zip code"
},
"timezone": {
"type": "string",
"description": "Home's timezone"
},
"apartment": {
"type": "string",
"description": "Home's apartment number"
},
"homephones": {
"type": "string",
"description": "562-6305 (string,fixed) - Home's phone number"
},
"homephoneids": {
"type": "number",
"description": "Unique identifier for home phone"
},
"locationid": {
"type": "number",
"description": "Unique identifier for home's location"
},
"locationname": {
"type": "string",
"description": "Location's name"
},
"hometype": {
"type": "number",
"description": "Whether or not the home is an apartment (0: house, 1: apartment)"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}ProjectGET/projects/{id}
Retrieves information about a single project using its id.
- id
integer(required) Example: 277The id of the project
Project Enrollment ¶
You can use this url to get information on a specific project’s current enrollment using the project’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"subjectid": 277,
"projectid": 13,
"homeid": 11,
"projectname": "Life Lab",
"statename": "Available",
"stateid": 0,
"start": 1362614400,
"stop": 1362618000
}Schema
{
"type": "object",
"properties": {
"subjectid": {
"type": "number",
"description": "Unique identifier for subject enrolled in project"
},
"projectid": {
"type": "number",
"description": "Unique identifier for project"
},
"homeid": {
"type": "number",
"description": "Unique identifier for home enrolled in project"
},
"projectname": {
"type": "string",
"description": "Name of project"
},
"statename": {
"type": "string",
"description": "Name of enrollment state"
},
"stateid": {
"type": "number",
"description": "Unique identifier for enrollment state"
},
"start": {
"type": "number",
"description": "Date of subject's enrollment start in study as a unix timestamp"
},
"stop": {
"type": "number",
"description": "Date of subject's enrollment stop in study as a unix timestamp"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Project EnrollmentGET/projects/enrollment
Retrieves information about a project’s current enrollment.
- id
integer(required) Example: 277The id of the project
Project Equipment ¶
You can use this url to get information on a specific project’s equipment using the project’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"projectid": 5,
"homesinstalled": 8,
"Attributes": {
"equipmentid": 15,
"typeid": 1,
"typename": "Computers",
"subtypeid": 37,
"subtypename": "Plug",
"start": 1362614400,
"stop": 1362618000
}
}Schema
{
"type": "object",
"properties": {
"projectid": {
"type": "number",
"description": "Unique identifier for project"
},
"homesinstalled": {
"type": "number",
"description": "Number of homes equipment is installed in"
},
"Attributes": {
"type": "object",
"properties": {
"equipmentid": {
"type": "number",
"description": "Unique identifier for equipment"
},
"typeid": {
"type": "number",
"description": "Unique identifier for equiptment type"
},
"typename": {
"type": "string",
"description": "Name of equipment type"
},
"subtypeid": {
"type": "number",
"description": "Unique identifier for equipment subtype"
},
"subtypename": {
"type": "string",
"description": "Name of equipment subtype"
},
"start": {
"type": "number",
"description": "Start date of equipment being assigned to project or study as a unix timestamp"
},
"stop": {
"type": "number",
"description": "Date when equipment was unassigned from project or study as a unix timestamp"
}
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Project EquipmentGET/projects/equipment
Retrieves information about a project’s equipment.
- id
integer(required) Example: 277The id of the project
Project Scheduled Contacts ¶
You can use this url to get information on a specific project’s scheduled contacts using the project’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"projectid": 13,
"schedcontacttypename": "Clinician Visit",
"increment": 12,
"unitname": "Month",
"unitid": 2,
"offset": 6
}Schema
{
"type": "object",
"properties": {
"projectid": {
"type": "number",
"description": "Unique identifier for project"
},
"schedcontacttypename": {
"type": "string",
"description": "Unique identifier for home enrolled in project"
},
"increment": {
"type": "number",
"description": "How many units between each contact"
},
"unitname": {
"type": "string",
"description": "Name of unit"
},
"unitid": {
"type": "number",
"description": "Unique Identifier for unit"
},
"offset": {
"type": "number",
"description": "How long after enrollment before the first contact (measured in units displayed above)"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Project Scheduled ContactsGET/projects/scheduled/contacts
Retrieves information about a project’s scheduled contacts.
- id
integer(required) Example: 277The id of the project
Project Studies ¶
You can use this url to get information on studies belonging to a specific project using the project’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"projectid": 13,
"Attributes": {
"studyid": 1,
"studyname": 11,
"studyinvestigator": "Jane Doe",
"studyirb": 2932,
"studycriteria": "Primary Driver of a personal vehicle MCI or Non",
"studysummary": "Participants will test out some new pilot questions for our Weekly Health Form.",
"studystart": 1362614400,
"studystop": 1362618000,
"studystatusid": 3,
"studystatusname": 0,
"studyadmin": 1,
"projectids": "13,16",
"projectnames": "Life Lab, Layton Center",
"studyremovedsubjectcount": 4,
"studyineligiblesubjectcount": 0,
"studyrefusedsubjectcount": 3,
"studywithdrawnsubjectcount": 2,
"studyavailablesubjectcount": 0,
"studytobedconsentedsubjectcount": 4,
"studytocontactsubjectcount": 5,
"studycompletedsubjectcount": 12,
"studyconsentedsubjectcount": 20
}
}Schema
{
"type": "object",
"properties": {
"projectid": {
"type": "number",
"description": "Unique identifier for project"
},
"Attributes": {
"type": "object",
"properties": {
"studyid": {
"type": "number",
"description": "Unique identifier for study belonging to project"
},
"studyname": {
"type": "number",
"description": "Unique identifier for home enrolled in project"
},
"studyinvestigator": {
"type": "string",
"description": "Study investigator"
},
"studyirb": {
"type": "number",
"description": "Unique identifier for IRB"
},
"studycriteria": {
"type": "string",
"description": "MCI (string,fixed) - Criteria that subjects must meet to enroll in study"
},
"studysummary": {
"type": "string",
"description": "Short description of study"
},
"studystart": {
"type": "number",
"description": "Date of enrollment start as a unix timestamp"
},
"studystop": {
"type": "number",
"description": "End date of the study as a unix timestamp"
},
"studystatusid": {
"type": "number",
"description": "Unique identifier for study status (1: active, 2: enrolling, 3: completed)"
},
"studystatusname": {
"type": "number",
"description": "Name of study status"
},
"studyadmin": {
"type": "number",
"description": "Whether or not there is a study admin (0: no, 1: yes)"
},
"projectids": {
"type": "string",
"description": "Unique identifiers of projects that the study belongs to"
},
"projectnames": {
"type": "string",
"description": "Names of projects that the study belongs to"
},
"studyremovedsubjectcount": {
"type": "number",
"description": "Number of subjects removed from study"
},
"studyineligiblesubjectcount": {
"type": "number",
"description": "Number of subjects that did not meet the criteria to enroll in the study"
},
"studyrefusedsubjectcount": {
"type": "number",
"description": "Number of subjects that were refused from enrollment"
},
"studywithdrawnsubjectcount": {
"type": "number",
"description": "Number of subjects that withdrew from the study"
},
"studyavailablesubjectcount": {
"type": "number",
"description": "Number of subjects available in study"
},
"studytobedconsentedsubjectcount": {
"type": "number",
"description": "Number of subjects to be dconsented for study"
},
"studytocontactsubjectcount": {
"type": "number",
"description": "Number of subjects study plans on contacting"
},
"studycompletedsubjectcount": {
"type": "number",
"description": "Number of subjects to have completed the study"
},
"studyconsentedsubjectcount": {
"type": "number",
"description": "Number of subjects consented for the study"
}
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Project StudiesGET/projects/studies
Retrieves information about a studies belonging to a specific project.
- id
integer(required) Example: 277The id of the project
Project Users ¶
You can use this url to get information on a specific project’s users using the project’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"userid": 4,
"username": "John Smith",
"loginid": "jsmith",
"projectid": 277,
"roleid": 4,
"roledescription": "Tech RAs",
"rolename": "Tech RAs",
"email": "jsmith@ohsu.edu",
"readonlyuser": 0
}Schema
{
"type": "object",
"properties": {
"userid": {
"type": "number",
"description": "Unique identifier for user"
},
"username": {
"type": "string",
"description": "User name of user"
},
"loginid": {
"type": "string",
"description": "Login username of user"
},
"projectid": {
"type": "number",
"description": "Unique identifier for project"
},
"roleid": {
"type": "number",
"description": "Unique identifier for role"
},
"roledescription": {
"type": "string",
"description": "Role description"
},
"rolename": {
"type": "string",
"description": "Name of role"
},
"email": {
"type": "string",
"description": "Email of user"
},
"readonlyuser": {
"type": "number",
"description": "Whether or not the user is read only (0: read-write, 1: read-only)"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Project UsersGET/projects/users/
Retrieves information about a project’s users.
- id
integer(required) Example: 277The id of the project
Studies ¶
The following endpoints are for collecting information about studies.
Studies ¶
You can use this url to get information on all studies.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
Headers
ContentType: application/jsonBody
[
{
"studyid": 1,
"studyname": 11,
"studyinvestigator": "Jane Doe",
"studyirb": 2932,
"studycriteria": "Primary Driver of a personal vehicle MCI or Non",
"studysummary": "Participants will test out some new pilot questions for our Weekly Health Form.",
"studystart": 1362614400,
"studystop": 1362618000,
"studystatusid": 3,
"studystatusname": 0,
"studyadmin": 1,
"projectids": "13,16",
"projectnames": "Life Lab, Layton Center",
"studyremovedsubjectcount": 4,
"studyineligiblesubjectcount": 0,
"studyrefusedsubjectcount": 3,
"studywithdrawnsubjectcount": 2,
"studyavailablesubjectcount": 0,
"studytobedconsentedsubjectcount": 4,
"studytocontactsubjectcount": 5,
"studycompletedsubjectcount": 12,
"studyconsentedsubjectcount": 20
}
]Schema
{
"type": "array",
"items": {
"type": "object",
"properties": {
"studyid": {
"type": "number",
"description": "Unique identifier for study belonging to project"
},
"studyname": {
"type": "number",
"description": "Unique identifier for home enrolled in project"
},
"studyinvestigator": {
"type": "string",
"description": "Study investigator"
},
"studyirb": {
"type": "number",
"description": "Unique identifier for IRB"
},
"studycriteria": {
"type": "string",
"description": "MCI (string,fixed) - Criteria that subjects must meet to enroll in study"
},
"studysummary": {
"type": "string",
"description": "Short description of study"
},
"studystart": {
"type": "number",
"description": "Date of enrollment start as a unix timestamp"
},
"studystop": {
"type": "number",
"description": "End date of the study as a unix timestamp"
},
"studystatusid": {
"type": "number",
"description": "Unique identifier for study status (1: active, 2: enrolling, 3: completed)"
},
"studystatusname": {
"type": "number",
"description": "Name of study status"
},
"studyadmin": {
"type": "number",
"description": "Whether or not there is a study admin (0: no, 1: yes)"
},
"projectids": {
"type": "string",
"description": "Unique identifiers of projects that the study belongs to"
},
"projectnames": {
"type": "string",
"description": "Names of projects that the study belongs to"
},
"studyremovedsubjectcount": {
"type": "number",
"description": "Number of subjects removed from study"
},
"studyineligiblesubjectcount": {
"type": "number",
"description": "Number of subjects that did not meet the criteria to enroll in the study"
},
"studyrefusedsubjectcount": {
"type": "number",
"description": "Number of subjects that were refused from enrollment"
},
"studywithdrawnsubjectcount": {
"type": "number",
"description": "Number of subjects that withdrew from the study"
},
"studyavailablesubjectcount": {
"type": "number",
"description": "Number of subjects available in study"
},
"studytobedconsentedsubjectcount": {
"type": "number",
"description": "Number of subjects to be dconsented for study"
},
"studytocontactsubjectcount": {
"type": "number",
"description": "Number of subjects study plans on contacting"
},
"studycompletedsubjectcount": {
"type": "number",
"description": "Number of subjects to have completed the study"
},
"studyconsentedsubjectcount": {
"type": "number",
"description": "Number of subjects consented for the study"
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}StudiesGET/studies/
Retrieves information about all studies.
Study ¶
You can use this url to get information about a specific study using its id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"studyid": 1,
"studyname": 11,
"studyinvestigator": "Jane Doe",
"studyirb": 2932,
"studycriteria": "Primary Driver of a personal vehicle MCI or Non",
"studysummary": "Participants will test out some new pilot questions for our Weekly Health Form.",
"studystart": 1362614400,
"studystop": 1362618000,
"studystatusid": 3,
"studystatusname": 0,
"studyadmin": 1,
"projectids": "13,16",
"projectnames": "Life Lab, Layton Center",
"studyremovedsubjectcount": 4,
"studyineligiblesubjectcount": 0,
"studyrefusedsubjectcount": 3,
"studywithdrawnsubjectcount": 2,
"studyavailablesubjectcount": 0,
"studytobedconsentedsubjectcount": 4,
"studytocontactsubjectcount": 5,
"studycompletedsubjectcount": 12,
"studyconsentedsubjectcount": 20
}Schema
{
"type": "object",
"properties": {
"studyid": {
"type": "number",
"description": "Unique identifier for study belonging to project"
},
"studyname": {
"type": "number",
"description": "Unique identifier for home enrolled in project"
},
"studyinvestigator": {
"type": "string",
"description": "Study investigator"
},
"studyirb": {
"type": "number",
"description": "Unique identifier for IRB"
},
"studycriteria": {
"type": "string",
"description": "MCI (string,fixed) - Criteria that subjects must meet to enroll in study"
},
"studysummary": {
"type": "string",
"description": "Short description of study"
},
"studystart": {
"type": "number",
"description": "Date of enrollment start as a unix timestamp"
},
"studystop": {
"type": "number",
"description": "End date of the study as a unix timestamp"
},
"studystatusid": {
"type": "number",
"description": "Unique identifier for study status (1: active, 2: enrolling, 3: completed)"
},
"studystatusname": {
"type": "number",
"description": "Name of study status"
},
"studyadmin": {
"type": "number",
"description": "Whether or not there is a study admin (0: no, 1: yes)"
},
"projectids": {
"type": "string",
"description": "Unique identifiers of projects that the study belongs to"
},
"projectnames": {
"type": "string",
"description": "Names of projects that the study belongs to"
},
"studyremovedsubjectcount": {
"type": "number",
"description": "Number of subjects removed from study"
},
"studyineligiblesubjectcount": {
"type": "number",
"description": "Number of subjects that did not meet the criteria to enroll in the study"
},
"studyrefusedsubjectcount": {
"type": "number",
"description": "Number of subjects that were refused from enrollment"
},
"studywithdrawnsubjectcount": {
"type": "number",
"description": "Number of subjects that withdrew from the study"
},
"studyavailablesubjectcount": {
"type": "number",
"description": "Number of subjects available in study"
},
"studytobedconsentedsubjectcount": {
"type": "number",
"description": "Number of subjects to be dconsented for study"
},
"studytocontactsubjectcount": {
"type": "number",
"description": "Number of subjects study plans on contacting"
},
"studycompletedsubjectcount": {
"type": "number",
"description": "Number of subjects to have completed the study"
},
"studyconsentedsubjectcount": {
"type": "number",
"description": "Number of subjects consented for the study"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}StudyGET/studies/{id}
Retrieves information about a single study using its id.
- id
integer(required) Example: 277The id of the subject
Study Comments ¶
You can use this url to get all of a study’s comments.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"commentid": 1275,
"commentdate": 1430092800,
"commenttext": "unable to install tracking software.",
"commentbyid": 172,
"commentbyname": "John Smith"
}Schema
{
"type": "object",
"properties": {
"commentid": {
"type": "number",
"description": "Unique identifier for comment"
},
"commentdate": {
"type": "number",
"description": "Date that comment was made as a unix timestmap in seconds"
},
"commenttext": {
"type": "string",
"description": "Comment body"
},
"commentbyid": {
"type": "number",
"description": "Unique identifier for the user that made the comment"
},
"commentbyname": {
"type": "string",
"description": "Name of the user that made the comment"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Study CommentsGET/studies/{id}/comments
Retrieves information about a study’s comments using its id.
- id
integer(required) Example: 277The id of the subject
Study Enrollment ¶
You can use this url to get information on a specific study’s enrollment using the study’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"subjectid": 277,
"projectid": 13,
"homeid": 11,
"projectname": "Life Lab",
"statename": "Available",
"stateid": 0,
"start": 1362614400,
"stop": 1362618000
}Schema
{
"type": "object",
"properties": {
"subjectid": {
"type": "number",
"description": "Unique identifier for subject enrolled in project"
},
"projectid": {
"type": "number",
"description": "Unique identifier for project"
},
"homeid": {
"type": "number",
"description": "Unique identifier for home enrolled in project"
},
"projectname": {
"type": "string",
"description": "Name of project"
},
"statename": {
"type": "string",
"description": "Name of enrollment state"
},
"stateid": {
"type": "number",
"description": "Unique identifier for enrollment state"
},
"start": {
"type": "number",
"description": "Date of subject's enrollment start in study as a unix timestamp"
},
"stop": {
"type": "number",
"description": "Date of subject's enrollment stop in study as a unix timestamp"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Study EnrollmentGET/studies/{id}/enrollment
Retrieves information about a subject’s enrollment in a study using the study’s id.
- id
integer(required) Example: 277The id of the subject
Study Equipment ¶
You can use this url to get information about a specific study’s equipment using the study’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"studyid": 25,
"subjectsinstalled": 31,
"Attributes": {
"equipmentid": 15,
"typeid": 1,
"typename": "Computers",
"subtypeid": 37,
"subtypename": "Plug",
"start": 1362614400,
"stop": 1362618000
}
}Schema
{
"type": "object",
"properties": {
"studyid": {
"type": "number",
"description": "Unique identifier for study"
},
"subjectsinstalled": {
"type": "number",
"description": "Number of subjects with equipment installed"
},
"Attributes": {
"type": "object",
"properties": {
"equipmentid": {
"type": "number",
"description": "Unique identifier for equipment"
},
"typeid": {
"type": "number",
"description": "Unique identifier for equiptment type"
},
"typename": {
"type": "string",
"description": "Name of equipment type"
},
"subtypeid": {
"type": "number",
"description": "Unique identifier for equipment subtype"
},
"subtypename": {
"type": "string",
"description": "Name of equipment subtype"
},
"start": {
"type": "number",
"description": "Start date of equipment being assigned to project or study as a unix timestamp"
},
"stop": {
"type": "number",
"description": "Date when equipment was unassigned from project or study as a unix timestamp"
}
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Study EquipmentGET/studies/{id}/equipment
Retrieves information about a study’s equipment using the study’s id.
- id
integer(required) Example: 277The id of the subject
Study Installed Equipment ¶
You can use this url to get information about a specific study’s installed equipment using the study’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"studyid": 25,
"subjectid": 31,
"itemcount": 2,
"Attributes": {
"equipmentid": 15,
"typeid": 1,
"typename": "Computers",
"subtypeid": 37,
"subtypename": "Plug",
"start": 1362614400,
"stop": 1362618000
}
}Schema
{
"type": "object",
"properties": {
"studyid": {
"type": "number",
"description": "Unique identifier for study"
},
"subjectid": {
"type": "number",
"description": "Unique identifier for subject with assigned equipment"
},
"itemcount": {
"type": "number",
"description": "Number of items assigned to subject"
},
"Attributes": {
"type": "object",
"properties": {
"equipmentid": {
"type": "number",
"description": "Unique identifier for equipment"
},
"typeid": {
"type": "number",
"description": "Unique identifier for equiptment type"
},
"typename": {
"type": "string",
"description": "Name of equipment type"
},
"subtypeid": {
"type": "number",
"description": "Unique identifier for equipment subtype"
},
"subtypename": {
"type": "string",
"description": "Name of equipment subtype"
},
"start": {
"type": "number",
"description": "Start date of equipment being assigned to project or study as a unix timestamp"
},
"stop": {
"type": "number",
"description": "Date when equipment was unassigned from project or study as a unix timestamp"
}
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Study Installed EquipmentGET/studies/{id}/equipment/installed
Retrieves information about a study’s installed equipment using the study’s id.
- id
integer(required) Example: 277The id of the subject
Study Missing Equipment ¶
Retrieves information about a study’s missing equipment using the study’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"studyid": 25,
"subjectid": 31,
"Attributes": {
"equipmentid": 15,
"typeid": 1,
"typename": "Computers",
"subtypeid": 37,
"subtypename": "Plug",
"start": 1362614400,
"stop": 1362618000
}
}Schema
{
"type": "object",
"properties": {
"studyid": {
"type": "number",
"description": "Unique identifier for study"
},
"subjectid": {
"type": "number",
"description": "Unique identifier for subject with assigned equipment"
},
"Attributes": {
"type": "object",
"properties": {
"equipmentid": {
"type": "number",
"description": "Unique identifier for equipment"
},
"typeid": {
"type": "number",
"description": "Unique identifier for equiptment type"
},
"typename": {
"type": "string",
"description": "Name of equipment type"
},
"subtypeid": {
"type": "number",
"description": "Unique identifier for equipment subtype"
},
"subtypename": {
"type": "string",
"description": "Name of equipment subtype"
},
"start": {
"type": "number",
"description": "Start date of equipment being assigned to project or study as a unix timestamp"
},
"stop": {
"type": "number",
"description": "Date when equipment was unassigned from project or study as a unix timestamp"
}
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Study Missing EquipmentGET/studies/{id}/equipment/missing
Retrieves information about a study’s missing equipment using the study’s id.
- id
integer(required) Example: 277The id of the subject
Study Scheduled Contacts ¶
You can use this url to determine the different types of scheduled contacts for a specific study using the study’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"projectid": 13,
"schedcontacttypename": "Clinician Visit",
"increment": 12,
"unitname": "Month",
"unitid": 2,
"offset": 6
}Schema
{
"type": "object",
"properties": {
"projectid": {
"type": "number",
"description": "Unique identifier for project"
},
"schedcontacttypename": {
"type": "string",
"description": "Unique identifier for home enrolled in project"
},
"increment": {
"type": "number",
"description": "How many units between each contact"
},
"unitname": {
"type": "string",
"description": "Name of unit"
},
"unitid": {
"type": "number",
"description": "Unique Identifier for unit"
},
"offset": {
"type": "number",
"description": "How long after enrollment before the first contact (measured in units displayed above)"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Study Scheduled ContactsGET/studies/{id}/scheduledcontacttypes
Retrieves information about a study’s different types of scheduled contacts.
- id
integer(required) Example: 277The id of the subject
Study Subjects ¶
You can use this url to get information on a specific study’s subjects using the study’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"subjectid": 315,
"subjectname": "Jane Doe",
"titleid": 1,
"titlename": "Mrs.",
"lname": "Doe",
"fname": "Jane",
"oadc": 10002,
"email": "janedoe24@hotmail.com",
"genderid": false,
"gendername": "Female",
"dob": 1423958400,
"dod": 1426464000
}Schema
{
"type": "object",
"properties": {
"subjectid": {
"type": "number",
"description": "Unique ORCATECH database identifier"
},
"subjectname": {
"type": "string",
"description": "Name of subject"
},
"titleid": {
"type": "number",
"description": "Unique identifier for subject's title (0: Mr, 1: Mrs, 3: Miss, 4:Dr, 4:Ms)"
},
"titlename": {
"type": "string",
"description": "Subject's title"
},
"lname": {
"type": "string",
"description": "Subject's last name"
},
"fname": {
"type": "string",
"description": "Subject's first name"
},
"oadc": {
"type": "number",
"description": "Unique identifier for external database"
},
"email": {
"type": "string",
"description": "Subject's email"
},
"genderid": {
"type": "boolean",
"description": "Subject's gender code - 0 for female, 1 for male"
},
"gendername": {
"type": "string",
"description": "Subject's gender"
},
"dob": {
"type": "number",
"description": "Subject's date of birth"
},
"dod": {
"type": "number",
"description": "Subject's date of death"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Study SubjectsGET/studies/{id}/subjects
Retrieves information about the subjects enrolled in a specific study.
- id
integer(required) Example: 277The id of the subject
Available Study Subjects ¶
You can use this url to get information on a available subjects in a specific study using the study’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"studyid": 25,
"Attributes": {
"subjectid": 315,
"subjectname": "Jane Doe",
"titleid": 1,
"titlename": "Mrs.",
"lname": "Doe",
"fname": "Jane",
"oadc": 10002,
"email": "janedoe24@hotmail.com",
"genderid": false,
"gendername": "Female",
"dob": 1423958400,
"dod": 1426464000
}
}Schema
{
"type": "object",
"properties": {
"studyid": {
"type": "number",
"description": "Unique identifier for study"
},
"Attributes": {
"type": "object",
"properties": {
"subjectid": {
"type": "number",
"description": "Unique ORCATECH database identifier"
},
"subjectname": {
"type": "string",
"description": "Name of subject"
},
"titleid": {
"type": "number",
"description": "Unique identifier for subject's title (0: Mr, 1: Mrs, 3: Miss, 4:Dr, 4:Ms)"
},
"titlename": {
"type": "string",
"description": "Subject's title"
},
"lname": {
"type": "string",
"description": "Subject's last name"
},
"fname": {
"type": "string",
"description": "Subject's first name"
},
"oadc": {
"type": "number",
"description": "Unique identifier for external database"
},
"email": {
"type": "string",
"description": "Subject's email"
},
"genderid": {
"type": "boolean",
"description": "Subject's gender code - 0 for female, 1 for male"
},
"gendername": {
"type": "string",
"description": "Subject's gender"
},
"dob": {
"type": "number",
"description": "Subject's date of birth"
},
"dod": {
"type": "number",
"description": "Subject's date of death"
}
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Available Study SubjectsGET/studies/{id}/subjects/available
Retrieves information about the available subjects enrolled in a specific study.
- id
integer(required) Example: 277The id of the subject
Study Surveys ¶
You can use this url to get information about a specific study’s surveys using the study’s id.
All requests will be sending JSON back to the client, therefore the client will need to include an Accept header with the request indicating that it will accept json responses. If the Accept header is missing or malformed in the request a 400 HTTP error code will be returned. The Accept header should look like the following:
Accept: application/jsonIf the request is made without the Authorization header, the authorization token has expired or the token is invalid, then the server with respond with a 401 response.
If the id can not be found then the server with send a 404 response.
If the request has required parameter that is malformed than the service will response with a 422 HTTP error code.
Headers
ContentType: application/jsonBody
{
"projectid": 13,
"survey_id: SV_8wEcKa486I0Jenj": "Hello, world!",
"name": "BE"
}Schema
{
"type": "object",
"properties": {
"projectid": {
"type": "number",
"description": "Unique identifier for home enrolled in project"
},
"survey_id: SV_8wEcKa486I0Jenj": {
"type": "string",
"description": "Unique identifier for survey assigned by Qualtrics"
},
"name": {
"type": "string",
"description": "SMART (Brain Engagement Survey for Memory, Attention, Responding, and Thinking) (string,fixed) - Name of survey"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/json
WWW-Authenticate: OAuth2.0 realm=juno.orcatech.org, error=invalid_token, error_description=descriptive stringBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Headers
Content-Type: application/jsonBody
{
"code": 0,
"message": "Unknown error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Numeric code of the error that occured"
},
"message": {
"type": "string",
"description": "Description of the error code"
}
},
"required": [
"code",
"message"
]
}Study SurveysGET/studies/{id}/surveys
Retrieves information about study’s surveys.
- id
integer(required) Example: 277The id of the subject