Back to top

Webcamconsult API

A simple API to access users, clients and appointments for webcamconsult.

Authentication is done by an authorization token in the headers. Each organization (instance) has it's own token. add an Authorization key to your headers with the value: “Token token=[your api key]”

  • eg. “Authorization:Token token=9f7927485a954b169ef6502fd5079e72”

Alternatively the token can be provided as by the authentication_token parameter.

Resource Group

UserCollection

List All Users
GET/users.json

Example URI

GET https://eapi.webcamconsult.com/users.json
Request
HideShow
Headers
Authorization: Token token=38826f79010b41b5aaeb4710debb09db
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
    {
        "id": "1234567890abcdef12345678",
        "titles": "Dokter",
        "initials": "J",
        "last_name": "Akkermans",
        "full_name": "Dokter J Akkermans",
        "emails": "jakkermans@example.com"
        "address": "Vlietlaan 1",
        "postal_code": "3011AA",
        "city": "Ergens",
        "roles": [
            "consultant"
        ]
    },
]

Create a New User
POST/users.json

You may create a user using this action. It takes a JSON object containing a user

Example URI

POST https://eapi.webcamconsult.com/users.json
Request
HideShow
Headers
Authorization: Token token=eb4710debb09db38826f79010b41b5aa
Request
HideShow
Headers
Content-Type: application/json
Body
{
    "user": {
        "titles": "Dokter",
        "initials": "J",
        "last_name": "Akkermans",
        "email": "jakkermans@example.com",
        "address": "Vlietlaan 1",
        "postal_code": "3011AA",
        "city": "Ergens",
    }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "user": {
    "id": "1234567890abcdef12345678",
    "titles": "Dokter",
    "initials": "J",
    "last_name": "Akkermans",
    "full_name": "Dokter J Akkermans",
    "email": "jakkermans@example.com",
    "address": "Vlietlaan 1",
    "postal_code": "3011AA",
    "city": "Ergens",
    "roles": [
      "consultant"
    ]
  }
}
Response  422
HideShow
Body
{
  "errors": {
    "email": [
      "is al in gebruik"
    ]
  }
}

User

A user object has the following (editable) attributes

  • titles

  • initials

  • last_name

  • Email

  • address

  • postal_code

  • City

These attributes are generated:

  • id

  • full_name

  • roles

View a User details
GET/users/{user_id}.json

Example URI

GET https://eapi.webcamconsult.com/users/user_id.json
URI Parameters
HideShow
user_id
string (Required) 

id of the user

Request
HideShow
Headers
Authorization: Token token=eb4710debb09db38826f79010b41b5aa
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "user": {
    "id": "1234567890abcdef12345678",
    "titles": "Dokter",
    "initials": "J",
    "last_name": "Akkermans",
    "full_name": "Dokter J Akkermans",
    "email": "jakkermans@example.com",
    "address": "Vlietlaan 1",
    "postal_code": "3011AA",
    "city": "Ergens",
    "roles": [
      "consultant"
    ]
  }
}

Update a User
PUT/users/{user_id}.json

You may update a user using this action. It takes a JSON object containing a user

Example URI

PUT https://eapi.webcamconsult.com/users/user_id.json
URI Parameters
HideShow
user_id
string (Required) 

id of the user

Request
HideShow
Headers
Authorization: Token token=eb4710debb09db38826f79010b41b5aa
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "user": {
    "titles": "Dokter",
    "initials": "J",
    "last_name": "Akkermans",
    "full_name": "Dokter J Akkermans",
    "email": "jakkermans@example.com",
    "address": "Vlietlaan 1",
    "postal_code": "3011AA",
    "city": "Ergens"
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "user": {
    "id": "1234567890abcdef12345678",
    "titles": "Dokter",
    "initials": "J",
    "last_name": "Akkermans",
    "full_name": "Dokter J Akkermans",
    "email": "jakkermans@example.com",
    "address": "Vlietlaan 1",
    "postal_code": "3011AA",
    "city": "Ergens",
    "roles": [
      "consultant"
    ]
  }
}

Delete a User
DELETE/users/{user_id}.json

You may delete a user using this action

Example URI

DELETE https://eapi.webcamconsult.com/users/user_id.json
URI Parameters
HideShow
user_id
string (Required) 

id of the user

Request
HideShow
Headers
Authorization: Token token=eb4710debb09db38826f79010b41b5aa
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "user": {
    "id": "1234567890abcdef12345678"
  }
}
Response  200
HideShow
Headers
Content-Type: Application/json
Body
{
  "status": "ok"
}

Client Collection

List All Clients
GET/clients.json

Example URI

