GovX API (1.1)

Download OpenAPI specification:Download

Eummena: solutions@eummena.org URL: https://eummena.org License: Apache 2.0

Introduction

The GovX API is used for the communication between the Moodle-based backend and the GovX mobile app. It was implemented by Eummena team as part of the GovX LMS product. It is based on Moodle's core API (web services) and it's extending it in many ways to match the needs of the custom GovX mobile app.

The API is documented in OpenAPI specification with a few vendor extensions.

URL Schema and Authentication

The GovX API is using an API token (key) as a form of authentication. This token is created at the system level or, usually, at each user's level.

The API token needs to be passed with the wstoken parameter in every request to the API endpoints. All requests to the API endpoints must follow the URL schema of Moodle:

https://example.com/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=ENDPOINT&wstoken=XXXXX&param1=value1&param2=value2&....

The following samples provide the first part for the URL of each endpoint for convenience. If you want to test them you will have to provide the token and any relevant API parameters.

api_key

you can request an API key to test the GovX API endpoints

Security Scheme Type	API Key
Header parameter name:	wstoken

competencies

list_competencies

Load a list of all competencies

query Parameters

filters required	Array of objects filters
sort required	string Column to sort by.
order required	string Sort direction. Should be either ASC or DESC.
skip required	integer Skip this number of records before returning results.
limit required	integer Return this number of records at most.

Responses

200

Load a list of a competencies.

get/core_competency_list_competencies

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_competency_list_competencies

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_competency_list_competencies

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_competency_list_competencies

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"shortname": "string",
"idnumber": "string",
"description": "string",
"descriptionformat": 1,
"sortorder": 0,
"parentid": 0,
"path": "string",
"ruleoutcome": 0,
"ruletype": "string",
"ruleconfig": "string",
"scaleid": 0,
"scaleconfiguration": "string",
"competencyframeworkid": 0,
"id": 0,
"timecreated": 0,
"timemodified": 0,
"usermodified": 0
}
]

list_course_competencies

List the competencies in a course

query Parameters

required

integer <int32>

The course id

Responses

200

list the competencies in a course

get/core_competency_list_course_competencies

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_competency_list_course_competencies

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_competency_list_course_competencies

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_competency_list_course_competencies

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"competency": 
{"shortname": "string",
"idnumber": "string",
"description": "string",
"descriptionformat": 1,
"sortorder": 0,
"parentid": 0,
"path": "string",
"ruleoutcome": 0,
"ruletype": "string",
"ruleconfig": "string",
"scaleid": 0,
"scaleconfiguration": "string",
"competencyframeworkid": "string",
"id": 0,
"timecreated": 0,
"timemodified": 0,
"usermodified": 0
},
"coursecompetency": 
{"courseid": 0,
"competencyid": 0,
"sortorder": 0,
"ruleoutcome": 0,
"id": 0,
"timecreated": 0,
"timemodified": 0,
"usermodified": 0
}
}
]

enrollment

get_courses_by_field

Get courses matching a specific field (id/s, shortname, idnumber, category)

query Parameters

field required	string The field to search can be left empty for all courses or: id: course id ids: comma separated course ids shortname: course short name idnumber: course id number category: category id the course belongs to
value	string The value to match

Responses

200

Get courses matching a specific field (id/s, shortname, idnumber, category)

get/core_course_get_courses_by_field

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_course_get_courses_by_field

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_course_get_courses_by_field

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_course_get_courses_by_field

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"id": 0,
"fullname": "string",
"displayname": "string",
"shortname": "string",
"categoryid": 0,
"categoryname": "string",
"sortorder": 0,
"summary": "string",
"summaryformat": 0,
"summaryfiles": 
[
{"filename": "string",
"filepath": "string",
"filesize": 0,
"fileurl": "string",
"timemodified": 0,
"mimetype": "string",
"isexternalfile": 0,
"repositorytype": "string"
}
],
"overviewfiles": 
[
{"filename": "string",
"filepath": "string",
"filesize": 0,
"fileurl": "string",
"timemodified": 0,
"mimetype": "string",
"isexternalfile": 0,
"repositorytype": "string"
}
],
"contacts": 
[
{"id": 0,
"fullname": "string"
}
],
"enrollmentmethods": 
["string"
],
"customfields": 
[
{"name": "string",
"shortname": "string",
"type": "string",
"value": "string"
}
],
"idnumber": "string",
"format": "string",
"showgrades": 0,
"newsitems": 0,
"startdate": 0,
"enddate": 0,
"maxbytes": 0,
"showreports": 0,
"visible": 0,
"groupmode": 0,
"groupmodeforce": 0,
"defaultgroupingid": 0,
"enablecompletion": 0,
"completionnotify": 0,
"lang": "string",
"theme": "string",
"marker": 0,
"legacyfiles": 0,
"calendartype": "string",
"timecreated": 0,
"timemodified": 0,
"requested": 0,
"cacherev": 0,
"filters": 
[
{"filter": "string",
"localstate": 0,
"inheritedstate": 0
}
],
"courseformatoptions": 
[
{"name": "string",
"value": "string"
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

core_course_get_courses

Return course details

query Parameters

options

Array of integers

List of course id. If empty return all courses except front page course.

Responses

200

return courses

get/core_course_get_courses

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_course_get_courses

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_course_get_courses

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_course_get_courses

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"id": 0,
"shortname": "string",
"categoryid": 0,
"categorysortorder": 0,
"fullname": "string",
"displayname": "string",
"idnumber": "string",
"summary": "string",
"summaryformat": 0,
"format": "string",
"showgrades": 0,
"newsitems": 0,
"startdate": 0,
"enddate": 0,
"numsections": 0,
"maxbytes": 0,
"showreports": 0,
"visible": 0,
"hiddensections": 0,
"groupmode": 0,
"groupmodeforce": 0,
"defaultgroupingid": 0,
"timecreated": 0,
"timemodified": 0,
"enablecompletion": 0,
"completionnotify": 0,
"lang": "string",
"forcetheme": "string",
"courseformatoptions": 
[
{"name": "string",
"value": "string"
}
],
"customfields": 
[
{"name": "string",
"shortname": "string",
"type": "string",
"value": "string"
}
]
}
]

