Object Definitions
All of the JSON objects used by our API are detailed below.
Activity
| Field | Type | Description |
|---|---|---|
| id | Integer | Unique ID. Always refers to the newest 'approved' version. |
| type | String | The type of Activity. |
| name | String | The name of the Activity. |
| description | String | Nullable. Description of the Activity. |
| url | String | URL to view the Activity. |
Activity ILO
| Field | Type | Description |
|---|---|---|
| id | Integer | Unique ID. Always refers to the newest 'approved' version. |
| description | String | Description of the ILO. |
| url | String | URL to view the ILO. |
Clinical Situation
| Field | Type | Description |
|---|---|---|
| id | Integer | Unique ID. Always refers to the newest 'approved' version. |
| name | String | The name of the Clinical Situation. |
| url | String | URL to view the Clinical Situation. |
Component
| Field | Type | Description |
|---|---|---|
| id | Integer | Unique ID. Always refers to the newest 'approved' version. |
| type | String | The type of Component. |
| phase | Integer | The phase in which the Component takes place. |
| year | Integer | The year in which the Component takes place. |
| name | String | The name of the Component. |
| description | String | Nullable. Description of the Component. |
| url | String | URL to view the Component. |
Component ILO
| Field | Type | Description |
|---|---|---|
| id | Integer | Unique ID. Always refers to the newest 'approved' version. |
| description | String | Description of the ILO. |
| url | String | URL to view the ILO. |
Taxonomy
| Field | Type | Description |
|---|---|---|
| id | Integer | Unique ID. Always refers to the newest 'approved' version. |
| name | String | The name of the Taxonomy. |
| description | String | Nullable. Description of the Taxonomy. |
| url | String | URL to view the Taxonomy. |
Taxonomy Term
| Field | Type | Description |
|---|---|---|
| id | Integer | Unique ID. Note that Terms aren't versioned, so this ID will change with Taxonomy versions. |
| parentId | Integer | Nullable. ID of the parent Term. |
| name | String | The name of the Term. |
| description | String | Nullable. Description of the Term. |
| url | String | URL to view the Term. |
Error
| Field | Type | Decription |
|---|---|---|
| code | Integer | Same as HTTP status code |
| message | String | Information about error |
Types of Error
| Code | Type | Typical explanation |
|---|---|---|
| 400 | Bad Request | Missing/incorrect parameter |
| 401 | Unauthorized | No API key provided, invalid hash |
| 404 | Not Found | The object couldn't be found (usually when querying by ID) |
| 500 | Server Error | An error on our server |