GET https://eapi.webcamconsult.com/clients.json
Request
HideShow
Headers
Authorization: Token token=38826f79010b41b5aaeb4710debb09db
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
    {
        "id":"5492ba6da19ea682ea000001",
        "email":"urias@sensestudios.com",
        "titles":"Dr.",
        "initials":"T",
        "surname_prefix":"de",
        "last_name":"Ester",
        "client_full_name":"Dhr. Dr. T de Ester",
        "external":null,
        "gender":"male",
        "date_of_birth":"2014-12-18T00:00:00.000+01:00",
        "reference_code":"12345",
        "division_ids":[ "5492ba6da19ea682ea000001", "5492ba6da19ea682ea000001" ],
        "authentication_token":"M94sNGjyKEH2U3yTxRAx",
    },
]

Create a New Client
POST/clients.json

You may create a client using this action. It takes a JSON object containing a client

Example URI

POST https://eapi.webcamconsult.com/clients.json
Request
HideShow
Headers
Authorization: Token token=eb4710debb09db38826f79010b41b5aa
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "client": {
    "email": "urias@sensestudios.com",
    "titles": "Dr.",
    "initials": "T",
    "surname_prefix": "de",
    "last_name": "Ester",
    "gender": "male",
    "date_of_birth": "2014-12-18T00:00:00.000+01:00",
    "reference_code": "12345",
    "division_ids": [
      "5492ba6da19ea682ea000001",
      "5492ba6da19ea682ea000001"
    ]
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "client": {
        "id":"5492ba6da19ea682ea000001",
        "email":"urias@sensestudios.com",
        "titles":"Dr.",
        "initials":"T",
        "surname_prefix":"de",
        "last_name":"Ester",
        "client_full_name":"Dhr. Dr. T de Ester",
        "external":null,
        "gender":"male",
        "date_of_birth":"2014-12-18T00:00:00.000+01:00",
        "reference_code":"12345",
        "division_ids":[ "5492ba6da19ea682ea000001", "5492ba6da19ea682ea000001" ],
    }
}
Response  422
HideShow
Body
{
  "errors": {}
  }
}

service

A user object has the following (editable) attributes

  • Email

  • titles

  • initials

  • nickname_prefix

  • last_name

  • external

  • gender

  • date of birth

  • reference_code

  • division_ids

These attributes are generated:

  • id

  • client_full_name

View a Client details
GET/client/{client_id}.json

Example URI

GET https://eapi.webcamconsult.com/client/client_id.json
URI Parameters
HideShow
client_id
string (Required) 

ID of the client

Request
HideShow
Headers
Authorization: Token token=eb4710debb09db38826f79010b41b5aa
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "client": {
        "id":"5492ba6da19ea682ea000001",
        "email":"urias@sensestudios.com",
        "titles":"Dr.",
        "initials":"T",
        "surname_prefix":"de",
        "last_name":"Ester",
        "client_full_name":"Dhr. Dr. T de Ester",
        "external":null,
        "gender":"male",
        "date_of_birth":"2014-12-18T00:00:00.000+01:00",
        "reference_code":"12345",
        "division_ids":[ "5492ba6da19ea682ea000001", "5492ba6da19ea682ea000001" ],
    }
}

Update a client
PUT/client/{client_id}.json

You may update a user using this action. It takes a JSON object containing a user

Example URI

PUT https://eapi.webcamconsult.com/client/client_id.json
URI Parameters
HideShow
client_id
string (Required) 

ID of the client

Request
HideShow
Headers
Authorization: Token token=eb4710debb09db38826f79010b41b5aa
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "client": {
    "email": "urias@sensestudios.com",
    "titles": "Dr.",
    "initials": "T",
    "surname_prefix": "de",
    "last_name": "Ester",
    "gender": "male",
    "date_of_birth": "2014-12-18T00:00:00.000+01:00",
    "reference_code": "12345",
    "division_ids": [
      "5492ba6da19ea682ea000001",
      "5492ba6da19ea682ea000001"
    ]
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "client": {
    "id": "5492ba6da19ea682ea000001",
    "email": "urias@sensestudios.com",
    "titles": "Dr.",
    "initials": "T",
    "surname_prefix": "de",
    "last_name": "Ester",
    "client_full_name": "Dhr. Dr. T de Ester",
    "external": null,
    "gender": "male",
    "date_of_birth": "2014-12-18T00:00:00.000+01:00",
    "reference_code": "12345",
    "division_ids": [
      "5492ba6da19ea682ea000001",
      "5492ba6da19ea682ea000001"
    ]
  }
}

Delete a Client
DELETE/client/{client_id}.json

You may delete a client using this action

