Organisations
Better understanding around Organisations
Overview of Organisations
When we look at the Proximie Platform we must think about Organisations.
Organisations are the cornerstone in the Proximie platform and are used to Manage Members and initiate all Sessions. Any session created will belong to the Organisation it is created within.
In order to work with the API itself you must be a Member of the Organisation you’re calling on behalf of.
What is a Member in an Organisation?
So, what defines a Member?
So, what defines a Member?
When you first get your Proximie account you are known as a User within the Proximie System. After you get invited to an Organisation (and accept the invitation) your User becomes a Member of that Organisation.
Member are unique within each Organisation, but they are based on the parent User Object.
A Quick Breakdown
| Name | Description |
|---|---|
| Organisation | Organisations are the Client Company / Facility who is granting you Member access to the Proximie Platform within their domain. |
| Member | A Member is a User who is associated to an Organisation. They need to be invited to an Organisation and accept before they are officially a Member. |
| User | A User is a single user of the Proximie Platform. Each User account created will be unique for that user. These are different to Members as they are the User before they get invited to an Organisation. They can be invited to multiple Organisations. |
| Role | Roles are associated to each Member within an Organisation. Check Roles for more info. |
| Session | This is the main Video Session within Proximie. They contain the capability to Draw on Screen, Audio for Participants, Surgeons, Consultants, Lecturers and permissions for who is capable of different features within a Session |
| Participants | An Organisation Member in a Session is referred to as a Participant. Participants are the Users taking part in a Session. A Members from both Within the current Organisation and a Different Organisation can be added to a Session, at this point they become a Participant. |
What are the API capabilities of an Organisation?
Within the Organisation domain lives the Taxonomy for configuring a Organisation. The breakdown for this is as follows
While other values for a Organisation are non limited, there are fixed values expected for the fields above. These can be founds in the corresponding taxonomy endpoints for a Organisation.
Taxonomy for a Organisation
| Field | Description | Example |
|---|---|---|
| Type | What is the Organisation's main type. | - HOSPITAL |
| Country | Location were is the Organisation is based. | - GBR - FRA |
Updated almost 3 years ago