Library Resources API

API change history

List of APIs related to Library Resources

Search folder

Search library folder based on typed text. It is used by user with "LibraryAdmin" role.

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    Search text, at least 4 characters

  • (optional)
    string
  • (optional)
    integer

    Format - int32.

  • (optional)
    integer

    Format - int32.

  • (optional)
    string
  • (optional)
    string

    Accepted populate entities: Creator, Lecturer, Files

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Returns list of folder information

Representations

{
  "type": "array",
  "items": {
    "description": "The folder which is used for modules and files by library Admin. Lecturer and Students can see the folder information and files.",
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "The Folder ID",
        "type": "string"
      },
      "name": {
        "description": "The folder Name",
        "type": "string"
      },
      "lecturerUserID": {
        "format": "uuid",
        "description": "Lecturer User ID",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "Parent ID",
        "type": "string"
      },
      "lectureUserName": {
        "description": "Lecture User Name",
        "type": "string"
      },
      "publish": {
        "description": "the folder is published or not",
        "type": "boolean"
      },
      "files": {
        "description": "Files List",
        "type": "array",
        "items": {
          "description": "The file which is used for modules by library Admin. Lecturer and Students can see the files.",
          "required": [
            "description"
          ],
          "type": "object",
          "properties": {
            "id": {
              "format": "uuid",
              "description": "The File ID",
              "type": "string"
            },
            "fileName": {
              "description": "file name",
              "type": "string"
            },
            "name": {
              "description": "url name",
              "type": "string"
            },
            "description": {
              "description": "file description",
              "type": "string"
            },
            "publish": {
              "description": "the file is published or not",
              "type": "boolean"
            },
            "fileSize": {
              "format": "double",
              "description": "Original File Size",
              "type": "number"
            },
            "userID": {
              "description": "The NUSNETID of the user who created this file",
              "type": "string"
            },
            "userName": {
              "description": "The name of the user who created this file",
              "type": "string"
            },
            "email": {
              "description": "The email address of the user who created this file",
              "type": "string"
            },
            "downloadCount": {
              "format": "int32",
              "description": "File downloads count",
              "type": "integer"
            },
            "allowDownload": {
              "description": "indicate whether user can download the file. if not allowed to download, user can send a request form to admin, requesting to download again.",
              "type": "boolean"
            },
            "downloadRequests": {
              "description": "Download requests object for file",
              "type": "array",
              "items": {
                "description": "The class which is used for display all download requests for a library resource.",
                "type": "object",
                "properties": {
                  "targetID": {
                    "format": "uuid",
                    "description": "The file id",
                    "type": "string"
                  },
                  "moduleID": {
                    "format": "uuid",
                    "description": "The module id",
                    "type": "string"
                  },
                  "folderID": {
                    "format": "uuid",
                    "description": "The folder id",
                    "type": "string"
                  },
                  "id": {
                    "format": "int64",
                    "description": "The id of the log (key)",
                    "type": "integer"
                  },
                  "folderName": {
                    "description": "The folder name",
                    "type": "string"
                  },
                  "status": {
                    "description": "The status of the request - Approved or Pending",
                    "type": "string"
                  },
                  "reason": {
                    "description": "Reason for requesting to download file again",
                    "type": "string"
                  },
                  "location": {
                    "description": "The location where the file is request from",
                    "type": "string"
                  },
                  "logDate": {
                    "format": "date-time",
                    "description": "The date when the log is created",
                    "type": "string"
                  },
                  "userID": {
                    "format": "uuid",
                    "description": "The id of the who created the log",
                    "type": "string"
                  },
                  "userName": {
                    "description": "The name of the user who created the log",
                    "type": "string"
                  },
                  "fileName": {
                    "description": "The name of the file that requested",
                    "type": "string"
                  },
                  "ip": {
                    "description": "ip address of downloaded user system",
                    "type": "string"
                  }
                }
              }
            },
            "url": {
              "description": "Url of the file when filetype is weblink",
              "type": "string"
            },
            "createdDate": {
              "format": "date-time",
              "description": "File Create date",
              "type": "string"
            },
            "lastUpdatedDate": {
              "format": "date-time",
              "description": "Last updated date",
              "type": "string"
            },
            "typeID": {
              "description": "File Type - Url or File",
              "allOf": [
                {
                  "format": "int32",
                  "description": "type of resource or content",
                  "enum": [
                    1,
                    2,
                    6,
                    7,
                    8,
                    10,
                    11,
                    13,
                    14,
                    15,
                    16,
                    17,
                    19,
                    20,
                    22,
                    24,
                    25,
                    27,
                    28,
                    29,
                    30,
                    31,
                    32,
                    33,
                    34,
                    35,
                    36,
                    37,
                    39,
                    41,
                    42,
                    44,
                    45,
                    47,
                    48,
                    51,
                    54,
                    55,
                    56,
                    57,
                    58,
                    59,
                    60,
                    62,
                    63,
                    64,
                    65,
                    66,
                    67,
                    68,
                    69,
                    70,
                    71,
                    72,
                    73,
                    74,
                    75,
                    76,
                    77,
                    78,
                    79,
                    80,
                    81,
                    83,
                    100,
                    200,
                    1000,
                    1001,
                    1002,
                    1003,
                    1004,
                    1005,
                    1006
                  ],
                  "type": "integer"
                }
              ]
            },
            "creatorID": {
              "format": "uuid",
              "description": "Creator ID",
              "type": "string"
            },
            "resourceID": {
              "format": "uuid",
              "description": "Folder ID",
              "type": "string"
            }
          }
        }
      },
      "moduleCode": {
        "description": "Module Code",
        "type": "string"
      },
      "startDate": {
        "format": "date-time",
        "description": "the date which this resource is open to students.",
        "type": "string"
      },
      "endDate": {
        "format": "date-time",
        "description": "the date which this resource is closed from students.",
        "type": "string"
      },
      "term": {
        "description": "Term Code",
        "type": "string"
      },
      "acadCareer": {
        "description": "Academic Career",
        "type": "string"
      },
      "creatorID": {
        "format": "uuid",
        "description": "the ID of the user who created this record",
        "type": "string"
      },
      "createdDate": {
        "format": "date-time",
        "description": "File Create date",
        "type": "string"
      },
      "userID": {
        "description": "The NUSNETID of the user who created this folder",
        "type": "string"
      },
      "userName": {
        "description": "The name of the user who created this folder",
        "type": "string"
      },
      "email": {
        "description": "The email address of the user who created this folder",
        "type": "string"
      },
      "lastUpdatedDate": {
        "format": "date-time",
        "description": "Last updated date",
        "type": "string"
      }
    }
  }
}
[
  {
    "id": "string",
    "name": "string",
    "lecturerUserID": "string",
    "parentID": "string",
    "lectureUserName": "string",
    "publish": true,
    "files": [
      {
        "id": "string",
        "fileName": "string",
        "name": "string",
        "description": "string",
        "publish": true,
        "fileSize": 0.0,
        "userID": "string",
        "userName": "string",
        "email": "string",
        "downloadCount": 0,
        "allowDownload": true,
        "downloadRequests": [
          {
            "targetID": "string",
            "moduleID": "string",
            "folderID": "string",
            "id": 0,
            "folderName": "string",
            "status": "string",
            "reason": "string",
            "location": "string",
            "logDate": "string",
            "userID": "string",
            "userName": "string",
            "fileName": "string",
            "ip": "string"
          }
        ],
        "url": "string",
        "createdDate": "string",
        "lastUpdatedDate": "string",
        "typeID": {},
        "creatorID": "string",
        "resourceID": "string"
      }
    ],
    "moduleCode": "string",
    "startDate": "string",
    "endDate": "string",
    "term": "string",
    "acadCareer": "string",
    "creatorID": "string",
    "createdDate": "string",
    "userID": "string",
    "userName": "string",
    "email": "string",
    "lastUpdatedDate": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "The folder which is used for modules and files by library Admin. Lecturer and Students can see the folder information and files.",
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "The Folder ID",
        "type": "string"
      },
      "name": {
        "description": "The folder Name",
        "type": "string"
      },
      "lecturerUserID": {
        "format": "uuid",
        "description": "Lecturer User ID",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "Parent ID",
        "type": "string"
      },
      "lectureUserName": {
        "description": "Lecture User Name",
        "type": "string"
      },
      "publish": {
        "description": "the folder is published or not",
        "type": "boolean"
      },
      "files": {
        "description": "Files List",
        "type": "array",
        "items": {
          "description": "The file which is used for modules by library Admin. Lecturer and Students can see the files.",
          "required": [
            "description"
          ],
          "type": "object",
          "properties": {
            "id": {
              "format": "uuid",
              "description": "The File ID",
              "type": "string"
            },
            "fileName": {
              "description": "file name",
              "type": "string"
            },
            "name": {
              "description": "url name",
              "type": "string"
            },
            "description": {
              "description": "file description",
              "type": "string"
            },
            "publish": {
              "description": "the file is published or not",
              "type": "boolean"
            },
            "fileSize": {
              "format": "double",
              "description": "Original File Size",
              "type": "number"
            },
            "userID": {
              "description": "The NUSNETID of the user who created this file",
              "type": "string"
            },
            "userName": {
              "description": "The name of the user who created this file",
              "type": "string"
            },
            "email": {
              "description": "The email address of the user who created this file",
              "type": "string"
            },
            "downloadCount": {
              "format": "int32",
              "description": "File downloads count",
              "type": "integer"
            },
            "allowDownload": {
              "description": "indicate whether user can download the file. if not allowed to download, user can send a request form to admin, requesting to download again.",
              "type": "boolean"
            },
            "downloadRequests": {
              "description": "Download requests object for file",
              "type": "array",
              "items": {
                "description": "The class which is used for display all download requests for a library resource.",
                "type": "object",
                "properties": {
                  "targetID": {
                    "format": "uuid",
                    "description": "The file id",
                    "type": "string"
                  },
                  "moduleID": {
                    "format": "uuid",
                    "description": "The module id",
                    "type": "string"
                  },
                  "folderID": {
                    "format": "uuid",
                    "description": "The folder id",
                    "type": "string"
                  },
                  "id": {
                    "format": "int64",
                    "description": "The id of the log (key)",
                    "type": "integer"
                  },
                  "folderName": {
                    "description": "The folder name",
                    "type": "string"
                  },
                  "status": {
                    "description": "The status of the request - Approved or Pending",
                    "type": "string"
                  },
                  "reason": {
                    "description": "Reason for requesting to download file again",
                    "type": "string"
                  },
                  "location": {
                    "description": "The location where the file is request from",
                    "type": "string"
                  },
                  "logDate": {
                    "format": "date-time",
                    "description": "The date when the log is created",
                    "type": "string"
                  },
                  "userID": {
                    "format": "uuid",
                    "description": "The id of the who created the log",
                    "type": "string"
                  },
                  "userName": {
                    "description": "The name of the user who created the log",
                    "type": "string"
                  },
                  "fileName": {
                    "description": "The name of the file that requested",
                    "type": "string"
                  },
                  "ip": {
                    "description": "ip address of downloaded user system",
                    "type": "string"
                  }
                }
              }
            },
            "url": {
              "description": "Url of the file when filetype is weblink",
              "type": "string"
            },
            "createdDate": {
              "format": "date-time",
              "description": "File Create date",
              "type": "string"
            },
            "lastUpdatedDate": {
              "format": "date-time",
              "description": "Last updated date",
              "type": "string"
            },
            "typeID": {
              "description": "File Type - Url or File",
              "allOf": [
                {
                  "format": "int32",
                  "description": "type of resource or content",
                  "enum": [
                    1,
                    2,
                    6,
                    7,
                    8,
                    10,
                    11,
                    13,
                    14,
                    15,
                    16,
                    17,
                    19,
                    20,
                    22,
                    24,
                    25,
                    27,
                    28,
                    29,
                    30,
                    31,
                    32,
                    33,
                    34,
                    35,
                    36,
                    37,
                    39,
                    41,
                    42,
                    44,
                    45,
                    47,
                    48,
                    51,
                    54,
                    55,
                    56,
                    57,
                    58,
                    59,
                    60,
                    62,
                    63,
                    64,
                    65,
                    66,
                    67,
                    68,
                    69,
                    70,
                    71,
                    72,
                    73,
                    74,
                    75,
                    76,
                    77,
                    78,
                    79,
                    80,
                    81,
                    83,
                    100,
                    200,
                    1000,
                    1001,
                    1002,
                    1003,
                    1004,
                    1005,
                    1006
                  ],
                  "type": "integer"
                }
              ]
            },
            "creatorID": {
              "format": "uuid",
              "description": "Creator ID",
              "type": "string"
            },
            "resourceID": {
              "format": "uuid",
              "description": "Folder ID",
              "type": "string"
            }
          }
        }
      },
      "moduleCode": {
        "description": "Module Code",
        "type": "string"
      },
      "startDate": {
        "format": "date-time",
        "description": "the date which this resource is open to students.",
        "type": "string"
      },
      "endDate": {
        "format": "date-time",
        "description": "the date which this resource is closed from students.",
        "type": "string"
      },
      "term": {
        "description": "Term Code",
        "type": "string"
      },
      "acadCareer": {
        "description": "Academic Career",
        "type": "string"
      },
      "creatorID": {
        "format": "uuid",
        "description": "the ID of the user who created this record",
        "type": "string"
      },
      "createdDate": {
        "format": "date-time",
        "description": "File Create date",
        "type": "string"
      },
      "userID": {
        "description": "The NUSNETID of the user who created this folder",
        "type": "string"
      },
      "userName": {
        "description": "The name of the user who created this folder",
        "type": "string"
      },
      "email": {
        "description": "The email address of the user who created this folder",
        "type": "string"
      },
      "lastUpdatedDate": {
        "format": "date-time",
        "description": "Last updated date",
        "type": "string"
      }
    }
  }
}
[
  {
    "id": "string",
    "name": "string",
    "lecturerUserID": "string",
    "parentID": "string",
    "lectureUserName": "string",
    "publish": true,
    "files": [
      {
        "id": "string",
        "fileName": "string",
        "name": "string",
        "description": "string",
        "publish": true,
        "fileSize": 0.0,
        "userID": "string",
        "userName": "string",
        "email": "string",
        "downloadCount": 0,
        "allowDownload": true,
        "downloadRequests": [
          {
            "targetID": "string",
            "moduleID": "string",
            "folderID": "string",
            "id": 0,
            "folderName": "string",
            "status": "string",
            "reason": "string",
            "location": "string",
            "logDate": "string",
            "userID": "string",
            "userName": "string",
            "fileName": "string",
            "ip": "string"
          }
        ],
        "url": "string",
        "createdDate": "string",
        "lastUpdatedDate": "string",
        "typeID": {},
        "creatorID": "string",
        "resourceID": "string"
      }
    ],
    "moduleCode": "string",
    "startDate": "string",
    "endDate": "string",
    "term": "string",
    "acadCareer": "string",
    "creatorID": "string",
    "createdDate": "string",
    "userID": "string",
    "userName": "string",
    "email": "string",
    "lastUpdatedDate": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "The folder which is used for modules and files by library Admin. Lecturer and Students can see the folder information and files.",
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "The Folder ID",
        "type": "string"
      },
      "name": {
        "description": "The folder Name",
        "type": "string"
      },
      "lecturerUserID": {
        "format": "uuid",
        "description": "Lecturer User ID",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "Parent ID",
        "type": "string"
      },
      "lectureUserName": {
        "description": "Lecture User Name",
        "type": "string"
      },
      "publish": {
        "description": "the folder is published or not",
        "type": "boolean"
      },
      "files": {
        "description": "Files List",
        "type": "array",
        "items": {
          "description": "The file which is used for modules by library Admin. Lecturer and Students can see the files.",
          "required": [
            "description"
          ],
          "type": "object",
          "properties": {
            "id": {
              "format": "uuid",
              "description": "The File ID",
              "type": "string"
            },
            "fileName": {
              "description": "file name",
              "type": "string"
            },
            "name": {
              "description": "url name",
              "type": "string"
            },
            "description": {
              "description": "file description",
              "type": "string"
            },
            "publish": {
              "description": "the file is published or not",
              "type": "boolean"
            },
            "fileSize": {
              "format": "double",
              "description": "Original File Size",
              "type": "number"
            },
            "userID": {
              "description": "The NUSNETID of the user who created this file",
              "type": "string"
            },
            "userName": {
              "description": "The name of the user who created this file",
              "type": "string"
            },
            "email": {
              "description": "The email address of the user who created this file",
              "type": "string"
            },
            "downloadCount": {
              "format": "int32",
              "description": "File downloads count",
              "type": "integer"
            },
            "allowDownload": {
              "description": "indicate whether user can download the file. if not allowed to download, user can send a request form to admin, requesting to download again.",
              "type": "boolean"
            },
            "downloadRequests": {
              "description": "Download requests object for file",
              "type": "array",
              "items": {
                "description": "The class which is used for display all download requests for a library resource.",
                "type": "object",
                "properties": {
                  "targetID": {
                    "format": "uuid",
                    "description": "The file id",
                    "type": "string"
                  },
                  "moduleID": {
                    "format": "uuid",
                    "description": "The module id",
                    "type": "string"
                  },
                  "folderID": {
                    "format": "uuid",
                    "description": "The folder id",
                    "type": "string"
                  },
                  "id": {
                    "format": "int64",
                    "description": "The id of the log (key)",
                    "type": "integer"
                  },
                  "folderName": {
                    "description": "The folder name",
                    "type": "string"
                  },
                  "status": {
                    "description": "The status of the request - Approved or Pending",
                    "type": "string"
                  },
                  "reason": {
                    "description": "Reason for requesting to download file again",
                    "type": "string"
                  },
                  "location": {
                    "description": "The location where the file is request from",
                    "type": "string"
                  },
                  "logDate": {
                    "format": "date-time",
                    "description": "The date when the log is created",
                    "type": "string"
                  },
                  "userID": {
                    "format": "uuid",
                    "description": "The id of the who created the log",
                    "type": "string"
                  },
                  "userName": {
                    "description": "The name of the user who created the log",
                    "type": "string"
                  },
                  "fileName": {
                    "description": "The name of the file that requested",
                    "type": "string"
                  },
                  "ip": {
                    "description": "ip address of downloaded user system",
                    "type": "string"
                  }
                }
              }
            },
            "url": {
              "description": "Url of the file when filetype is weblink",
              "type": "string"
            },
            "createdDate": {
              "format": "date-time",
              "description": "File Create date",
              "type": "string"
            },
            "lastUpdatedDate": {
              "format": "date-time",
              "description": "Last updated date",
              "type": "string"
            },
            "typeID": {
              "description": "File Type - Url or File",
              "allOf": [
                {
                  "format": "int32",
                  "description": "type of resource or content",
                  "enum": [
                    1,
                    2,
                    6,
                    7,
                    8,
                    10,
                    11,
                    13,
                    14,
                    15,
                    16,
                    17,
                    19,
                    20,
                    22,
                    24,
                    25,
                    27,
                    28,
                    29,
                    30,
                    31,
                    32,
                    33,
                    34,
                    35,
                    36,
                    37,
                    39,
                    41,
                    42,
                    44,
                    45,
                    47,
                    48,
                    51,
                    54,
                    55,
                    56,
                    57,
                    58,
                    59,
                    60,
                    62,
                    63,
                    64,
                    65,
                    66,
                    67,
                    68,
                    69,
                    70,
                    71,
                    72,
                    73,
                    74,
                    75,
                    76,
                    77,
                    78,
                    79,
                    80,
                    81,
                    83,
                    100,
                    200,
                    1000,
                    1001,
                    1002,
                    1003,
                    1004,
                    1005,
                    1006
                  ],
                  "type": "integer"
                }
              ]
            },
            "creatorID": {
              "format": "uuid",
              "description": "Creator ID",
              "type": "string"
            },
            "resourceID": {
              "format": "uuid",
              "description": "Folder ID",
              "type": "string"
            }
          }
        }
      },
      "moduleCode": {
        "description": "Module Code",
        "type": "string"
      },
      "startDate": {
        "format": "date-time",
        "description": "the date which this resource is open to students.",
        "type": "string"
      },
      "endDate": {
        "format": "date-time",
        "description": "the date which this resource is closed from students.",
        "type": "string"
      },
      "term": {
        "description": "Term Code",
        "type": "string"
      },
      "acadCareer": {
        "description": "Academic Career",
        "type": "string"
      },
      "creatorID": {
        "format": "uuid",
        "description": "the ID of the user who created this record",
        "type": "string"
      },
      "createdDate": {
        "format": "date-time",
        "description": "File Create date",
        "type": "string"
      },
      "userID": {
        "description": "The NUSNETID of the user who created this folder",
        "type": "string"
      },
      "userName": {
        "description": "The name of the user who created this folder",
        "type": "string"
      },
      "email": {
        "description": "The email address of the user who created this folder",
        "type": "string"
      },
      "lastUpdatedDate": {
        "format": "date-time",
        "description": "Last updated date",
        "type": "string"
      }
    }
  }
}

