API.md

API

Register User

Generates a SAML assertion for device enrollment in Ionic.com. Registers a new User if it doesn't already exist. If a User with the given email exists, but is not a member of the Group specified by groupName - an error is returned, otherwise returns the user record an assertion object to be passed into Ionic JS SDK completing device enrollment.

Request

POST /register

Headers:

Content-Type: application/json

Body (all fields are required)

{
  "email": "user@example.com",
  "groupName": "patients|physicians|insurers",
  "firstName": "John",
  "lastName": "Doe"
}

Response

Body

{
   "assertion":{
      "X-Ionic-Reg-Uidauth": "string",
      "X-Ionic-Reg-Stoken": "string",
      "X-Ionic-Reg-Ionic-API-Urls": "string",
      "X-Ionic-Reg-Enrollment-Tag": "string",
      "X-Ionic-Reg-Pubkey": "string"
   },
   "user": {
      "id": "5cb5f865e5a7320cf0fdf0ee",
      "schemas": [
         "urn:scim:schemas:core:1.0"
      ],
      "meta": {
         "created":"2019-04-16T15:44:37Z",
         "lastModified":"2019-04-16T15:44:37Z",
         "location":"/v2/5c7ec51be5a7322a83fd22a5/scim/Users/5cb5f865e5a7320cf0fdf0ee",
         "version":"2"
      },
      "name":{
         "formatted":"Test Patient",
         "familyName":"Patient",
         "givenName":"Test"
      },
      "emails":[
         {
            "value":"test_patient@virgilsecurity.com"
         }
      ],
      "groups":[
         {
            "value":"5cab158ce5a7320cf0fd0416",
            "display":"Patients"
         }
      ]
   }
}

Get App State

Returns the current application state

Request

GET /state

Response

Body (values may be undefined)

{
	"medical_history": "history",
	"office_visit_notes": "notes",
	"prescription": "prescription",
	"insurer_reply": "insurer reply"
}

Update App State

Updates the current application state

Request

PUT /state

Headers

Content-Type: application/json

Body (all fields are optional, but at least one is required)

{
    "medical_history": "my medical history",
    "office_visit_notes": "my visit notes",
	"prescription": "my prescription",
	"insurer_reply": "my insurer reply"
}

Response

Body

{
	"medical_history": "my medical history",
    "office_visit_notes": "my visit notes",
	"prescription": "my prescription",
	"insurer_reply": "my insurer reply"
}

Errors

Errors are returned as JSON with the following format:

{
  "error": "An error occured"
}

Validation error responses also include errors property:

{
  "error": "Invalid request body",
  "errors": [
    {
      "param": "email",
      "message": "Invalid value"
    }
  ]
}

Client errors have HTTP status code 400, Server errors - 500