Module API
API change historyList of APIs related to Module - Module Settings (Description, Facilitators, Readings, Weblinks), Details, Chat (TeamUp)
Create formatted reading
This is used for creating formatted readings in module, or creating formatted readings in learning flow.
This will trigger notification.
Request
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
The information of the formatted reading to be added
{
"resourceID": "string",
"lessonID": "string",
"name": "string",
"publish": true,
"author": "string",
"edition": "string",
"pubYear": "string",
"isbn": "string",
"publisher": "string",
"bookType": "string",
"libraryRefID": 0,
"rbr": true,
"additionalInfo": "string",
"compWebsite": "string",
"adoptType": "string",
"coopIDs": [
"string"
],
"publisherLink": true
}
{
"description": "HTTP Post Input class when creating Formatted Textbook",
"required": [
"author",
"bookType",
"libraryRefID",
"name",
"publish",
"publisherLink",
"rbr",
"resourceID"
],
"type": "object",
"properties": {
"resourceID": {
"format": "uuid",
"description": "Parent ID of the Formatted Textbook",
"type": "string"
},
"lessonID": {
"format": "uuid",
"description": "Lesson ID if it is created as a lesson activity",
"type": "string"
},
"name": {
"description": "the name/title of the item",
"maxLength": 500,
"minLength": 0,
"type": "string"
},
"publish": {
"description": "the publish flag which determine whether the resource is published to students.",
"type": "boolean"
},
"author": {
"description": "Book Author",
"type": "string"
},
"edition": {
"description": "Book Edition",
"type": "string"
},
"pubYear": {
"description": "Book Publication Year",
"type": "string"
},
"isbn": {
"description": "Book ISBN",
"type": "string"
},
"publisher": {
"description": "Book Publisher",
"type": "string"
},
"bookType": {
"description": "Book Type. C = Compulsory; R = References; S = Supplementary",
"type": "string"
},
"libraryRefID": {
"format": "int32",
"description": "Library ID",
"type": "integer"
},
"rbr": {
"description": "True to add to Library RBR Collection",
"type": "boolean"
},
"additionalInfo": {
"description": "Additional information",
"type": "string"
},
"compWebsite": {
"description": "Companion Website URL",
"type": "string"
},
"adoptType": {
"description": "Adoption Request. F = Full Adoption, P = Partial Adoption, S = Supplementary Adoption",
"type": "string"
},
"coopIDs": {
"description": "NUS Co-op\r\nBTC = NUS CO-OP @ BTC; CEN = NUS CO-OP @ Central Forum; SCI = NUS CO-OP @ Science (LT27); UT = BookHaven @ UTown (Stephen Riady Centre)",
"type": "array",
"items": {
"type": "string"
}
},
"publisherLink": {
"description": "Link to publisher's digital resource. True if it is McGraw-Hill. It will display the link to McGraw-Hill's digital resource.",
"type": "boolean"
}
}
}
{
"resourceID": "string",
"lessonID": "string",
"name": "string",
"publish": true,
"author": "string",
"edition": "string",
"pubYear": "string",
"isbn": "string",
"publisher": "string",
"bookType": "string",
"libraryRefID": 0,
"rbr": true,
"additionalInfo": "string",
"compWebsite": "string",
"adoptType": "string",
"coopIDs": [
"string"
],
"publisherLink": true
}
{
"description": "HTTP Post Input class when creating Formatted Textbook",
"required": [
"author",
"bookType",
"libraryRefID",
"name",
"publish",
"publisherLink",
"rbr",
"resourceID"
],
"type": "object",
"properties": {
"resourceID": {
"format": "uuid",
"description": "Parent ID of the Formatted Textbook",
"type": "string"
},
"lessonID": {
"format": "uuid",
"description": "Lesson ID if it is created as a lesson activity",
"type": "string"
},
"name": {
"description": "the name/title of the item",
"maxLength": 500,
"minLength": 0,
"type": "string"
},
"publish": {
"description": "the publish flag which determine whether the resource is published to students.",
"type": "boolean"
},
"author": {
"description": "Book Author",
"type": "string"
},
"edition": {
"description": "Book Edition",
"type": "string"
},
"pubYear": {
"description": "Book Publication Year",
"type": "string"
},
"isbn": {
"description": "Book ISBN",
"type": "string"
},
"publisher": {
"description": "Book Publisher",
"type": "string"
},
"bookType": {
"description": "Book Type. C = Compulsory; R = References; S = Supplementary",
"type": "string"
},
"libraryRefID": {
"format": "int32",
"description": "Library ID",
"type": "integer"
},
"rbr": {
"description": "True to add to Library RBR Collection",
"type": "boolean"
},
"additionalInfo": {
"description": "Additional information",
"type": "string"
},
"compWebsite": {
"description": "Companion Website URL",
"type": "string"
},
"adoptType": {
"description": "Adoption Request. F = Full Adoption, P = Partial Adoption, S = Supplementary Adoption",
"type": "string"
},
"coopIDs": {
"description": "NUS Co-op\r\nBTC = NUS CO-OP @ BTC; CEN = NUS CO-OP @ Central Forum; SCI = NUS CO-OP @ Science (LT27); UT = BookHaven @ UTown (Stephen Riady Centre)",
"type": "array",
"items": {
"type": "string"
}
},
"publisherLink": {
"description": "Link to publisher's digital resource. True if it is McGraw-Hill. It will display the link to McGraw-Hill's digital resource.",
"type": "boolean"
}
}
}
{
"resourceID": "string",
"lessonID": "string",
"name": "string",
"publish": true,
"author": "string",
"edition": "string",
"pubYear": "string",
"isbn": "string",
"publisher": "string",
"bookType": "string",
"libraryRefID": 0,
"rbr": true,
"additionalInfo": "string",
"compWebsite": "string",
"adoptType": "string",
"coopIDs": [
"string"
],
"publisherLink": true
}
{
"description": "HTTP Post Input class when creating Formatted Textbook",
"required": [
"author",
"bookType",
"libraryRefID",
"name",
"publish",
"publisherLink",
"rbr",
"resourceID"
],
"type": "object",
"properties": {
"resourceID": {
"format": "uuid",
"description": "Parent ID of the Formatted Textbook",
"type": "string"
},
"lessonID": {
"format": "uuid",
"description": "Lesson ID if it is created as a lesson activity",
"type": "string"
},
"name": {
"description": "the name/title of the item",
"maxLength": 500,
"minLength": 0,
"type": "string"
},
"publish": {
"description": "the publish flag which determine whether the resource is published to students.",
"type": "boolean"
},
"author": {
"description": "Book Author",
"type": "string"
},
"edition": {
"description": "Book Edition",
"type": "string"
},
"pubYear": {
"description": "Book Publication Year",
"type": "string"
},
"isbn": {
"description": "Book ISBN",
"type": "string"
},
"publisher": {
"description": "Book Publisher",
"type": "string"
},
"bookType": {
"description": "Book Type. C = Compulsory; R = References; S = Supplementary",
"type": "string"
},
"libraryRefID": {
"format": "int32",
"description": "Library ID",
"type": "integer"
},
"rbr": {
"description": "True to add to Library RBR Collection",
"type": "boolean"
},
"additionalInfo": {
"description": "Additional information",
"type": "string"
},
"compWebsite": {
"description": "Companion Website URL",
"type": "string"
},
"adoptType": {
"description": "Adoption Request. F = Full Adoption, P = Partial Adoption, S = Supplementary Adoption",
"type": "string"
},
"coopIDs": {
"description": "NUS Co-op\r\nBTC = NUS CO-OP @ BTC; CEN = NUS CO-OP @ Central Forum; SCI = NUS CO-OP @ Science (LT27); UT = BookHaven @ UTown (Stephen Riady Centre)",
"type": "array",
"items": {
"type": "string"
}
},
"publisherLink": {
"description": "Link to publisher's digital resource. True if it is McGraw-Hill. It will display the link to McGraw-Hill's digital resource.",
"type": "boolean"
}
}
}
{
"resourceID": "string",
"lessonID": "string",
"name": "string",
"publish": true,
"author": "string",
"edition": "string",
"pubYear": "string",
"isbn": "string",
"publisher": "string",
"bookType": "string",
"libraryRefID": 0,
"rbr": true,
"additionalInfo": "string",
"compWebsite": "string",
"adoptType": "string",
"coopIDs": [
"string"
],
"publisherLink": true
}
{
"description": "HTTP Post Input class when creating Formatted Textbook",
"required": [
"author",
"bookType",
"libraryRefID",
"name",
"publish",
"publisherLink",
"rbr",
"resourceID"
],
"type": "object",
"properties": {
"resourceID": {
"format": "uuid",
"description": "Parent ID of the Formatted Textbook",
"type": "string"
},
"lessonID": {
"format": "uuid",
"description": "Lesson ID if it is created as a lesson activity",
"type": "string"
},
"name": {
"description": "the name/title of the item",
"maxLength": 500,
"minLength": 0,
"type": "string"
},
"publish": {
"description": "the publish flag which determine whether the resource is published to students.",
"type": "boolean"
},
"author": {
"description": "Book Author",
"type": "string"
},
"edition": {
"description": "Book Edition",
"type": "string"
},
"pubYear": {
"description": "Book Publication Year",
"type": "string"
},
"isbn": {
"description": "Book ISBN",
"type": "string"
},
"publisher": {
"description": "Book Publisher",
"type": "string"
},
"bookType": {
"description": "Book Type. C = Compulsory; R = References; S = Supplementary",
"type": "string"
},
"libraryRefID": {
"format": "int32",
"description": "Library ID",
"type": "integer"
},
"rbr": {
"description": "True to add to Library RBR Collection",
"type": "boolean"
},
"additionalInfo": {
"description": "Additional information",
"type": "string"
},
"compWebsite": {
"description": "Companion Website URL",
"type": "string"
},
"adoptType": {
"description": "Adoption Request. F = Full Adoption, P = Partial Adoption, S = Supplementary Adoption",
"type": "string"
},
"coopIDs": {
"description": "NUS Co-op\r\nBTC = NUS CO-OP @ BTC; CEN = NUS CO-OP @ Central Forum; SCI = NUS CO-OP @ Science (LT27); UT = BookHaven @ UTown (Stephen Riady Centre)",
"type": "array",
"items": {
"type": "string"
}
},
"publisherLink": {
"description": "Link to publisher's digital resource. True if it is McGraw-Hill. It will display the link to McGraw-Hill's digital resource.",
"type": "boolean"
}
}
}
Responses
201 Created
the records added
Representations
{
"description": "Text and Readings content",
"required": [
"creatorEmail",
"creatorName",
"creatorUserID",
"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"
},
"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"
},
"author": {
"description": "Book Author",
"type": "string"
},
"edition": {
"description": "Book Edition",
"type": "string"
},
"pubYear": {
"description": "Book Publication Year",
"type": "string"
},
"isbn": {
"description": "Book ISBN",
"type": "string"
},
"publisher": {
"description": "Book Publisher",
"type": "string"
},
"bookType": {
"description": "Book Type. C = Compulsory; R = References; S = Supplementary",
"type": "string"
},
"bookTypeName": {
"description": "Text to be displayed for BookType",
"type": "string",
"readOnly": true
},
"libraryRefID": {
"format": "int32",
"description": "Library ID",
"type": "integer"
},
"libraryRefName": {
"description": "Library Name",
"type": "string"
},
"onlineContent": {
"description": "Whether it is formatted or unformatted Text and Readings. 1 = Formatted Text and Readings; 2 = Unformatted Text and Readings",
"type": "string"
},
"isFormatted": {
"description": "True if the reading is formatted readings",
"type": "boolean"
},
"additionalInfo": {
"description": "Additional information",
"type": "string"
},
"compWebsite": {
"description": "Companion Website URL",
"type": "string"
},
"rbr": {
"description": "Whether it is for Library RBR Collection",
"type": "boolean"
},
"coopIDs": {
"description": "A list of NUS Co-ops\r\nBTC = NUS CO-OP @ BTC; CEN = NUS CO-OP @ Central Forum; SCI = NUS CO-OP @ Science (LT27); UT = BookHaven @ UTown (Stephen Riady Centre)",
"type": "array",
"items": {
"type": "string"
}
},
"adoptType": {
"description": "Adoption Request. F = Full Adoption; P = Partial Adoption; S = Supplementary Adoption",
"type": "string"
},
"adoptTypeName": {
"description": "Text to be displayed for AdoptType",
"type": "string",
"readOnly": true
},
"publisherLink": {
"description": "Trie of there is link to publisher's digital resource. Example, McGraw-Hill's link.",
"type": "boolean"
},
"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"
},
"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",
"publish": true,
"parentID": "string",
"resourceID": "string",
"author": "string",
"edition": "string",
"pubYear": "string",
"isbn": "string",
"publisher": "string",
"bookType": "string",
"bookTypeName": "string",
"libraryRefID": 0,
"libraryRefName": "string",
"onlineContent": "string",
"isFormatted": true,
"additionalInfo": "string",
"compWebsite": "string",
"rbr": true,
"coopIDs": [
"string"
],
"adoptType": "string",
"adoptTypeName": "string",
"publisherLink": true,
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
{
"description": "Text and Readings content",
"required": [
"creatorEmail",
"creatorName",
"creatorUserID",
"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"
},
"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"
},
"author": {
"description": "Book Author",
"type": "string"
},
"edition": {
"description": "Book Edition",
"type": "string"
},
"pubYear": {
"description": "Book Publication Year",
"type": "string"
},
"isbn": {
"description": "Book ISBN",
"type": "string"
},
"publisher": {
"description": "Book Publisher",
"type": "string"
},
"bookType": {
"description": "Book Type. C = Compulsory; R = References; S = Supplementary",
"type": "string"
},
"bookTypeName": {
"description": "Text to be displayed for BookType",
"type": "string",
"readOnly": true
},
"libraryRefID": {
"format": "int32",
"description": "Library ID",
"type": "integer"
},
"libraryRefName": {
"description": "Library Name",
"type": "string"
},
"onlineContent": {
"description": "Whether it is formatted or unformatted Text and Readings. 1 = Formatted Text and Readings; 2 = Unformatted Text and Readings",
"type": "string"
},
"isFormatted": {
"description": "True if the reading is formatted readings",
"type": "boolean"
},
"additionalInfo": {
"description": "Additional information",
"type": "string"
},
"compWebsite": {
"description": "Companion Website URL",
"type": "string"
},
"rbr": {
"description": "Whether it is for Library RBR Collection",
"type": "boolean"
},
"coopIDs": {
"description": "A list of NUS Co-ops\r\nBTC = NUS CO-OP @ BTC; CEN = NUS CO-OP @ Central Forum; SCI = NUS CO-OP @ Science (LT27); UT = BookHaven @ UTown (Stephen Riady Centre)",
"type": "array",
"items": {
"type": "string"
}
},
"adoptType": {
"description": "Adoption Request. F = Full Adoption; P = Partial Adoption; S = Supplementary Adoption",
"type": "string"
},
"adoptTypeName": {
"description": "Text to be displayed for AdoptType",
"type": "string",
"readOnly": true
},
"publisherLink": {
"description": "Trie of there is link to publisher's digital resource. Example, McGraw-Hill's link.",
"type": "boolean"
},
"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"
},
"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",
"publish": true,
"parentID": "string",
"resourceID": "string",
"author": "string",
"edition": "string",
"pubYear": "string",
"isbn": "string",
"publisher": "string",
"bookType": "string",
"bookTypeName": "string",
"libraryRefID": 0,
"libraryRefName": "string",
"onlineContent": "string",
"isFormatted": true,
"additionalInfo": "string",
"compWebsite": "string",
"rbr": true,
"coopIDs": [
"string"
],
"adoptType": "string",
"adoptTypeName": "string",
"publisherLink": true,
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
{
"description": "Text and Readings content",
"required": [
"creatorEmail",
"creatorName",
"creatorUserID",
"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"
},
"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"
},
"author": {
"description": "Book Author",
"type": "string"
},
"edition": {
"description": "Book Edition",
"type": "string"
},
"pubYear": {
"description": "Book Publication Year",
"type": "string"
},
"isbn": {
"description": "Book ISBN",
"type": "string"
},
"publisher": {
"description": "Book Publisher",
"type": "string"
},
"bookType": {
"description": "Book Type. C = Compulsory; R = References; S = Supplementary",
"type": "string"
},
"bookTypeName": {
"description": "Text to be displayed for BookType",
"type": "string",
"readOnly": true
},
"libraryRefID": {
"format": "int32",
"description": "Library ID",
"type": "integer"
},
"libraryRefName": {
"description": "Library Name",
"type": "string"
},
"onlineContent": {
"description": "Whether it is formatted or unformatted Text and Readings. 1 = Formatted Text and Readings; 2 = Unformatted Text and Readings",
"type": "string"
},
"isFormatted": {
"description": "True if the reading is formatted readings",
"type": "boolean"
},
"additionalInfo": {
"description": "Additional information",
"type": "string"
},
"compWebsite": {
"description": "Companion Website URL",
"type": "string"
},
"rbr": {
"description": "Whether it is for Library RBR Collection",
"type": "boolean"
},
"coopIDs": {
"description": "A list of NUS Co-ops\r\nBTC = NUS CO-OP @ BTC; CEN = NUS CO-OP @ Central Forum; SCI = NUS CO-OP @ Science (LT27); UT = BookHaven @ UTown (Stephen Riady Centre)",
"type": "array",
"items": {
"type": "string"
}
},
"adoptType": {
"description": "Adoption Request. F = Full Adoption; P = Partial Adoption; S = Supplementary Adoption",
"type": "string"
},
"adoptTypeName": {
"description": "Text to be displayed for AdoptType",
"type": "string",
"readOnly": true
},
"publisherLink": {
"description": "Trie of there is link to publisher's digital resource. Example, McGraw-Hill's link.",
"type": "boolean"
},
"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"
},
"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"
}
403 Forbidden
Login user not authorized to perform this action
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/Reading/Formatted"
-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/Reading/Formatted?" + 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/Reading/Formatted");
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/Reading/Formatted?" + $.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/Reading/Formatted";
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/Reading/Formatted');
$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/Reading/Formatted?%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/Reading/Formatted?%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/Reading/Formatted')
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