Module API
API change historyList of APIs related to Module - Module Settings (Description, Facilitators, Readings, Weblinks), Details, Chat (TeamUp)
Search modules
To search LumiNUS modules based on filters.
Allow search for Non-Academic Modules which are active (ie. published, open and not expired).
Try itRequest
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
Filters for search modules
{
"isCorporateCourse": true,
"isMandatory": false,
"name_CourseName_LecturerName": "string",
"facultyCode": [
"string"
],
"departmentCode": [
"string"
],
"facultyIDsOrDepartmentIDs": [
"string"
],
"terms": [
"string"
],
"listOperations": {
"sortby": "string",
"offset": 0,
"limit": 0,
"where": "string"
},
"populate": "string"
}{
"description": "HTTP Post Input class when searching module",
"type": "object",
"properties": {
"isCorporateCourse": {
"description": "If it is a self-enrolment (not mandatory) non-academic module.",
"type": "boolean"
},
"isMandatory": {
"description": "If it is a mandatory (not self-enrolment) non-academic module.",
"default": false,
"type": "boolean"
},
"name_CourseName_LecturerName": {
"description": "Module Code, Module Title or Name of Lecturer",
"type": "string"
},
"facultyCode": {
"description": "List of faculty codes for the faculties of modules",
"type": "array",
"items": {
"type": "string"
}
},
"departmentCode": {
"description": "List of department codes for the departments of modules",
"type": "array",
"items": {
"type": "string"
}
},
"facultyIDsOrDepartmentIDs": {
"description": "GUIDs of the module faculties or departments",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"terms": {
"description": "List of Term Codes",
"type": "array",
"items": {
"type": "string"
}
},
"listOperations": {
"description": "Optional parameters for Sorting, paging and filtering",
"allOf": [
{
"type": "object",
"properties": {
"sortby": {
"type": "string"
},
"offset": {
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"type": "integer"
},
"limit": {
"format": "int32",
"maximum": 10000,
"minimum": 1,
"type": "integer"
},
"where": {
"type": "string"
}
}
}
]
},
"populate": {
"description": "Accepted populate entities: faculty, department. Accepted populate entities if user is authenticated: creator, lastUpdatedUser, faculty, department, manager, weblecture, termDetail",
"type": "string"
}
}
}{
"isCorporateCourse": true,
"isMandatory": false,
"name_CourseName_LecturerName": "string",
"facultyCode": [
"string"
],
"departmentCode": [
"string"
],
"facultyIDsOrDepartmentIDs": [
"string"
],
"terms": [
"string"
],
"listOperations": {
"sortby": "string",
"offset": 0,
"limit": 0,
"where": "string"
},
"populate": "string"
}{
"description": "HTTP Post Input class when searching module",
"type": "object",
"properties": {
"isCorporateCourse": {
"description": "If it is a self-enrolment (not mandatory) non-academic module.",
"type": "boolean"
},
"isMandatory": {
"description": "If it is a mandatory (not self-enrolment) non-academic module.",
"default": false,
"type": "boolean"
},
"name_CourseName_LecturerName": {
"description": "Module Code, Module Title or Name of Lecturer",
"type": "string"
},
"facultyCode": {
"description": "List of faculty codes for the faculties of modules",
"type": "array",
"items": {
"type": "string"
}
},
"departmentCode": {
"description": "List of department codes for the departments of modules",
"type": "array",
"items": {
"type": "string"
}
},
"facultyIDsOrDepartmentIDs": {
"description": "GUIDs of the module faculties or departments",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"terms": {
"description": "List of Term Codes",
"type": "array",
"items": {
"type": "string"
}
},
"listOperations": {
"description": "Optional parameters for Sorting, paging and filtering",
"allOf": [
{
"type": "object",
"properties": {
"sortby": {
"type": "string"
},
"offset": {
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"type": "integer"
},
"limit": {
"format": "int32",
"maximum": 10000,
"minimum": 1,
"type": "integer"
},
"where": {
"type": "string"
}
}
}
]
},
"populate": {
"description": "Accepted populate entities: faculty, department. Accepted populate entities if user is authenticated: creator, lastUpdatedUser, faculty, department, manager, weblecture, termDetail",
"type": "string"
}
}
}{
"isCorporateCourse": true,
"isMandatory": false,
"name_CourseName_LecturerName": "string",
"facultyCode": [
"string"
],
"departmentCode": [
"string"
],
"facultyIDsOrDepartmentIDs": [
"string"
],
"terms": [
"string"
],
"listOperations": {
"sortby": "string",
"offset": 0,
"limit": 0,
"where": "string"
},
"populate": "string"
}{
"description": "HTTP Post Input class when searching module",
"type": "object",
"properties": {
"isCorporateCourse": {
"description": "If it is a self-enrolment (not mandatory) non-academic module.",
"type": "boolean"
},
"isMandatory": {
"description": "If it is a mandatory (not self-enrolment) non-academic module.",
"default": false,
"type": "boolean"
},
"name_CourseName_LecturerName": {
"description": "Module Code, Module Title or Name of Lecturer",
"type": "string"
},
"facultyCode": {
"description": "List of faculty codes for the faculties of modules",
"type": "array",
"items": {
"type": "string"
}
},
"departmentCode": {
"description": "List of department codes for the departments of modules",
"type": "array",
"items": {
"type": "string"
}
},
"facultyIDsOrDepartmentIDs": {
"description": "GUIDs of the module faculties or departments",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"terms": {
"description": "List of Term Codes",
"type": "array",
"items": {
"type": "string"
}
},
"listOperations": {
"description": "Optional parameters for Sorting, paging and filtering",
"allOf": [
{
"type": "object",
"properties": {
"sortby": {
"type": "string"
},
"offset": {
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"type": "integer"
},
"limit": {
"format": "int32",
"maximum": 10000,
"minimum": 1,
"type": "integer"
},
"where": {
"type": "string"
}
}
}
]
},
"populate": {
"description": "Accepted populate entities: faculty, department. Accepted populate entities if user is authenticated: creator, lastUpdatedUser, faculty, department, manager, weblecture, termDetail",
"type": "string"
}
}
}{
"isCorporateCourse": true,
"isMandatory": false,
"name_CourseName_LecturerName": "string",
"facultyCode": [
"string"
],
"departmentCode": [
"string"
],
"facultyIDsOrDepartmentIDs": [
"string"
],
"terms": [
"string"
],
"listOperations": {
"sortby": "string",
"offset": 0,
"limit": 0,
"where": "string"
},
"populate": "string"
}{
"description": "HTTP Post Input class when searching module",
"type": "object",
"properties": {
"isCorporateCourse": {
"description": "If it is a self-enrolment (not mandatory) non-academic module.",
"type": "boolean"
},
"isMandatory": {
"description": "If it is a mandatory (not self-enrolment) non-academic module.",
"default": false,
"type": "boolean"
},
"name_CourseName_LecturerName": {
"description": "Module Code, Module Title or Name of Lecturer",
"type": "string"
},
"facultyCode": {
"description": "List of faculty codes for the faculties of modules",
"type": "array",
"items": {
"type": "string"
}
},
"departmentCode": {
"description": "List of department codes for the departments of modules",
"type": "array",
"items": {
"type": "string"
}
},
"facultyIDsOrDepartmentIDs": {
"description": "GUIDs of the module faculties or departments",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"terms": {
"description": "List of Term Codes",
"type": "array",
"items": {
"type": "string"
}
},
"listOperations": {
"description": "Optional parameters for Sorting, paging and filtering",
"allOf": [
{
"type": "object",
"properties": {
"sortby": {
"type": "string"
},
"offset": {
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"type": "integer"
},
"limit": {
"format": "int32",
"maximum": 10000,
"minimum": 1,
"type": "integer"
},
"where": {
"type": "string"
}
}
}
]
},
"populate": {
"description": "Accepted populate entities: faculty, department. Accepted populate entities if user is authenticated: creator, lastUpdatedUser, faculty, department, manager, weblecture, termDetail",
"type": "string"
}
}
}Responses
200 OK
Returns List of [contract.API.Module]
Representations
{
"type": "array",
"items": {
"description": "Module content",
"required": [
"access",
"creatorEmail",
"creatorName",
"creatorUserID",
"title",
"updatorEmail",
"updatorName",
"updatorUserID"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "identifier",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "The date this record is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "the ID of the user who created this record",
"type": "string"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "the date this record is edited last time",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"description": "the ID of the user who edited this record last time",
"type": "string"
},
"name": {
"description": "the name/title of the content",
"type": "string"
},
"startDate": {
"format": "date-time",
"description": "the date which this module is open to students.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "the date which this module is closed from students.",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the resource is published to students.",
"type": "boolean"
},
"parentID": {
"format": "uuid",
"description": "the parent content ID if any. For those contents which do not have a parent content, the parent ID value will be the same as the ID.",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "the ID of the resource which this content belongs to.",
"type": "string"
},
"access": {
"description": "access rights",
"allOf": [
{
"description": "flags to define access rights",
"type": "object",
"properties": {
"access_Full": {
"description": "all accesses on the resource and its contents",
"type": "boolean"
},
"access_Read": {
"description": "read-only access on the contents",
"type": "boolean"
},
"access_Create": {
"description": "create access on the contents",
"type": "boolean"
},
"access_Update": {
"description": "update access on the contents",
"type": "boolean"
},
"access_Delete": {
"description": "delete access on the contents",
"type": "boolean"
},
"access_Settings_Read": {
"description": "read-only access on the resource setting",
"type": "boolean"
},
"access_Settings_Update": {
"description": "update access on the resource setting",
"type": "boolean"
}
}
}
]
},
"courseName": {
"description": "Module Title",
"type": "string"
},
"facultyCode": {
"description": "Faculty code",
"type": "string"
},
"departmentCode": {
"description": "Department code",
"type": "string"
},
"term": {
"description": "Term Code",
"type": "string"
},
"acadCareer": {
"description": "Academic Career",
"type": "string"
},
"courseSearchable": {
"description": "Whether the module to be searchable in the internet",
"type": "boolean"
},
"isIALPEnabled": {
"description": "Whether the module to be searchable in the internet",
"type": "boolean"
},
"allowAnonFeedback": {
"description": "Whether to allow anonymous feedback. \"N\" for Do not allow anonymous feedback for this module , \"Y\" for Send anonymous feedback to any module facilitators, \"O\" for Send anonymous feedback to the module owner only.",
"type": "string"
},
"displayLibGuide": {
"description": "Whether to display guides to NUS Libraries",
"type": "boolean"
},
"promoVideo": {
"description": "URL of the promotion video",
"type": "string"
},
"copyFromID": {
"format": "uuid",
"description": "ID of the module which is duplicated from",
"type": "string"
},
"teamUpURL": {
"description": "TeamUp URL",
"type": "string"
},
"isBlended": {
"description": "Whether it is a blended module",
"type": "boolean"
},
"l3": {
"description": "Whether it is a Lifelong Learners (L3) course",
"type": "boolean"
},
"enableLearningFlow": {
"description": "Whether to show the learning flow",
"type": "boolean"
},
"usedNusCalendar": {
"description": "Whether the module's Learning Flow is using NUS academic calendar format",
"type": "boolean"
},
"hasNusCalendar": {
"description": "Whether the module's Term has a NUS academic calendar template",
"type": "boolean"
},
"isCorporateCourse": {
"description": "Whether the module is a non-academic module for self-enrolment",
"type": "boolean"
},
"purpose": {
"description": "Overview description of a academic module or purpose of non-academic module.",
"type": "string"
},
"audienceType": {
"description": "Targent audience for non-academic modules and open (mandatory) modules. S for Student, L for Staff, and G for Non-NUS users",
"type": "array",
"items": {
"type": "string"
}
},
"note": {
"description": "A short note to display on the non-academic module tile",
"type": "string"
},
"creatorUserID": {
"description": "User ID of the Creator",
"type": "string"
},
"creatorName": {
"description": "Name of the Creator",
"type": "string"
},
"creatorEmail": {
"description": "Email of the Creator",
"type": "string"
},
"title": {
"description": "Title of the Creator",
"type": "string"
},
"updatorUserID": {
"description": "User ID of the Updator",
"type": "string"
},
"updatorName": {
"description": "Name of the Updator",
"type": "string"
},
"updatorEmail": {
"description": "Email of the Updator",
"type": "string"
}
}
}
}[
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"name": "string",
"startDate": "string",
"endDate": "string",
"publish": true,
"parentID": "string",
"resourceID": "string",
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"courseName": "string",
"facultyCode": "string",
"departmentCode": "string",
"term": "string",
"acadCareer": "string",
"courseSearchable": true,
"isIALPEnabled": true,
"allowAnonFeedback": "string",
"displayLibGuide": true,
"promoVideo": "string",
"copyFromID": "string",
"teamUpURL": "string",
"isBlended": true,
"l3": true,
"enableLearningFlow": true,
"usedNusCalendar": true,
"hasNusCalendar": true,
"isCorporateCourse": true,
"purpose": "string",
"audienceType": [
"string"
],
"note": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"title": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
]{
"type": "array",
"items": {
"description": "Module content",
"required": [
"access",
"creatorEmail",
"creatorName",
"creatorUserID",
"title",
"updatorEmail",
"updatorName",
"updatorUserID"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "identifier",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "The date this record is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "the ID of the user who created this record",
"type": "string"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "the date this record is edited last time",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"description": "the ID of the user who edited this record last time",
"type": "string"
},
"name": {
"description": "the name/title of the content",
"type": "string"
},
"startDate": {
"format": "date-time",
"description": "the date which this module is open to students.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "the date which this module is closed from students.",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the resource is published to students.",
"type": "boolean"
},
"parentID": {
"format": "uuid",
"description": "the parent content ID if any. For those contents which do not have a parent content, the parent ID value will be the same as the ID.",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "the ID of the resource which this content belongs to.",
"type": "string"
},
"access": {
"description": "access rights",
"allOf": [
{
"description": "flags to define access rights",
"type": "object",
"properties": {
"access_Full": {
"description": "all accesses on the resource and its contents",
"type": "boolean"
},
"access_Read": {
"description": "read-only access on the contents",
"type": "boolean"
},
"access_Create": {
"description": "create access on the contents",
"type": "boolean"
},
"access_Update": {
"description": "update access on the contents",
"type": "boolean"
},
"access_Delete": {
"description": "delete access on the contents",
"type": "boolean"
},
"access_Settings_Read": {
"description": "read-only access on the resource setting",
"type": "boolean"
},
"access_Settings_Update": {
"description": "update access on the resource setting",
"type": "boolean"
}
}
}
]
},
"courseName": {
"description": "Module Title",
"type": "string"
},
"facultyCode": {
"description": "Faculty code",
"type": "string"
},
"departmentCode": {
"description": "Department code",
"type": "string"
},
"term": {
"description": "Term Code",
"type": "string"
},
"acadCareer": {
"description": "Academic Career",
"type": "string"
},
"courseSearchable": {
"description": "Whether the module to be searchable in the internet",
"type": "boolean"
},
"isIALPEnabled": {
"description": "Whether the module to be searchable in the internet",
"type": "boolean"
},
"allowAnonFeedback": {
"description": "Whether to allow anonymous feedback. \"N\" for Do not allow anonymous feedback for this module , \"Y\" for Send anonymous feedback to any module facilitators, \"O\" for Send anonymous feedback to the module owner only.",
"type": "string"
},
"displayLibGuide": {
"description": "Whether to display guides to NUS Libraries",
"type": "boolean"
},
"promoVideo": {
"description": "URL of the promotion video",
"type": "string"
},
"copyFromID": {
"format": "uuid",
"description": "ID of the module which is duplicated from",
"type": "string"
},
"teamUpURL": {
"description": "TeamUp URL",
"type": "string"
},
"isBlended": {
"description": "Whether it is a blended module",
"type": "boolean"
},
"l3": {
"description": "Whether it is a Lifelong Learners (L3) course",
"type": "boolean"
},
"enableLearningFlow": {
"description": "Whether to show the learning flow",
"type": "boolean"
},
"usedNusCalendar": {
"description": "Whether the module's Learning Flow is using NUS academic calendar format",
"type": "boolean"
},
"hasNusCalendar": {
"description": "Whether the module's Term has a NUS academic calendar template",
"type": "boolean"
},
"isCorporateCourse": {
"description": "Whether the module is a non-academic module for self-enrolment",
"type": "boolean"
},
"purpose": {
"description": "Overview description of a academic module or purpose of non-academic module.",
"type": "string"
},
"audienceType": {
"description": "Targent audience for non-academic modules and open (mandatory) modules. S for Student, L for Staff, and G for Non-NUS users",
"type": "array",
"items": {
"type": "string"
}
},
"note": {
"description": "A short note to display on the non-academic module tile",
"type": "string"
},
"creatorUserID": {
"description": "User ID of the Creator",
"type": "string"
},
"creatorName": {
"description": "Name of the Creator",
"type": "string"
},
"creatorEmail": {
"description": "Email of the Creator",
"type": "string"
},
"title": {
"description": "Title of the Creator",
"type": "string"
},
"updatorUserID": {
"description": "User ID of the Updator",
"type": "string"
},
"updatorName": {
"description": "Name of the Updator",
"type": "string"
},
"updatorEmail": {
"description": "Email of the Updator",
"type": "string"
}
}
}
}[
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"name": "string",
"startDate": "string",
"endDate": "string",
"publish": true,
"parentID": "string",
"resourceID": "string",
"access": {
"access_Full": true,
"access_Read": true,
"access_Create": true,
"access_Update": true,
"access_Delete": true,
"access_Settings_Read": true,
"access_Settings_Update": true
},
"courseName": "string",
"facultyCode": "string",
"departmentCode": "string",
"term": "string",
"acadCareer": "string",
"courseSearchable": true,
"isIALPEnabled": true,
"allowAnonFeedback": "string",
"displayLibGuide": true,
"promoVideo": "string",
"copyFromID": "string",
"teamUpURL": "string",
"isBlended": true,
"l3": true,
"enableLearningFlow": true,
"usedNusCalendar": true,
"hasNusCalendar": true,
"isCorporateCourse": true,
"purpose": "string",
"audienceType": [
"string"
],
"note": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"title": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
]{
"type": "array",
"items": {
"description": "Module content",
"required": [
"access",
"creatorEmail",
"creatorName",
"creatorUserID",
"title",
"updatorEmail",
"updatorName",
"updatorUserID"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "identifier",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "The date this record is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "the ID of the user who created this record",
"type": "string"
},
"lastUpdatedDate": {
"format": "date-time",
"description": "the date this record is edited last time",
"type": "string"
},
"lastUpdatedBy": {
"format": "uuid",
"description": "the ID of the user who edited this record last time",
"type": "string"
},
"name": {
"description": "the name/title of the content",
"type": "string"
},
"startDate": {
"format": "date-time",
"description": "the date which this module is open to students.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "the date which this module is closed from students.",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the resource is published to students.",
"type": "boolean"
},
"parentID": {
"format": "uuid",
"description": "the parent content ID if any. For those contents which do not have a parent content, the parent ID value will be the same as the ID.",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "the ID of the resource which this content belongs to.",
"type": "string"
},
"access": {
"description": "access rights",
"allOf": [
{
"description": "flags to define access rights",
"type": "object",
"properties": {
"access_Full": {
"description": "all accesses on the resource and its contents",
"type": "boolean"
},
"access_Read": {
"description": "read-only access on the contents",
"type": "boolean"
},
"access_Create": {
"description": "create access on the contents",
"type": "boolean"
},
"access_Update": {
"description": "update access on the contents",
"type": "boolean"
},
"access_Delete": {
"description": "delete access on the contents",
"type": "boolean"
},
"access_Settings_Read": {
"description": "read-only access on the resource setting",
"type": "boolean"
},
"access_Settings_Update": {
"description": "update access on the resource setting",
"type": "boolean"
}
}
}
]
},
"courseName": {
"description": "Module Title",
"type": "string"
},
"facultyCode": {
"description": "Faculty code",
"type": "string"
},
"departmentCode": {
"description": "Department code",
"type": "string"
},
"term": {
"description": "Term Code",
"type": "string"
},
"acadCareer": {
"description": "Academic Career",
"type": "string"
},
"courseSearchable": {
"description": "Whether the module to be searchable in the internet",
"type": "boolean"
},
"isIALPEnabled": {
"description": "Whether the module to be searchable in the internet",
"type": "boolean"
},
"allowAnonFeedback": {
"description": "Whether to allow anonymous feedback. \"N\" for Do not allow anonymous feedback for this module , \"Y\" for Send anonymous feedback to any module facilitators, \"O\" for Send anonymous feedback to the module owner only.",
"type": "string"
},
"displayLibGuide": {
"description": "Whether to display guides to NUS Libraries",
"type": "boolean"
},
"promoVideo": {
"description": "URL of the promotion video",
"type": "string"
},
"copyFromID": {
"format": "uuid",
"description": "ID of the module which is duplicated from",
"type": "string"
},
"teamUpURL": {
"description": "TeamUp URL",
"type": "string"
},
"isBlended": {
"description": "Whether it is a blended module",
"type": "boolean"
},
"l3": {
"description": "Whether it is a Lifelong Learners (L3) course",
"type": "boolean"
},
"enableLearningFlow": {
"description": "Whether to show the learning flow",
"type": "boolean"
},
"usedNusCalendar": {
"description": "Whether the module's Learning Flow is using NUS academic calendar format",
"type": "boolean"
},
"hasNusCalendar": {
"description": "Whether the module's Term has a NUS academic calendar template",
"type": "boolean"
},
"isCorporateCourse": {
"description": "Whether the module is a non-academic module for self-enrolment",
"type": "boolean"
},
"purpose": {
"description": "Overview description of a academic module or purpose of non-academic module.",
"type": "string"
},
"audienceType": {
"description": "Targent audience for non-academic modules and open (mandatory) modules. S for Student, L for Staff, and G for Non-NUS users",
"type": "array",
"items": {
"type": "string"
}
},
"note": {
"description": "A short note to display on the non-academic module tile",
"type": "string"
},
"creatorUserID": {
"description": "User ID of the Creator",
"type": "string"
},
"creatorName": {
"description": "Name of the Creator",
"type": "string"
},
"creatorEmail": {
"description": "Email of the Creator",
"type": "string"
},
"title": {
"description": "Title of the Creator",
"type": "string"
},
"updatorUserID": {
"description": "User ID of the Updator",
"type": "string"
},
"updatorName": {
"description": "Name of the Updator",
"type": "string"
},
"updatorEmail": {
"description": "Email of the Updator",
"type": "string"
}
}
}
}400 Bad Request
Bad Request
Representations
{
"type": "string"
}string{
"type": "string"
}string{
"type": "string"
}500 Internal Server Error
Server Error
Representations
{
"type": "string"
}string{
"type": "string"
}string{
"type": "string"
}Code samples
@ECHO OFF
curl -v -X POST "https://luminus.azure-api.net/module/Search"
-H "Content-Type: application/json-patch+json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://luminus.azure-api.net/module/Search?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://luminus.azure-api.net/module/Search");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json-patch+json");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://luminus.azure-api.net/module/Search?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://luminus.azure-api.net/module/Search";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://luminus.azure-api.net/module/Search');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json-patch+json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'application/json-patch+json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('luminus.azure-api.net')
conn.request("POST", "/module/Search?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'application/json-patch+json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('luminus.azure-api.net')
conn.request("POST", "/module/Search?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://luminus.azure-api.net/module/Search')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body