Example URI

DELETE https://eapi.webcamconsult.com/client/client_id.json
URI Parameters
HideShow
client_id
string (Required) 

ID of the client

Request
HideShow
Headers
Authorization: Token token=eb4710debb09db38826f79010b41b5aa
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "client": {
    "id": "1234567890abcdef12345678"
  }
}
Response  200
HideShow
Headers
Content-Type: Application/json
Body
{
  "status": "ok"
}

Appointment Collection

List All Appointments
GET/appointments.json

  • Parameters (optional) start: YYYYMMDD (parsable date, string)

  • Parameters (optional) end: YYYYMMDD (parsable date, string)

Example URI

GET https://eapi.webcamconsult.com/appointments.json
Request
HideShow
Headers
Authorization: Token token=38826f79010b41b5aaeb4710debb09db
Request
HideShow
Headers
Content-Type: application/json
Body
{
    start: "20200301",
    eind: "20200331"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
    {
        "id": "1234567890abcdef12345678",
        "user_id": "1234567890abcdef12345678",
        "client_id": "1234567890abcdef12345678",
        "created_by_user_id": "1234567890abcdef12345678",
        "date":"2015-07-01T15:41:24.306+02:00",
        "orig_date":"2015-07-01T15:41:24.306+02:00",
        "started_at":"2015-07-01T15:41:24.306+02:00",
        "created_at":"2015-07-01T15:41:24.306+02:00",
        "state": "idle",
        "division_id": "1234567890abcdef12345678",
        "duration": 100,
        "external_participant_ids":["1234567890abcdef12345678","1234567890abcdef12345678"],
        "fileshare": false,
        "screenshare": false,
        "group": false,
        "widget": false,
        "inloop_json": {"email":"someemail@somedomain.com"},
        "pin": 2139,
        "reminder_10m_id": "2015-07-01T15:41:24.306+02:00",
        "reminder_1h_id": "2015-07-01T15:41:24.306+02:00",
        "stream": "172d79c0-0224-0133-121b-00163e1631b0",
        "token": "4987yrtkjsdfsUDASJD",
        "client_device":"windows-chrome"
    },
]

Create a New Appointment
POST/appointments.json

You may create a client using this action. It takes a JSON

object containing a client

Example URI

POST https://eapi.webcamconsult.com/appointments.json
Request
HideShow
Headers
Authorization: Token token=eb4710debb09db38826f79010b41b5aa
Request
HideShow
Headers
Content-Type: application/json
Body
{
    "client": {
        "last_name": "Akkermans",
        "email": "jakkermans@example.com",
    }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "client": {
        "id": "1234567890abcdef12345678",
        "last_name": "Akkermans",
        "email": "jakkermans@example.com",
    }
}
Response  422
HideShow
Body
{
  "errors": {
    "email": [
      "is al in gebruik"
    ]
  }
}

Appointment

A user object has the following (editable) attributes

  • last_name

  • Email

These attributes are generated:

  • id

View an Appointment detail
GET/appointment/{appointment_id}.json

Example URI

GET https://eapi.webcamconsult.com/appointment/appointment_id.json
URI Parameters
HideShow
appointment_id
string (Required) 

ID of the appointment

Request
HideShow
Headers
Authorization: Token token=eb4710debb09db38826f79010b41b5aa
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "client": {
        "id": "1234567890abcdef12345678",
        "last_name": "Akkermans",
        "email": "jakkermans@example.com",
    }
}

Update an Appointment
PUT/appointment/{appointment_id}.json

You may update an appointment using this action. It takes a JSON object containing a user

Example URI

PUT https://eapi.webcamconsult.com/appointment/appointment_id.json
URI Parameters
HideShow
appointment_id
string (Required) 

ID of the appointment

Request
HideShow
Headers
Authorization: Token token=eb4710debb09db38826f79010b41b5aa
Request
HideShow
Headers
Content-Type: application/json
Body
{
    "appointment": {
        "date": "Akkermans",
    }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "appointment": {
        "id": "1234567890abcdef12345678",
    }
}

Delete an Appointment
DELETE/appointment/{appointment_id}.json

You may delete an appointment using this action

Example URI

DELETE https://eapi.webcamconsult.com/appointment/appointment_id.json
URI Parameters
HideShow
appointment_id
string (Required) 

ID of the appointment

Request
HideShow
Headers
Authorization: Token token=eb4710debb09db38826f79010b41b5aa
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "appointment": {
    "id": "1234567890abcdef12345678"
  }
}
Response  200
HideShow
Headers
Content-Type: Application/json
Body
{
  "status": "ok"
}

Generated by garlic on May 11, 2020