500 Internal Server Error

Server Error

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

403 Forbidden

Login user not authorized to perform this action

Code samples

@ECHO OFF

curl -v -X GET "https://luminus.azure-api.net/nus_lib/search?SearchText={string}&sortby={string}&offset={integer}&limit={integer}&where={string}&populate={string}"
-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}");

            // Request parameters
            queryString["SearchText"] = "{string}";
            queryString["sortby"] = "{string}";
            queryString["offset"] = "{integer}";
            queryString["limit"] = "{integer}";
            queryString["where"] = "{string}";
            queryString["populate"] = "{string}";
            var uri = "https://luminus.azure-api.net/nus_lib/search?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // 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/nus_lib/search");

            builder.setParameter("SearchText", "{string}");
            builder.setParameter("sortby", "{string}");
            builder.setParameter("offset", "{integer}");
            builder.setParameter("limit", "{integer}");
            builder.setParameter("where", "{string}");
            builder.setParameter("populate", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            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
            "SearchText": "{string}",
            "sortby": "{string}",
            "offset": "{integer}",
            "limit": "{integer}",
            "where": "{string}",
            "populate": "{string}",
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/nus_lib/search?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // 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/nus_lib/search";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"SearchText={string}",
                         @"sortby={string}",
                         @"offset={integer}",
                         @"limit={integer}",
                         @"where={string}",
                         @"populate={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_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/nus_lib/search');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'SearchText' => '{string}',
    'sortby' => '{string}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'where' => '{string}',
    'populate' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// 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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'SearchText': '{string}',
    'sortby': '{string}',
    'offset': '{integer}',
    'limit': '{integer}',
    'where': '{string}',
    'populate': '{string}',
})

try:
    conn = httplib.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/nus_lib/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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'SearchText': '{string}',
    'sortby': '{string}',
    'offset': '{integer}',
    'limit': '{integer}',
    'where': '{string}',
    'populate': '{string}',
})

try:
    conn = http.client.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/nus_lib/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/nus_lib/search')

query = URI.encode_www_form({
    # Request parameters
    'SearchText' => '{string}',
    'sortby' => '{string}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'where' => '{string}',
    'populate' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# 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