get_tag_cloud

Retrieves a tag cloud for the given collection and/or query search.

query Parameters

tagcollid required	integer <int32> Tag collection id.
isstandard required	integer <int32> Whether to return only standard tags.
limit required	integer <int32> Default: 150 Maximum number of tags to retrieve. default 150
sort required	string Default: "name" Sort order for display (id, name, rawname, count, flag, isstandard, tagcollid).
search required	string Default: "" Search string.
fromctx required	integer Context id where this tag cloud is displayed
ctx required	integer Only retrieve tag instances in this context.
rec required	integer Default: 1 Retrieve tag instances in the $ctx context and it's children.

Responses

200

Retrieves a tag cloud for the given collection and/or query search.

get/core_tag_get_tag_cloud

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_tag_get_tag_cloud

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_tag_get_tag_cloud

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_tag_get_tag_cloud

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"tags": 
{"name": "string",
"viewurl": "string",
"flag": 0,
"isstandard": 0,
"count": 0,
"size": 0
},
"tagscount": 0,
"totalcount": 0,
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

get_users

search for users matching the parameters

query Parameters

criteria

required

Array of objects

the key/value pairs to be considered in user search. Values can not be empty. Specify different keys only once (fullname => 'user1', auth => 'manual', ...) - key occurences are forbidden. The search is executed with AND operator on the criterias. Invalid criterias (keys) are ignored, the search is still executed on the valid criterias. You can search without criteria, but the function is not designed for it. It could very slow or timeout. The function is designed to search some specific users.

Responses

200

search for users matching the parameters

