Security
Meetings (get create)
Certificate
MLS Manager
Base url
https://manager.mylivession.com/api-mls/v0.91/
Version v0.91
Security
basic
This API supports Basic Authentication via RFC2617
basic
Request
Headers
Authorization
: Used to send a basic authentication header : Basic base64(user:password)
Response
HTTP Status code
401
Bad credentials
Settings
Resources
URl: /meeting
GET
POST
Meetings (get create)
GET
/meeting
Description
Retrieve the collection of meetings
Secured by basic
Request
Headers
Authorization
: Used to send a basic authentication header : Basic base64(user:password)
Response
HTTP Status code
200
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/data/meetings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/meeting.json", "type": "object", "description": "A meeting object", "properties": { "id": { "type": "Integer", "readOnly": true }, "reference": { "type": "string" }, "name": { "type": "string" }, "date": { "type": "date-time", "format": "Y-m-d H:i:s" }, "duration": { "type": "string", "description": "HH:MM" }, "convocation_model": { "type": "string" }, "base_url": { "type": "string", "readOnly": true, "description": "To build the meeting URL, concatenate base_url and url" }, "url": { "type": "string" }, "language": { "type": "string", "description": "FR or EN" }, "room_model": { "type": "string" }, "email_custom_content": { "type": "string", "description": "text or HTML" }, "access_type": { "type": "string", "description": "PA = only participants, PVA : participants and visitors, TLM : access for all" }, "project": { "type": "string" }, "custom_field_1": { "type": "string" }, "custom_field_2": { "type": "string" }, "send_email": { "type": "boolean", "description": "Meeting participant will receive e-mails" }, "conference_phone": { "type": "string", "readOnly": true }, "conference_phone_code_animator": { "type": "string", "readOnly": true }, "conference_phone_code_participant": { "type": "string", "readOnly": true } }, "required": { "0": "name", "1": "date", "2": "duration", "3": "convocation_model" } } }
HTTP Status code
401
Bad credentials
POST
/meeting
Description
Create a new meeting
Secured by basic
Request
Headers
Authorization
: Used to send a basic authentication header : Basic base64(user:password)
Content-Type:
application/json
Body
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/meeting.json", "type": "object", "description": "A meeting response", "properties": { "value": { "type": "object", "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/meeting.json", "description": "A meeting object", "properties": { "id": { "type": "Integer", "readOnly": true }, "reference": { "type": "string" }, "name": { "type": "string" }, "date": { "type": "date-time", "format": "Y-m-d H:i:s" }, "duration": { "type": "string", "description": "HH:MM" }, "convocation_model": { "type": "string" }, "base_url": { "type": "string", "readOnly": true, "description": "To build the meeting URL, concatenate base_url and url" }, "url": { "type": "string" }, "language": { "type": "string", "description": "FR or EN" }, "room_model": { "type": "string" }, "email_custom_content": { "type": "string", "description": "text or HTML" }, "access_type": { "type": "string", "description": "PA = only participants, PVA : participants and visitors, TLM : access for all" }, "project": { "type": "string" }, "custom_field_1": { "type": "string" }, "custom_field_2": { "type": "string" }, "send_email": { "type": "boolean", "description": "Meeting participant will receive e-mails" }, "conference_phone": { "type": "string", "readOnly": true }, "conference_phone_code_animator": { "type": "string", "readOnly": true }, "conference_phone_code_participant": { "type": "string", "readOnly": true } }, "required": { "0": "name", "1": "date", "2": "duration", "3": "convocation_model" } }, "warning-list": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warnings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warning.json", "type": "object", "description": "A warning object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } } }, "required": { "0": "value" } }
Response
HTTP Status code
200
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/meeting.json", "type": "object", "description": "A meeting response", "properties": { "value": { "type": "object", "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/meeting.json", "description": "A meeting object", "properties": { "id": { "type": "Integer", "readOnly": true }, "reference": { "type": "string" }, "name": { "type": "string" }, "date": { "type": "date-time", "format": "Y-m-d H:i:s" }, "duration": { "type": "string", "description": "HH:MM" }, "convocation_model": { "type": "string" }, "base_url": { "type": "string", "readOnly": true, "description": "To build the meeting URL, concatenate base_url and url" }, "url": { "type": "string" }, "language": { "type": "string", "description": "FR or EN" }, "room_model": { "type": "string" }, "email_custom_content": { "type": "string", "description": "text or HTML" }, "access_type": { "type": "string", "description": "PA = only participants, PVA : participants and visitors, TLM : access for all" }, "project": { "type": "string" }, "custom_field_1": { "type": "string" }, "custom_field_2": { "type": "string" }, "send_email": { "type": "boolean", "description": "Meeting participant will receive e-mails" }, "conference_phone": { "type": "string", "readOnly": true }, "conference_phone_code_animator": { "type": "string", "readOnly": true }, "conference_phone_code_participant": { "type": "string", "readOnly": true } }, "required": { "0": "name", "1": "date", "2": "duration", "3": "convocation_model" } }, "warning-list": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warnings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warning.json", "type": "object", "description": "A warning object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } } }, "required": { "0": "value" } }
HTTP Status code
401
Bad credentials
HTTP Status code
409
Meeting with given reference already exists
HTTP Status code
500
The process encountered an error
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/errors.json", "description": "An error collection response", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/error.json", "type": "object", "description": "An error object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } }
URl: /meeting/reference/{meeting_reference}
GET
Meetings (get by Reference)
GET
/meeting/reference/{meeting_reference}
Description
Get a meeting by reference
Secured by basic
Request
Uri Parameters
meeting_reference
(string )
Headers
Authorization
: Used to send a basic authentication header : Basic base64(user:password)
Content-Type:
application/json
Body
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/meeting.json", "type": "object", "description": "A meeting response", "properties": { "value": { "type": "object", "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/meeting.json", "description": "A meeting object", "properties": { "id": { "type": "Integer", "readOnly": true }, "reference": { "type": "string" }, "name": { "type": "string" }, "date": { "type": "date-time", "format": "Y-m-d H:i:s" }, "duration": { "type": "string", "description": "HH:MM" }, "convocation_model": { "type": "string" }, "base_url": { "type": "string", "readOnly": true, "description": "To build the meeting URL, concatenate base_url and url" }, "url": { "type": "string" }, "language": { "type": "string", "description": "FR or EN" }, "room_model": { "type": "string" }, "email_custom_content": { "type": "string", "description": "text or HTML" }, "access_type": { "type": "string", "description": "PA = only participants, PVA : participants and visitors, TLM : access for all" }, "project": { "type": "string" }, "custom_field_1": { "type": "string" }, "custom_field_2": { "type": "string" }, "send_email": { "type": "boolean", "description": "Meeting participant will receive e-mails" }, "conference_phone": { "type": "string", "readOnly": true }, "conference_phone_code_animator": { "type": "string", "readOnly": true }, "conference_phone_code_participant": { "type": "string", "readOnly": true } }, "required": { "0": "name", "1": "date", "2": "duration", "3": "convocation_model" } }, "warning-list": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warnings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warning.json", "type": "object", "description": "A warning object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } } }, "required": { "0": "value" } }
Response
HTTP Status code
200
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/meeting.json", "type": "object", "description": "A meeting response", "properties": { "value": { "type": "object", "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/meeting.json", "description": "A meeting object", "properties": { "id": { "type": "Integer", "readOnly": true }, "reference": { "type": "string" }, "name": { "type": "string" }, "date": { "type": "date-time", "format": "Y-m-d H:i:s" }, "duration": { "type": "string", "description": "HH:MM" }, "convocation_model": { "type": "string" }, "base_url": { "type": "string", "readOnly": true, "description": "To build the meeting URL, concatenate base_url and url" }, "url": { "type": "string" }, "language": { "type": "string", "description": "FR or EN" }, "room_model": { "type": "string" }, "email_custom_content": { "type": "string", "description": "text or HTML" }, "access_type": { "type": "string", "description": "PA = only participants, PVA : participants and visitors, TLM : access for all" }, "project": { "type": "string" }, "custom_field_1": { "type": "string" }, "custom_field_2": { "type": "string" }, "send_email": { "type": "boolean", "description": "Meeting participant will receive e-mails" }, "conference_phone": { "type": "string", "readOnly": true }, "conference_phone_code_animator": { "type": "string", "readOnly": true }, "conference_phone_code_participant": { "type": "string", "readOnly": true } }, "required": { "0": "name", "1": "date", "2": "duration", "3": "convocation_model" } }, "warning-list": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warnings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warning.json", "type": "object", "description": "A warning object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } } }, "required": { "0": "value" } }
HTTP Status code
401
Bad credentials
HTTP Status code
404
Meeting not found
URl: /meeting/{meeting_id}
GET
PATCH
DELETE
Meetings (get by Id update delete)
GET
/meeting/{meeting_id}
Description
Get a meeting by Id
Secured by basic
Request
Uri Parameters
meeting_id
(integer )
Headers
Authorization
: Used to send a basic authentication header : Basic base64(user:password)
Content-Type:
application/json
Body
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/meeting.json", "type": "object", "description": "A meeting response", "properties": { "value": { "type": "object", "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/meeting.json", "description": "A meeting object", "properties": { "id": { "type": "Integer", "readOnly": true }, "reference": { "type": "string" }, "name": { "type": "string" }, "date": { "type": "date-time", "format": "Y-m-d H:i:s" }, "duration": { "type": "string", "description": "HH:MM" }, "convocation_model": { "type": "string" }, "base_url": { "type": "string", "readOnly": true, "description": "To build the meeting URL, concatenate base_url and url" }, "url": { "type": "string" }, "language": { "type": "string", "description": "FR or EN" }, "room_model": { "type": "string" }, "email_custom_content": { "type": "string", "description": "text or HTML" }, "access_type": { "type": "string", "description": "PA = only participants, PVA : participants and visitors, TLM : access for all" }, "project": { "type": "string" }, "custom_field_1": { "type": "string" }, "custom_field_2": { "type": "string" }, "send_email": { "type": "boolean", "description": "Meeting participant will receive e-mails" }, "conference_phone": { "type": "string", "readOnly": true }, "conference_phone_code_animator": { "type": "string", "readOnly": true }, "conference_phone_code_participant": { "type": "string", "readOnly": true } }, "required": { "0": "name", "1": "date", "2": "duration", "3": "convocation_model" } }, "warning-list": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warnings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warning.json", "type": "object", "description": "A warning object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } } }, "required": { "0": "value" } }
Response
HTTP Status code
200
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/meeting.json", "type": "object", "description": "A meeting response", "properties": { "value": { "type": "object", "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/meeting.json", "description": "A meeting object", "properties": { "id": { "type": "Integer", "readOnly": true }, "reference": { "type": "string" }, "name": { "type": "string" }, "date": { "type": "date-time", "format": "Y-m-d H:i:s" }, "duration": { "type": "string", "description": "HH:MM" }, "convocation_model": { "type": "string" }, "base_url": { "type": "string", "readOnly": true, "description": "To build the meeting URL, concatenate base_url and url" }, "url": { "type": "string" }, "language": { "type": "string", "description": "FR or EN" }, "room_model": { "type": "string" }, "email_custom_content": { "type": "string", "description": "text or HTML" }, "access_type": { "type": "string", "description": "PA = only participants, PVA : participants and visitors, TLM : access for all" }, "project": { "type": "string" }, "custom_field_1": { "type": "string" }, "custom_field_2": { "type": "string" }, "send_email": { "type": "boolean", "description": "Meeting participant will receive e-mails" }, "conference_phone": { "type": "string", "readOnly": true }, "conference_phone_code_animator": { "type": "string", "readOnly": true }, "conference_phone_code_participant": { "type": "string", "readOnly": true } }, "required": { "0": "name", "1": "date", "2": "duration", "3": "convocation_model" } }, "warning-list": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warnings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warning.json", "type": "object", "description": "A warning object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } } }, "required": { "0": "value" } }
HTTP Status code
401
Bad credentials
HTTP Status code
404
Meeting not found
PATCH
/meeting/{meeting_id}
Description
Update a new meeting
Secured by basic
Request
Uri Parameters
meeting_id
(integer )
Headers
Authorization
: Used to send a basic authentication header : Basic base64(user:password)
Content-Type:
application/json
Body
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/meeting.json", "type": "object", "description": "A meeting response", "properties": { "value": { "type": "object", "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/meeting.json", "description": "A meeting object", "properties": { "id": { "type": "Integer", "readOnly": true }, "reference": { "type": "string" }, "name": { "type": "string" }, "date": { "type": "date-time", "format": "Y-m-d H:i:s" }, "duration": { "type": "string", "description": "HH:MM" }, "convocation_model": { "type": "string" }, "base_url": { "type": "string", "readOnly": true, "description": "To build the meeting URL, concatenate base_url and url" }, "url": { "type": "string" }, "language": { "type": "string", "description": "FR or EN" }, "room_model": { "type": "string" }, "email_custom_content": { "type": "string", "description": "text or HTML" }, "access_type": { "type": "string", "description": "PA = only participants, PVA : participants and visitors, TLM : access for all" }, "project": { "type": "string" }, "custom_field_1": { "type": "string" }, "custom_field_2": { "type": "string" }, "send_email": { "type": "boolean", "description": "Meeting participant will receive e-mails" }, "conference_phone": { "type": "string", "readOnly": true }, "conference_phone_code_animator": { "type": "string", "readOnly": true }, "conference_phone_code_participant": { "type": "string", "readOnly": true } }, "required": { "0": "name", "1": "date", "2": "duration", "3": "convocation_model" } }, "warning-list": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warnings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warning.json", "type": "object", "description": "A warning object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } } }, "required": { "0": "value" } }
Response
HTTP Status code
200
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/meeting.json", "type": "object", "description": "A meeting response", "properties": { "value": { "type": "object", "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/meeting.json", "description": "A meeting object", "properties": { "id": { "type": "Integer", "readOnly": true }, "reference": { "type": "string" }, "name": { "type": "string" }, "date": { "type": "date-time", "format": "Y-m-d H:i:s" }, "duration": { "type": "string", "description": "HH:MM" }, "convocation_model": { "type": "string" }, "base_url": { "type": "string", "readOnly": true, "description": "To build the meeting URL, concatenate base_url and url" }, "url": { "type": "string" }, "language": { "type": "string", "description": "FR or EN" }, "room_model": { "type": "string" }, "email_custom_content": { "type": "string", "description": "text or HTML" }, "access_type": { "type": "string", "description": "PA = only participants, PVA : participants and visitors, TLM : access for all" }, "project": { "type": "string" }, "custom_field_1": { "type": "string" }, "custom_field_2": { "type": "string" }, "send_email": { "type": "boolean", "description": "Meeting participant will receive e-mails" }, "conference_phone": { "type": "string", "readOnly": true }, "conference_phone_code_animator": { "type": "string", "readOnly": true }, "conference_phone_code_participant": { "type": "string", "readOnly": true } }, "required": { "0": "name", "1": "date", "2": "duration", "3": "convocation_model" } }, "warning-list": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warnings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warning.json", "type": "object", "description": "A warning object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } } }, "required": { "0": "value" } }
HTTP Status code
401
Bad credentials
HTTP Status code
404
Meeting not found
HTTP Status code
500
The process encountered an error
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/errors.json", "description": "An error collection response", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/error.json", "type": "object", "description": "An error object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } }
DELETE
/meeting/{meeting_id}
Description
Delete a new meeting
Secured by basic
Request
Uri Parameters
meeting_id
(integer )
Headers
Authorization
: Used to send a basic authentication header : Basic base64(user:password)
Response
HTTP Status code
200
Empty response
HTTP Status code
401
Bad credentials
HTTP Status code
404
Meeting not found
HTTP Status code
500
The process encountered an error
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/errors.json", "description": "An error collection response", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/error.json", "type": "object", "description": "An error object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } }
URl: /meeting/{meeting_id}/participant
GET
POST
Participant (get create)
GET
/meeting/{meeting_id}/participant
Description
Retrieve the collection of participants of the meeting
Secured by basic
Request
Uri Parameters
meeting_id
(integer )
Headers
Authorization
: Used to send a basic authentication header : Basic base64(user:password)
Response
HTTP Status code
200
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/participants.json", "type": "object", "description": "A participant collection response", "properties": { "value": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/participants.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/participant.json", "type": "object", "description": "A participant object", "properties": { "id": { "type": "Integer", "readOnly": true }, "reference": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "email": { "type": "string", "description": "The email must be unique, on CREATE : If the email already exists, the participant will be updated, on UPDATE : If the email already exists, a 500 error will be throw" }, "type": { "type": "string", "description": "A : animator P : participant" }, "phone": { "type": "string" }, "custom_field_1": { "type": "string" }, "custom_field_2": { "type": "string" }, "connection_url": { "type": "string", "readOnly": true } }, "required": { "0": "firstname", "1": "lastname", "2": "email", "3": "type" } } }, "warning-list": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warnings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warning.json", "type": "object", "description": "A warning object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } } }, "required": { "0": "value" } }
HTTP Status code
401
Bad credentials
HTTP Status code
404
Meeting not found
HTTP Status code
500
The process encountered an error
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/errors.json", "description": "An error collection response", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/error.json", "type": "object", "description": "An error object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } }
POST
/meeting/{meeting_id}/participant
Description
Create a participant for the meeting
Secured by basic
Request
Uri Parameters
meeting_id
(integer )
Headers
Authorization
: Used to send a basic authentication header : Basic base64(user:password)
Content-Type:
application/json
Body
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/participant.json", "type": "object", "description": "A participant response", "properties": { "value": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/participant.json", "type": "object", "description": "A participant object", "properties": { "id": { "type": "Integer", "readOnly": true }, "reference": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "email": { "type": "string", "description": "The email must be unique, on CREATE : If the email already exists, the participant will be updated, on UPDATE : If the email already exists, a 500 error will be throw" }, "type": { "type": "string", "description": "A : animator P : participant" }, "phone": { "type": "string" }, "custom_field_1": { "type": "string" }, "custom_field_2": { "type": "string" }, "connection_url": { "type": "string", "readOnly": true } }, "required": { "0": "firstname", "1": "lastname", "2": "email", "3": "type" } }, "warning-list": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warnings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warning.json", "type": "object", "description": "A warning object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } } }, "required": { "0": "value" } }
Response
HTTP Status code
200
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/participant.json", "type": "object", "description": "A participant response", "properties": { "value": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/participant.json", "type": "object", "description": "A participant object", "properties": { "id": { "type": "Integer", "readOnly": true }, "reference": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "email": { "type": "string", "description": "The email must be unique, on CREATE : If the email already exists, the participant will be updated, on UPDATE : If the email already exists, a 500 error will be throw" }, "type": { "type": "string", "description": "A : animator P : participant" }, "phone": { "type": "string" }, "custom_field_1": { "type": "string" }, "custom_field_2": { "type": "string" }, "connection_url": { "type": "string", "readOnly": true } }, "required": { "0": "firstname", "1": "lastname", "2": "email", "3": "type" } }, "warning-list": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warnings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warning.json", "type": "object", "description": "A warning object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } } }, "required": { "0": "value" } }
HTTP Status code
401
Bad credentials
HTTP Status code
404
Meeting not found
HTTP Status code
409
Participant already exists
HTTP Status code
500
The process encountered an error
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/errors.json", "description": "An error collection response", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/error.json", "type": "object", "description": "An error object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } }
URl: /meeting/{meeting_id}/participant/{participant_id}
PATCH
DELETE
Participant (update delete)
PATCH
/meeting/{meeting_id}/participant/{participant_id}
Description
Update the participant for the meeting
Secured by basic
Request
Uri Parameters
participant_id
(string )
meeting_id
(integer )
Headers
Authorization
: Used to send a basic authentication header : Basic base64(user:password)
Content-Type:
application/json
Body
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/participant.json", "type": "object", "description": "A participant response", "properties": { "value": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/participant.json", "type": "object", "description": "A participant object", "properties": { "id": { "type": "Integer", "readOnly": true }, "reference": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "email": { "type": "string", "description": "The email must be unique, on CREATE : If the email already exists, the participant will be updated, on UPDATE : If the email already exists, a 500 error will be throw" }, "type": { "type": "string", "description": "A : animator P : participant" }, "phone": { "type": "string" }, "custom_field_1": { "type": "string" }, "custom_field_2": { "type": "string" }, "connection_url": { "type": "string", "readOnly": true } }, "required": { "0": "firstname", "1": "lastname", "2": "email", "3": "type" } }, "warning-list": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warnings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warning.json", "type": "object", "description": "A warning object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } } }, "required": { "0": "value" } }
Response
HTTP Status code
200
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/participant.json", "type": "object", "description": "A participant response", "properties": { "value": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/participant.json", "type": "object", "description": "A participant object", "properties": { "id": { "type": "Integer", "readOnly": true }, "reference": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "email": { "type": "string", "description": "The email must be unique, on CREATE : If the email already exists, the participant will be updated, on UPDATE : If the email already exists, a 500 error will be throw" }, "type": { "type": "string", "description": "A : animator P : participant" }, "phone": { "type": "string" }, "custom_field_1": { "type": "string" }, "custom_field_2": { "type": "string" }, "connection_url": { "type": "string", "readOnly": true } }, "required": { "0": "firstname", "1": "lastname", "2": "email", "3": "type" } }, "warning-list": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warnings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warning.json", "type": "object", "description": "A warning object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } } }, "required": { "0": "value" } }
HTTP Status code
401
Bad credentials
HTTP Status code
404
Meeting or participant not found
HTTP Status code
500
The process encountered an error
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/errors.json", "description": "An error collection response", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/error.json", "type": "object", "description": "An error object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } }
DELETE
/meeting/{meeting_id}/participant/{participant_id}
Description
Delete the participant for the meeting
Secured by basic
Request
Uri Parameters
participant_id
(string )
meeting_id
(integer )
Headers
Authorization
: Used to send a basic authentication header : Basic base64(user:password)
Response
HTTP Status code
200
Empty response
HTTP Status code
401
Bad credentials
HTTP Status code
404
Meeting or participant not found
HTTP Status code
500
The process encountered an error
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/errors.json", "description": "An error collection response", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/error.json", "type": "object", "description": "An error object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } }
Certificate
URl: /certificate/participant/{email}
GET
Certificate by participant
GET
/certificate/participant/{email}
Description
Retrieve all the training certificates for the participant
Secured by basic
Request
Uri Parameters
email
(string )
Headers
Authorization
: Used to send a basic authentication header : Basic base64(user:password)
Response
HTTP Status code
200
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/certificates.json", "type": "object", "description": "A certificate collection response", "properties": { "value": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/certificates.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/certificate.json", "type": "object", "description": "A training certificate object", "properties": { "meeting_id": { "type": "string" }, "participant_id": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "email": { "type": "string" }, "start_date": { "type": "date-time", "format": "Y-m-d H:i:s" }, "end_date": { "type": "date-time", "format": "Y-m-d H:i:s" }, "type": { "type": "string", "description": "P for Participant | A for animator" } }, "required": { "0": "meeting_id", "1": "participant_id" } } }, "warning-list": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warnings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warning.json", "type": "object", "description": "A warning object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } } }, "required": { "0": "value" } }
HTTP Status code
401
Bad credentials
HTTP Status code
404
Participant not found
URl: /certificate/meeting/{meeting_id}
GET
Certificate by meeting
GET
/certificate/meeting/{meeting_id}
Description
Retrieve all the training certificates for the meeting
Secured by basic
Request
Uri Parameters
meeting_id
(string )
Headers
Authorization
: Used to send a basic authentication header : Basic base64(user:password)
Response
HTTP Status code
200
Content-Type:
application/json
Schema
{ "$schema": "http://json-schema.org/schema", "id": "file:///home/moi/intranet/2016/MLS_raml/schema/certificates.json", "type": "object", "description": "A certificate collection response", "properties": { "value": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/certificates.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/certificate.json", "type": "object", "description": "A training certificate object", "properties": { "meeting_id": { "type": "string" }, "participant_id": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "email": { "type": "string" }, "start_date": { "type": "date-time", "format": "Y-m-d H:i:s" }, "end_date": { "type": "date-time", "format": "Y-m-d H:i:s" }, "type": { "type": "string", "description": "P for Participant | A for animator" } }, "required": { "0": "meeting_id", "1": "participant_id" } } }, "warning-list": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warnings.json", "type": "array", "items": { "$schema": "http://json-schema.org/schema", "id": "http://mlsm.docapi.mylivesession.com/schema/data/warning.json", "type": "object", "description": "A warning object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": { "0": "code", "1": "message" } } } }, "required": { "0": "value" } }
HTTP Status code
401
Bad credentials
HTTP Status code
404
Meeting not found