get/core_user_get_users

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_user_get_users

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_user_get_users

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_user_get_users

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"id": 0,
"username": "string",
"firstname": "string",
"lastname": "string",
"fullname": "string",
"email": "string",
"address": "string",
"phone1": "string",
"phone2": "string",
"icq": "string",
"skype": "string",
"yahoo": "string",
"aim": "string",
"msn": "string",
"department": "string",
"institution": "string",
"idnumber": "string",
"interests": "string",
"firstaccess": 0,
"lastaccess": 0,
"auth": "string",
"suspended": 0,
"confirmed": 0,
"lang": "string",
"calendartype": "string",
"theme": "string",
"timezone": "string",
"mailformat": 0,
"description": "string",
"descriptionformat": 0,
"city": "string",
"url": "string",
"country": "string",
"profileimageurlsmall": "string",
"profileimageurl": "string",
"customfields": 
[
{"type": null,
"required": null,
"properties": null
}
],
"preferences": 
[
{"type": null,
"required": null,
"properties": null
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

update_users

Return list of seats available in a course

query Parameters

users

required

object

users

Responses

200

user updated successfully

get/core_user_update_users

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_user_update_users

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_user_update_users

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_user_update_users

create_user_enrollment

Return user application id

query Parameters

user_id required	integer <int32> user id
track_id required	integer <int32> track id
lang	string Results language [en (default), ar]

Responses

200

Return user application id

get/local_enrol_create_user_enrollment

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_create_user_enrollment

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_create_user_enrollment

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_create_user_enrollment

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"application_id": 0,
"form": 
[
{"fullname_ar": "string",
"fullname_en": "string",
"nationality_id": "string",
"birth_date": 0,
"edu_level_id": 0,
"major": "string",
"years_of_exp": 0,
"work_sector": "string",
"organization_id": 0,
"city_id": 0,
"job_title": "string",
"mobile": "string",
"cv_file": "string",
"has_us_visa": 0,
"us_visa_expiry": 0,
"has_uk_visa": 0,
"uk_visa_expiry": 0,
"has_schengen_visa": 0,
"schengen_visa_expiry": 0,
"has_other_visa": 0,
"other_countries_visa": 
["string"
],
"competencies_rates": 
[
{"competency_id": 0,
"rating": 0
}
],
"justification": "string",
"terms_conditions_agreement": 0,
"disclaimer_agreement": 0,
"status": 
{"id": 0,
"name": "string"
},
"supplements": 
[
{"text": "string",
"files": 
["string"
],
"timecreated": 0
}
]
}
],
"timecreated": 0,
"timemodified": 0,
"track_id": 0,
"current_step": "string",
"status": 
[
{"id": 0,
"name": "string",
"date": 0,
"message": "string"
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

get_seats

Return list of seats available in a course

query Parameters

courseid

required

integer <int32>

Course id

Responses

200

a list of available seats

get/local_enrol_get_seats

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_get_seats

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_get_seats

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_get_seats

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"total_seats": 0,
"reserved_seats": 0,
"remaining_seats": 0
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

get_user_enrollment_application

Return the history of specific user enrolment application

query Parameters

user_id required	integer <int32> user id
track_id required	integer <int32> track id
lang	string Results language [en (default), ar]

Responses

200

Return all enrolment applications for a specific user

get/local_enrol_get_user_enrollment_application

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_get_user_enrollment_application

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_get_user_enrollment_application

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_get_user_enrollment_application

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"application_id": 0,
"timecreated": 0,
"timemodified": 0,
"track_id": 0,
"current_step": "string",
"statuses": 
[
{"id": 0,
"name": "string",
"message": "string",
"form": 
[
{"fullname_ar": "string",
"fullname_en": "string",
"nationality_id": "string",
"birth_date": 0,
"edu_level_id": 0,
"major": "string",
"years_of_exp": 0,
"work_sector": "string",
"organization_id": 0,
"city_id": 0,
"job_title": "string",
"mobile": "string",
"cv_file": "string",
"has_us_visa": 0,
"us_visa_expiry": 0,
"has_uk_visa": 0,
"uk_visa_expiry": 0,
"has_schengen_visa": 0,
"schengen_visa_expiry": 0,
"has_other_visa": 0,
"other_countries_visa": 
["string"
],
"competencies_rates": 
[
{"competency_id": 0,
"rating": 0
}
],
"justification": "string",
"terms_conditions_agreement": 0,
"disclaimer_agreement": 0,
"status": 
{"id": 0,
"name": "string"
},
"supplements": 
[
{"text": "string",
"files": 
["string"
],
"timecreated": 0
}
]
}
],
"timecreated": 0
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

get_user_enrollment_applications

Return all enrolment applications for a specific user

query Parameters

user_id required	integer <int32> user id
lang	string Results language [en (default), ar]

Responses

200

Return all enrolment applications for a specific user

get/local_enrol_get_user_enrollment_applications

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_get_user_enrollment_applications

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_get_user_enrollment_applications

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_get_user_enrollment_applications

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"application_id": 0,
"form": 
[
{"fullname_ar": "string",
"fullname_en": "string",
"nationality_id": "string",
"birth_date": 0,
"edu_level_id": 0,
"major": "string",
"years_of_exp": 0,
"work_sector": "string",
"organization_id": 0,
"city_id": 0,
"job_title": "string",
"mobile": "string",
"cv_file": "string",
"has_us_visa": 0,
"us_visa_expiry": 0,
"has_uk_visa": 0,
"uk_visa_expiry": 0,
"has_schengen_visa": 0,
"schengen_visa_expiry": 0,
"has_other_visa": 0,
"other_countries_visa": 
["string"
],
"competencies_rates": 
[
{"competency_id": 0,
"rating": 0
}
],
"justification": "string",
"terms_conditions_agreement": 0,
"disclaimer_agreement": 0,
"status": 
{"id": 0,
"name": "string"
},
"supplements": 
[
{"text": "string",
"files": 
["string"
],
"timecreated": 0
}
]
}
],
"timecreated": 0,
"timemodified": 0,
"track_id": 0,
"current_step": "string",
"status": 
[
{"id": 0,
"name": "string",
"date": 0,
"message": "string"
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

get_user_enrollment_application

Return the history of specific user enrolment application

query Parameters

user_id required	integer <int32> userid (Default to "null")
track_id required	integer <int32> userid
lang	string Track ID

Responses

200

get user enrollment applications

get/local_govx_get_user_enrollment_application

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_user_enrollment_application

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_user_enrollment_application

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_user_enrollment_application

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"application_id": 0,
"track_id": 0,
"form": 
[
{"fullname_ar": "string",
"fullname_en": "string",
"nationality_id": "string",
"birth_date": 0,
"edu_level_id": 0,
"major": "string",
"years_of_exp": 0,
"work_sector": "string",
"organization_id": 0,
"city_id": 0,
"job_title": "string",
"mobile": "string",
"cv_file": "string",
"has_us_visa": 0,
"us_visa_expiry": 0,
"has_uk_visa": 0,
"uk_visa_expiry": 0,
"has_schengen_visa": 0,
"schengen_visa_expiry": 0,
"has_other_visa": 0,
"other_countries_visa": 
["string"
],
"competencies_rates": 
[
{"competency_id": 0,
"rating": 0
}
],
"justification": "string",
"terms_conditions_agreement": 0,
"disclaimer_agreement": 0,
"status": 
{"id": 0,
"name": "string"
},
"supplements": 
[
{"text": "string",
"files": 
["string"
]
}
]
}
],
"status": 
[
{"id": 0,
"name": "string",
"message": "string",
"timecreated": 0
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

get_user_enrollment_applications

Return all enrolment applications for a specific user

query Parameters

userid required	integer <int32> userid (Default to "null")
lang	string Results language [en (default), ar]

Responses

200

user enrollment application

get/local_govx_get_user_enrollment_applications

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_user_enrollment_applications

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_user_enrollment_applications

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_user_enrollment_applications

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"application_id": 0,
"track_id": 0,
"form": 
[
{"fullname_ar": "string",
"fullname_en": "string",
"nationality_id": "string",
"birth_date": 0,
"edu_level_id": 0,
"major": "string",
"years_of_exp": 0,
"work_sector": "string",
"organization_id": 0,
"city_id": 0,
"job_title": "string",
"mobile": "string",
"cv_file": "string",
"has_us_visa": 0,
"us_visa_expiry": 0,
"has_uk_visa": 0,
"uk_visa_expiry": 0,
"has_schengen_visa": 0,
"schengen_visa_expiry": 0,
"has_other_visa": 0,
"other_countries_visa": 
["string"
],
"competencies_rates": 
[
{"competency_id": 0,
"rating": 0
}
],
"justification": "string",
"terms_conditions_agreement": 0,
"disclaimer_agreement": 0,
"status": 
{"id": 0,
"name": "string"
},
"supplements": 
[
{"text": "string",
"files": 
["string"
],
"timecreated": 0
}
]
}
],
"status": 
[
{"id": 0,
"name": "string",
"date": 0,
"message": "string"
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

get_user_interests

Return list of user interests

query Parameters

userid

required

integer <int32>

userid (Default to "null")

Responses

200

a list of programs

get/local_govx_get_user_interests

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_user_interests

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_user_interests

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_user_interests

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"id": "string",
"name": "string"
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

get_interviews

Return list of interviews

query Parameters

userid

required

integer <int32>

userid (Default to "null")

Responses

200

a list of interviews

get/local_govx_get_interviews

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_interviews

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_interviews

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_interviews

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"id": 0,
"datatime": 0,
"trackid": 0,
"instructions": "string"
}
]

update_user_enrollment_supplement

Attach additional information to an application put to "on-hold"

query Parameters

application_id required	integer <int32> userid (Default to "null")
text required	string Does the delegate agree on the terms and conditions?
files	Array of integers Array of attached files' item_id
lang	string lang en, ar

Responses

200

update user enrollment

post/local_govx_update_user_enrollment_supplement

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_update_user_enrollment_supplement

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_update_user_enrollment_supplement

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_update_user_enrollment_supplement

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"is_valid": 0,
"form": 
[
{"fullname_ar": "string",
"fullname_en": "string",
"nationality_id": "string",
"birth_date": 0,
"edu_level_id": 0,
"major": "string",
"years_of_exp": 0,
"work_sector": "string",
"organization_id": 0,
"city_id": 0,
"job_title": "string",
"mobile": "string",
"cv_file": "string",
"has_us_visa": 0,
"us_visa_expiry": 0,
"has_uk_visa": 0,
"uk_visa_expiry": 0,
"has_schengen_visa": 0,
"schengen_visa_expiry": 0,
"has_other_visa": 0,
"other_countries_visa": 
["string"
],
"competencies_rates": 
[
{"competency_id": 0,
"rating": 0
}
],
"justification": "string",
"terms_conditions_agreement": 0,
"disclaimer_agreement": 0,
"status": 
{"id": 0,
"name": "string"
},
"supplements": 
[
{"text": "string",
"files": 
["string"
]
}
]
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

update_enrollment_step_1

First step of updating a created application

query Parameters

application_id required	integer <int32> userid (Default to "null")
fullname_ar required	string Delegate name in Arabic
fullname_en required	string Delegate name in English
nationality_id required	string The short code of country
birth_date required	integer Delegate's birth date (timestamp)
lang	string lang en, ar

Responses

200

update user enrollment

get/local_enrol_update_enrollment_step_1

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_1

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_1

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_1

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"application_id": 0,
"form": 
[
{"fullname_ar": "string",
"fullname_en": "string",
"nationality_id": "string",
"birth_date": 0,
"edu_level_id": 0,
"major": "string",
"years_of_exp": 0,
"work_sector": "string",
"organization_id": 0,
"city_id": 0,
"job_title": "string",
"mobile": "string",
"cv_file": "string",
"has_us_visa": 0,
"us_visa_expiry": 0,
"has_uk_visa": 0,
"uk_visa_expiry": 0,
"has_schengen_visa": 0,
"schengen_visa_expiry": 0,
"has_other_visa": 0,
"other_countries_visa": 
["string"
],
"competencies_rates": 
[
{"competency_id": 0,
"rating": 0
}
],
"justification": "string",
"terms_conditions_agreement": 0,
"disclaimer_agreement": 0,
"status": 
{"id": 0,
"name": "string"
},
"supplements": 
[
{"text": "string",
"files": 
["string"
]
}
]
}
],
"timecreated": 0,
"timemodified": 0,
"track_id": 0,
"current_step": "string",
"status": 
[
{"id": 0,
"name": "string",
"message": "string",
"timecreated": 0
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

update_enrollment_step_2

Second step of updating a created application

query Parameters

application_id required	integer <int32> userid (Default to "null")
edu_level_id required	integer Education level id
major required	string Education major name
years_of_exp required	integer Experience years
work_sector required	string Work sector [Government, Semi Government]
organization_id required	integer Organization ID
city_id required	integer City ID
job_title required	string Delegate's job title
lang	string lang en, ar

Responses

200

update user enrollment

get/local_enrol_update_enrollment_step_2

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_2

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_2

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_2

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"application_id": 0,
"form": 
[
{"fullname_ar": "string",
"fullname_en": "string",
"nationality_id": "string",
"birth_date": 0,
"edu_level_id": 0,
"major": "string",
"years_of_exp": 0,
"work_sector": "string",
"organization_id": 0,
"city_id": 0,
"job_title": "string",
"mobile": "string",
"cv_file": "string",
"has_us_visa": 0,
"us_visa_expiry": 0,
"has_uk_visa": 0,
"uk_visa_expiry": 0,
"has_schengen_visa": 0,
"schengen_visa_expiry": 0,
"has_other_visa": 0,
"other_countries_visa": 
["string"
],
"competencies_rates": 
[
{"competency_id": 0,
"rating": 0
}
],
"justification": "string",
"terms_conditions_agreement": 0,
"disclaimer_agreement": 0,
"status": 
{"id": 0,
"name": "string"
},
"supplements": 
[
{"text": "string",
"files": 
["string"
]
}
]
}
],
"timecreated": 0,
"timemodified": 0,
"track_id": 0,
"current_step": "string",
"status": 
[
{"id": 0,
"name": "string",
"message": "string",
"timecreated": 0
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

update_enrollment_step_3

Third step of updating a created application

query Parameters

application_id required	integer <int32> userid (Default to "null")
track_id required	integer Selected track ID
mobile required	string Delegate mobile number
cv_file required	integer The CV file item_id
lang	string lang en, ar

Responses

200

update user enrollment

get/local_enrol_update_enrollment_step_3

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_3

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_3

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_3

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"application_id": 0,
"form": 
[
{"fullname_ar": "string",
"fullname_en": "string",
"nationality_id": "string",
"birth_date": 0,
"edu_level_id": 0,
"major": "string",
"years_of_exp": 0,
"work_sector": "string",
"organization_id": 0,
"city_id": 0,
"job_title": "string",
"mobile": "string",
"cv_file": "string",
"has_us_visa": 0,
"us_visa_expiry": 0,
"has_uk_visa": 0,
"uk_visa_expiry": 0,
"has_schengen_visa": 0,
"schengen_visa_expiry": 0,
"has_other_visa": 0,
"other_countries_visa": 
["string"
],
"competencies_rates": 
[
{"competency_id": 0,
"rating": 0
}
],
"justification": "string",
"terms_conditions_agreement": 0,
"disclaimer_agreement": 0,
"status": 
{"id": 0,
"name": "string"
},
"supplements": 
[
{"text": "string",
"files": 
["string"
]
}
]
}
],
"timecreated": 0,
"timemodified": 0,
"track_id": 0,
"current_step": "string",
"status": 
[
{"id": 0,
"name": "string",
"message": "string",
"timecreated": 0
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

update_enrollment_step_4

Fourth step of updating a created application

query Parameters

application_id required	integer <int32> userid (Default to "null")
has_us_visa	integer Does the delegate has a valid US visa?
us_visa_expiry	integer The US visa expiration date (timestamp)
has_uk_visa	integer Does the delegate has a valid UK visa?
uk_visa_expiry required	integer The UK visa expiration date (timestamp)
has_schengen_visa	integer Does the delegate has a valid Schengen visa?
schengen_visa_expiry	integer The Schengen visa expiration date (timestamp)
has_other_visa required	integer Does the delegate has any valid visa?
other_countries_visa required	Array of strings Array of countries' codes that the delegate has valid visa of them
lang	string lang en, ar

Responses

200

update user enrollment

get/local_enrol_update_enrollment_step_4

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_4

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_4

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_4

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"application_id": 0,
"form": 
[
{"fullname_ar": "string",
"fullname_en": "string",
"nationality_id": "string",
"birth_date": 0,
"edu_level_id": 0,
"major": "string",
"years_of_exp": 0,
"work_sector": "string",
"organization_id": 0,
"city_id": 0,
"job_title": "string",
"mobile": "string",
"cv_file": "string",
"has_us_visa": 0,
"us_visa_expiry": 0,
"has_uk_visa": 0,
"uk_visa_expiry": 0,
"has_schengen_visa": 0,
"schengen_visa_expiry": 0,
"has_other_visa": 0,
"other_countries_visa": 
["string"
],
"competencies_rates": 
[
{"competency_id": 0,
"rating": 0
}
],
"justification": "string",
"terms_conditions_agreement": 0,
"disclaimer_agreement": 0,
"status": 
{"id": 0,
"name": "string"
},
"supplements": 
[
{"text": "string",
"files": 
["string"
]
}
]
}
],
"timecreated": 0,
"timemodified": 0,
"track_id": 0,
"current_step": "string",
"status": 
[
{"id": 0,
"name": "string",
"message": "string",
"timecreated": 0
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

update_enrollment_step_5

Fifth step of updating a created application

query Parameters

application_id required	integer <int32> userid (Default to "null")
competencies_rates required	Array of objects Array of competencies IDs and the rating value;[{"competency_id":1, "rating":5},...]
justification required	string Delegate's nomination justification
lang	string lang en, ar

Responses

200

update user enrollment

get/local_enrol_update_enrollment_step_5

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_5

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_5

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_5

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"application_id": 0,
"form": 
[
{"fullname_ar": "string",
"fullname_en": "string",
"nationality_id": "string",
"birth_date": 0,
"edu_level_id": 0,
"major": "string",
"years_of_exp": 0,
"work_sector": "string",
"organization_id": 0,
"city_id": 0,
"job_title": "string",
"mobile": "string",
"cv_file": "string",
"has_us_visa": 0,
"us_visa_expiry": 0,
"has_uk_visa": 0,
"uk_visa_expiry": 0,
"has_schengen_visa": 0,
"schengen_visa_expiry": 0,
"has_other_visa": 0,
"other_countries_visa": 
["string"
],
"competencies_rates": 
[
{"competency_id": 0,
"rating": 0
}
],
"justification": "string",
"terms_conditions_agreement": 0,
"disclaimer_agreement": 0,
"status": 
{"id": 0,
"name": "string"
},
"supplements": 
[
{"text": "string",
"files": 
["string"
]
}
]
}
],
"timecreated": 0,
"timemodified": 0,
"track_id": 0,
"current_step": "string",
"status": 
[
{"id": 0,
"name": "string",
"message": "string",
"timecreated": 0
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

update_enrollment_step_6

Sixth step of updating a created application

query Parameters

application_id required	integer <int32> userid (Default to "null")
terms_conditions_agreement required	integer <int32> Does the delegate agree on the terms and conditions?
disclaimer_agreement required	integer <int32> Does the delegate agree on the disclaimer?
lang	string lang en, ar

Responses

200

update user enrollment

get/local_enrol_update_enrollment_step_6

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_6

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_6

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_enrollment_step_6

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"application_id": 0,
"form": 
[
{"fullname_ar": "string",
"fullname_en": "string",
"nationality_id": "string",
"birth_date": 0,
"edu_level_id": 0,
"major": "string",
"years_of_exp": 0,
"work_sector": "string",
"organization_id": 0,
"city_id": 0,
"job_title": "string",
"mobile": "string",
"cv_file": "string",
"has_us_visa": 0,
"us_visa_expiry": 0,
"has_uk_visa": 0,
"uk_visa_expiry": 0,
"has_schengen_visa": 0,
"schengen_visa_expiry": 0,
"has_other_visa": 0,
"other_countries_visa": 
["string"
],
"competencies_rates": 
[
{"competency_id": 0,
"rating": 0
}
],
"justification": "string",
"terms_conditions_agreement": 0,
"disclaimer_agreement": 0,
"status": 
{"id": 0,
"name": "string"
},
"supplements": 
[
{"text": "string",
"files": 
["string"
]
}
]
}
],
"timecreated": 0,
"timemodified": 0,
"track_id": 0,
"current_step": "string",
"status": 
[
{"id": 0,
"name": "string",
"message": "string",
"timecreated": 0
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

update_user_enrollment_supplement

Attach additional information to an application put to "on-hold"

query Parameters

application_id required	integer <int32> Application ID
track_id required	integer <int32> Track ID
text required	string Does the delegate agree on the terms and conditions?
files required	Array of integers Array of attached files' item_id
lang	string lang en, ar

Responses

200

update user enrollment

get/local_enrol_update_user_enrollment_supplement

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_user_enrollment_supplement

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_user_enrollment_supplement

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_update_user_enrollment_supplement

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"application_id": 0,
"form": 
[
{"fullname_ar": "string",
"fullname_en": "string",
"nationality_id": "string",
"birth_date": 0,
"edu_level_id": 0,
"major": "string",
"years_of_exp": 0,
"work_sector": "string",
"organization_id": 0,
"city_id": 0,
"job_title": "string",
"mobile": "string",
"cv_file": "string",
"has_us_visa": 0,
"us_visa_expiry": 0,
"has_uk_visa": 0,
"uk_visa_expiry": 0,
"has_schengen_visa": 0,
"schengen_visa_expiry": 0,
"has_other_visa": 0,
"other_countries_visa": 
["string"
],
"competencies_rates": 
[
{"competency_id": 0,
"rating": 0
}
],
"justification": "string",
"terms_conditions_agreement": 0,
"disclaimer_agreement": 0,
"status": 
{"id": 0,
"name": "string"
},
"supplements": 
[
{"text": "string",
"files": 
["string"
]
}
]
}
],
"timecreated": 0,
"timemodified": 0,
"track_id": 0,
"current_step": "string",
"status": 
[
{"id": 0,
"name": "string",
"message": "string",
"timecreated": 0
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

create_user_enrollment

Return user application id

query Parameters

user_id required	integer <int32> userid (Default to "null")
track_id required	integer <int32> Track id
lang	string lang en, ar

Responses

200

Return user application id

get/local_govx_create_user_enrollment

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_create_user_enrollment

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_create_user_enrollment

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_create_user_enrollment

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"application_id": 0,
"form": 
{"fullname_ar": "string",
"fullname_en": "string",
"nationality_id": "string",
"birth_date": 0,
"edu_level_id": 0,
"major": "string",
"years_of_exp": 0,
"work_sector": "string",
"organization_id": 0,
"city_id": 0,
"job_title": "string",
"mobile": "string",
"cv_file": "string",
"has_us_visa": 0,
"us_visa_expiry": 0,
"has_uk_visa": 0,
"uk_visa_expiry": 0,
"has_schengen_visa": 0,
"schengen_visa_expiry": 0,
"has_other_visa": 0,
"other_countries_visa": 
["string"
],
"competencies_rates": 
[
{"competency_id": 0,
"rating": 0
}
],
"justification": "string",
"terms_conditions_agreement": 0,
"disclaimer_agreement": 0,
"status": 
{"id": 0,
"name": "string"
},
"supplements": 
[
{"text": "string",
"files": 
["string"
]
}
]
},
"status": 
{"id": 0,
"name": "string",
"message": "string",
"timecreated": 0
}
}
]

local_enrol_interview

Return list of interview

query Parameters

userid

required

integer <int32>

User id

Responses

200

List of user interviews

get/local_enrol_interview

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_interview

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_interview

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_enrol_interview

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"id": 0,
"application_id": 0,
"method": "string",
"details": "string",
"datetime": "string",
"course_name": "string",
"interviewer1": "string",
"interviewer2": "string",
"interviewer3": "string"
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

local_govx_get_course_overview

Covers the required data in the "about" tab of course page

query Parameters

userid required	integer <int32> User id
courseid required	integer Course ID

Responses

200

get the course overview

get/local_govx_get_course_overview

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_course_overview

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_course_overview

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_course_overview

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"id": 0,
"likes": 0,
"bookmarks": 0,
"shares": 0,
"is_liked": 0,
"is_bookmarked": 0,
"is_shared": 0,
"rating": 0,
"title": "string",
"featured_media_url": "string",
"about": "string",
"objectives": "string",
"outcome": "string",
"eligibility": "string",
"skills_gained": "string",
"mode": "string",
"topics": 
[
{"mode": "string",
"title": "string",
"short_description": "string",
"date": 0
}
],
"instructors": 
[
{"id": 0,
"name": "string",
"job": "string",
"employer": "string",
"image_url": "string"
}
],
"contact_person": 
[
{"id": 0,
"name": "string",
"phone": "string",
"email": "string"
}
],
"top_reviews": 
[
{"id": 0,
"name": "string",
"review": "string",
"rating": 0
}
],
"top_faqs": 
[
{"id": 0,
"question": "string",
"answer": "string"
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

core_enrol_get_users_courses

Get the list of courses where a user is enrolled in

query Parameters

userid required	integer <int32>
returnusercount	integer <int32> Default: 1 Include count of enrolled users for each course? This can add several seconds to the response time if a user is on several large courses, so set this to false if the value will not be used to improve performance.

Responses

200

return enroled users courses

get/core_enrol_get_users_courses

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_enrol_get_users_courses

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_enrol_get_users_courses

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/core_enrol_get_users_courses

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"id": 0,
"shortname": "string",
"enrolledusercount": 0,
"category": "string",
"fullname": "string",
"displayname": "string",
"idnumber": "string",
"summary": "string",
"summaryformat": 0,
"format": "string",
"showgrades": 0,
"completed": 0,
"startdate": 0,
"enddate": 0,
"marker": 0,
"lastaccess": 0,
"visible": 0,
"hidden": 0,
"completionusertracked": 0,
"timecreated": 0,
"progress": null,
"enablecompletion": 0,
"completionhascriteria": 0,
"lang": "string",
"isfavourite": 0,
"overviewfiles": 
[
{"filename": "string",
"filepath": "string",
"filesize": 0,
"fileurl": "string",
"timemodified": 0,
"mimetype": "string",
"isexternalfile": 0,
"repositorytype": "string"
}
]
}
]

feedback

get_feedback_by_user

Return list of user feedback

query Parameters

userid required	integer <int32> userid (Default to "null")
status required	string Default: "pending" default is pending

Responses

200

a list of programs

get/local_govx_feedback_get_feedback_by_user

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_feedback_get_feedback_by_user

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_feedback_get_feedback_by_user

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_feedback_get_feedback_by_user

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"feedbacks": 
{"id": 0,
"course": 0,
"name": "string",
"intro": "string",
"introformat": 0,
"anonymous": 0,
"email_notification": 0,
"multiple_submit": 0,
"autonumbering": 0,
"site_after_submit": "string",
"page_after_submit": "string",
"page_after_submitformat": 0,
"publish_stats": 0,
"timeopen": 0,
"timeclose": 0,
"timemodified": 0,
"completionsubmit": 0,
"coursemodule": 0,
"introfiles": [ ],
"pageaftersubmitfiles": [ ]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

get_feedbacks_by_courses

Return list of courses feedback

query Parameters

courseids

required

Array of Array of objects

ucourseids (Default to "null")

Responses

200

a list of programs

get/mod_feedback_get_feedbacks_by_courses

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/mod_feedback_get_feedbacks_by_courses

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/mod_feedback_get_feedbacks_by_courses

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/mod_feedback_get_feedbacks_by_courses

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"feedbacks": 
{"id": 0,
"course": 0,
"name": "string",
"intro": "string",
"introformat": 0,
"anonymous": 0,
"email_notification": 0,
"multiple_submit": 0,
"autonumbering": 0,
"site_after_submit": "string",
"page_after_submit": "string",
"page_after_submitformat": 0,
"publish_stats": 0,
"timeopen": 0,
"timeclose": 0,
"timemodified": 0,
"completionsubmit": 0,
"coursemodule": 0,
"introfiles": [ ],
"pageaftersubmitfiles": [ ]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

mod_feedback_get_page_items

Get a single feedback page items.

query Parameters

feedbackid required	integer <int32> Feedback instance id
page required	integer The page to get starting by 0
courseid	integer Course where user completes the feedback (for site feedbacks only).

Responses

200

List of feedback items

get/mod_feedback_get_page_items

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/mod_feedback_get_page_items

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/mod_feedback_get_page_items

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/mod_feedback_get_page_items

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"items": 
{"id": 0,
"feedback": 0,
"template": 0,
"name": "string",
"label": "string",
"presentation": "string",
"typ": "string",
"hasvalue": 0,
"position": 0,
"required": 0,
"dependitem": 0,
"dependvalue": "string",
"options": "string",
"itemfiles": 
[
{"contectid": 0,
"compnent": "string",
"filearea": "string",
"itemid": 0,
"filepath": "string",
"filename": "string",
"isdir": 0,
"isimage": 0,
"timemodified": 0,
"timecreated": 0,
"filesize": 0,
"author": "string",
"license": "string",
"filenameshort": "string",
"filesizeformatted": "string",
"icon": "string",
"timecreatedformatted": "string",
"timemodifiedformatted": "string",
"url": "string"
}
],
"itemnumber": 0,
"otherdata": "string"
},
"hasprevpage": 0,
"hasnextpage": 0,
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

mod_feedback_process_page

Process a jump between pages.

query Parameters

feedbackid required	integer <int32> Feedback instance id.
page required	integer <int32> The page being processed.
responses	Array of objects The data to be processed.
goprevious	integer Whether we want to jump to previous page.
courseid	integer Course where user completes the feedback (for site feedbacks only).

Responses

200

a list of available seats

get/mod_feedback_process_page

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/mod_feedback_process_page

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/mod_feedback_process_page

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/mod_feedback_process_page

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"jumpto": 0,
"completed": 0,
"completionpagecontents": "string",
"siteaftersubmit": "string",
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

metadata

get_cities

Return list of cities

query Parameters

lang

required

string

Default: "en"

Results language [en (default), ar]

Responses

200

Return list of cities

get/local_govx_get_cities

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_cities

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_cities

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_cities

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"id": 0,
"name": "string"
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

get_degrees

Return list of user degrees

query Parameters

lang

required

string

Default: "en"

Results language [en (default), ar]

Responses

200

a list of degrees

get/local_govx_get_degrees

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_degrees

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_degrees

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_degrees

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
[
{"id": 0,
"name": "string"
}
],
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

get_nationalities

Return list of nationalities

Responses

200

Return list of cities

get/local_govx_get_nationalities

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_nationalities

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_nationalities

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_nationalities

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"short_code": "string",
"name": "string"
}
]

get_organizations

Return list of organizations

query Parameters

lang

required

string

Default: "en"

Results language [en (default), ar]

Responses

200

a list of organizations

get/local_govx_get_organizations

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_organizations

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_organizations

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_organizations

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
[
{"id": 0,
"name": "string"
}
],
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

get_discussions

Returns a list of discussions of specific course

query Parameters

courseid

required

integer <int32>

course id

Responses

200

a list of discussions

get/local_govx_get_discussions

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_discussions

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_discussions

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_discussions

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"forum_id": 0,
"discussions": 
[
{"id": 0,
"subject": "string",
"message": "string",
"num_threads": 0
}
]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

tracks

get_programs

Return list of programs

query Parameters

lang

required

string

Default: "en"

Results language [en (default), ar]

Responses

200

a list of programs

get/local_govx_get_programs

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_programs

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_programs

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_programs

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
[
{"id": 0,
"name": "string",
"about": "string",
"sort_order": 0,
"image": "string",
"catagory": "string"
}
],
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

get_seats

Return list of seats available in a course

query Parameters

userid

required

integer <int32>

userid (Default to "null")

Responses

200

a list of available seats

get/local_govx_get_seats

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_seats

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_seats

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_seats

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"total_seats": 0,
"reserved_seats": 0,
"remaining_seats": 0
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

get_tracks

Return list of tracks

query Parameters

program_id required	integer <int32> The program ID (represents idnumber field in moodle)
lang required	string Default: "en" Results language [en (default), ar]

Responses

200

a list of programs

get/local_govx_get_tracks

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_tracks

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_tracks

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/local_govx_get_tracks

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"data": 
{"id": 0,
"name": "string",
"sort_order": 0,
"summary": "string",
"image": "string",
"eligibility": "string",
"campus": 0,
"online": 0,
"workshop": 0,
"details": "string",
"course_details": "string",
"terms_conditions": "string",
"available_seats": "string",
"areas_of_interest": [ ],
"courses": [ ]
},
"warnings": 
{"item": "string",
"itemid": 0,
"warningcode": "string",
"message": "string"
}
}
]

notifications

get_popup_notifications

Retrieve a list of popup notifications for a user

query Parameters

useridto required	integer <int32> the user id who received the message, 0 for current user
newestfirst	integer Default: 1 true for ordering by newest first, false for oldest first
limit	integer Default: 0 the number of results to return
offset	integer Default: 0 offset the result set by a given amount

Responses

200

Retrieve a list of popup notifications for a user

get/message_popup_get_popup_notifications

Eummena's internal development server

https://dev1.eummena.org//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/message_popup_get_popup_notifications

The development instance on Deloitte's side

https://app1.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/message_popup_get_popup_notifications

The user acceptance testing (UAT) instance

https://app1uat.dtme.dev//webservice/rest/server.php?moodlewsrestformat=json&wsfunction=/message_popup_get_popup_notifications

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"notifications": 
{"id": 0,
"useridfrom": 0,
"useridto": 0,
"subject": "string",
"shortenedsubject": "string",
"text": "string",
"fullmessage": "string",
"fullmessageformat": 0,
"fullmessagehtml": "string",
"smallmessage": "string",
"contexturl": "string",
"contexturlname": "string",
"timecreated": 0,
"timecreatedpretty": "string",
"timeread": 0,
"read": 0,
"deleted": 0,
"iconurl": "string",
"component": "string",
"eventtype": "string",
"customdata": "string"
},
"unreadcount": 0
}
]