API Information
What is the RAE 2020 Case Study API?
The RAE 2020 Case Study API provides programmatic access to the RAE 2020 case studies database. The database provides access to documents submitted as part of the 2020 Research Assessment Exercise, making them searchable and providing filtering functionality based on tags applied to them. The API exists to encourage analyses of the data and facilitate integration of the case study content and associated metadata into new resources.
Who can use this API?
The API and associated documentation are designed for use by anyone with technical experience of APIs and ingesting JSON or XML.
Getting started
The base URL for all API calls is: https://impact.ugc.edu.hk/api/
The API for the 2020 case studies database provides methods to fetch all case studies, returning as JSON. Method for fetching available filters are also available.
Response structure
All API responses will return in the following structure:
{
"code": <integer>,
"status":<string>,
"message": <string>,
"data": {
"body": <array|object>,
...
}
}API Response
Below shows the response messages and code:
| Property | Type | Value | Description |
| code | Integer | 200 | Successful request |
| Integer | 404 | Not found | |
| Integer | 400 | Bad request | |
| status | string | success | Successful request |
| string | error | Bad request | |
| message | string | Description of response | |
| data | object | body | "body" is either object or array and will always exist. Other properties may be included and will vary in type |
Fetching case studies
To return all the case studies, the call should look like:
| URL: | https://impact.ugc.edu.hk/api/case-studies/get/all |
| Method: | GET |
| Options: | ?output=research_categories,impact_sectors,funders,geocoding,content,full |
{
"code":200,
"status":"success",
"message":"Case studies fetched successfully",
"data":{
"body":[
{
"uid":"uoa14_cityu_impact_case_study_001",
"title":"3D Speckle Vision from Academic Research to the Real-World",
"order": 119,
"impact_china": 1,
"impact_global": 1,
"unit_of_assessment": {
"unit_of_assessment":"UoA 14 - Mechanical engineering, production engineering (incl. manufacturing & industrial engineering), textile technology and aerospace engineering",
"uoa": 14,
"panel_name":"Engineering",
"uoa_name":"Mechanical engineering, production engineering (incl. manufacturing & industrial engineering), textile technology and aerospace engineering"
},
"institution":"City University of Hong Kong",
"topic_primary":{
"label":"Imaging & Diagnostics",
}
},
{...}
],
"total": 342
}
}Customised Output
The above response shows the default data that will be returned. You can customise this response to request more data by adding options to the URL.
Case study content:
This will return a case study response with an array of section content.
| URL: | https://impact.ugc.edu.hk/api/case-studies/get/all?output=content |
| Method: | GET |
| Options: | ?output=content |
{
"code":200,
"status":"success",
"message":"Case studies fetched successfully",
"data":{
"body":[
{
"uid":"uoa14_cityu_impact_case_study_001",
"title":"3D Speckle Vision from Academic Research to the Real-World",
"order": 119,
"impact_china": 1,
"impact_global": 1,
"unit_of_assessment": {
"unit_of_assessment":"UoA 14 - Mechanical engineering, production engineering (incl. manufacturing & industrial engineering), textile technology and aerospace engineering",
"uoa": 14,
"panel_name":"Engineering",
"uoa_name":"Mechanical engineering, production engineering (incl. manufacturing & industrial engineering), textile technology and aerospace engineering"
},
"institution":"City University of Hong Kong",
"topic_primary":{
"label":"Imaging & Diagnostics"
},
"content":{
"section":[
{
"id":"1",
"label":"Summary of the impact",
"content":"<p>The 3D Speckle Vision research carried out at CityU, which was related to\n a computerized 3D camera for real-time acquisition and processing of 3D\n object shapes, has been further developed byformer PhD students, which led\n to commercial products and a spin-off company (Orbbec Co. Ltd). Within 6\n years, the company has become a leading provider of 3D sensing solutions\n for many high-tech applications. <strong><h> company presently has more\n than 300 employees, generates annual revenue of US$100 million and is\n valued at over US$1 billion</strong>. It is based in Shenzhen and has\n research facilities in both China and USA.</p>\n "
},
{
"id":"2",
"label":"Underpinning research",
"content":"<p>The Croucher Laboratory for Optical Measurement and Nondestructive\n Testing at CityU was established by Prof Michael YY Hung, then Chair\n Professor and department head, with a Croucher Foundation grant. The\n laboratory is equipped with the state-of-the-art equipment and know-how to\n conduct applied research using various computer-aided optical techniques\n (holography, shearography, speckle vision, thermography, tomography,\n photoelasticity, moire methods and 3D computer vision). Numerous research\n projects were conducted in the laboratory and Prof Hung, Dr. Huang and Dr.\n Long Liu have published many significant papers in the field, such as\n [1,2,3,4,5].</p>\n <p>Prof Hung was the PhD supervisor of Dr. Huang and Dr. Liu, who conducted\n doctoral research on optical methods, particularly 3D speckle vision. The\n use of laser-produced speckle pattern for 3D shape measurement was first\n conceived by Prof Hung and his students in their early work on\n specklegrammetry for precision surface coordinate measurement, herein\n referred to as \"3D speckle vision.\" A speckle pattern is a random pattern\n produced by the interference of scattered laser light. The local speckle\n pattern around a point is uniquely defined like a finger print. 3D speckle\n vision is based on projecting a speckle pattern on a 3D surface. When\n projecting at an angle slightly offset to the camera direction, each\n speckle point will be laterally shifted according to the depth, and the\n shift magnitude is related to the depth of corresponding surface point. A\n digital speckle correlation algorithm is developed to accurately determine\n this shift and hence the depth.</p>\n "
},
{
"id":"3",
"label":"References to the research",
"content":"<p>1. <span type=\"citation\" year=\"2011\"><strong><u>Y. H. Huang</u></strong>,\n Farrokh Janabi-Sharifi, Y. S. Liu* and <u>Y. Y. Hung</u>, \"Dynamic\n Phase Measurement in Shearography by Clustering Method and Fourier\n Filtering\", <em>Optics Express</em>, Vol. <strong><9>/strong> (2),\n pp606-615, Jan 2011.</span></p>\n <p>2. <span type=\"citation\" year=\"2009\"><strong><u>Y. H. Huang</u></strong>,\n S. P. Ng <strong>< >. Liu</strong>, C. L. Li, Y. S. Chen and <u>Y. Y.\n Hung,</u> \"NDT&E using Shearography with Impulsive Thermal\n Stressing and Clustering Phase Extraction\", <em>Optics and Lasers in\n Engineering</em>, Vol. <strong><7>/strong> (7-8), pp774-781, JUL-AUG\n 2009.</span></p>\n <p>3. <span type=\"citation\" year=\"2009\"><strong><u>Y. H. Huang</u></strong>,\n <strong><.>Liu</strong>, T. W. Yeung and <u>Y. Y. Hung,</u> \"Real Time\n Monitoring of Clamping Force of a Bolted Joint by Use of Automatic\n Digital Image Correlation\", <em>Optics and Laser Technology</em>, Vol.\n <strong><1>/strong> (4), pp408-414, June 2009.</span></p>\n <p>4. <span type=\"citation\" year=\"2009\"><u>Y. Y. Hung</u>, Y. S. Chen, S.\n P. Ng, <strong><.>Liu</strong>, <strong><u>Y. H. Huang</u></strong>,\n B. L. Luk, R. W. L. Ip, C. M. L. Wu and P. S. Chung, \"Review and\n Comparison of Shearography and Active Thermography for Nondestructive\n Evaluation\", <em>Materials Science & Engineering R-Reports</em>,\n Vol. <strong><4>/strong> (5-6), pp73-112, May 2009.</span></p>\n <p>5. <span type=\"citation\" year=\"2009\"><strong><u>Y.H. Huang</u></strong>,\n <strong><.>Liu</strong>, <u>Y. Y. Hung</u> and C.Y. Yiu, \"In-Situ\n Shearographic Nondestructive Testing of Aging Concrete Structures\", <em>Materials\n Evaluation</em>, Vol. <strong><7>/strong> (4), pp437-443, APR 2009.</span></p>\n "
},
{
"id":"4",
"label":"Details of the impact",
"content":"<p>The Department of Mechanical Engineering at CityU realized that today's\n engineering field is increasingly multi-disciplinary , and hence\n established the Croucher Laboratory for Optical Measurement and\n Nondestructive Testing to facilitate research and teaching in\n electro-optics and mechatronics. The department has an undergraduate\n program in mechatronics. Furthermore, the department emphasized on applied\n research relevant to the industrial needs. The efforts have produced\n significant impact. Much of the knowledge has been transferred to industry\n through department's graduates.</p>\n <p>This study shows a very significant case that 2 PhD graduates carried\n their research from the Croucher Laboratory to industry. They formed\n Orbbec Company Ltd. in 2013 to further R&D and commercialize 3D\n speckle vision. The company produces a computerized 3D camera (integration\n of software and hardware based on 3D speckle vision) which has many\n real-world applications. <strong><i>hin a short period of 6 years, the\n company has grown into a US$2 billion company with annual revenue of\n US$100 million</strong>. The company is headquartered in Shenzhen with\n R&D facilities in Shanghai, Xian in China, and Seattle in USA. <strong><t>n currently has more than 600 employees</strong> and has been growing\n rapidly.</p>\n <p>While many new applications are underway, major achievements today, as\n partnered with and supported by HP, OPPO and Ant Financial Group, include:</p>\n <ol type=\"1\">\n <li>The development of a 3D imaging camera head for HP Sprout G2 for AR\n (augmented reality) applications.</li>\n <li>The development of a 3D camera for cell phones</li>\n <li>The development of the world's first Face ID for android phones</li>\n <li>The development of applications for the financial sector.</li>\n </ol>\n <p>Furthermore, the company is presently collaborating with many companies\n to develop applications in various areas including:</p>\n <ol type=\"1\">\n <li>Retail. Through face recognition via 3D camera ， every user can log\n into his/her own account, which is linked to a database that can provide\n companies with the data for the recommendation of suitable products.</li>\n <li>Virtual fitting, smart Home, and smart city/security protection</li>\n <li>Automotive.</li>\n <li>3D vision and Robot (Industry scanning and inspection)</li>\n <li>Building scanning</li>\n <li>Mobile phone</li>\n <li>Logistics</li>\n </ol>\n <p>With the advent of high sensitivity image sensors and fast computing\n hardware, Dr. Huang and Dr. Liu saw the opportunity and started up Orbbec\n Company to develop a 3D camera (an integrated software and hardware\n system) allowing 3D surface sensing to be performed in real- time. They\n have identified many potential applications and have been working with\n various industrial partners to develop the applications. The company is\n recognized by the Chinese Ministry of Science and Technology as a\n \"unicorn\" and has received the followings prestigious recognitions:</p>\n <p>1. The award of 2014 Shenzhen \"Peacock Project\" for overseas high-level\n talent team.</p>\n <p>2. The award of 2017 \"Pearl River Talent Program\" Team in Guangdong\n Province.</p>\n <p>3. Selected in the 2017 list of unicorns released by the Torch Center of\n the Ministry of Science and Technology, China.</p>\n <p>4. Astra S produced by Orbbec was named \"the most advanced structured\n light 3D camera\" by Springer Nature.</p>\n <p>5. IFAA 3D Security Face ID Technology Pioneer Award, IFAA2018</p>\n <p>6. Selected as \"The King of the New Economy\" in WISE 2018 New Business\n Conference.</p>\n <p>7. Selected as \"China's Star of Tomorrow\" by Deloitte China</p>\n <p>8. selected as \"the world's 30 best AI startups\"</p>\n <p>9. Obtained the 21st Century Business Herald's \"China's Intelligent\n Manufacturing Golden Great Wall Award</p>\n "
},
{
"id":"5",
"label":"Sources to corroborate the impact",
"content":"<p>Orbbec Company, Ltd. (<a href=\"http://www.orbbec.com.cn/\">http://www.orbbec.com.cn/)</a>\n has produced numerous intellectual properties. It has submitted 460\n patents applications and so far 120 have been approved. Some selected\n patents include:</p>\n <ol type=\"1\">\n <li>一种手势识别方法与装置 (Chinese Patent: CN104598915B)</li>\n <li>3D 图像装置、光辐射的保护装置及其方法 (Chinese Patent: CN105097053B)</li>\n <li>一种实时生成目标深度信息的方法及其装置 (Chinese Patent:CN103778643B)</li>\n <li>一种光学投影装置及深度相机 (Chinese Patent: CN106773489B)</li>\n <li>三维图像的获得方法、装置及系统 (Chinese Patent: CN106254854B)</li>\n <li>多模式深度计算处理器以及 3D 图像设备 (Chinese Patent: CN107105217B)</li>\n <li>ASIC chip system dedicated for optical three-dimensional sensing(US\n Patent: US10013378B2)</li>\n <li>Overall Z-direction displacement measuring system(US Patent:\n US10234264B2)</li>\n <li>DEPTH CAMERA-BASED HUMAN-BODY MODEL ACQUISITION METHOD AND NETWORK\n VIRTUAL FITTING SYSTEM(US Patent: US10217293B2)</li>\n <li><a href=\"https://www.marketresearch.com/Market-Intelligence-Consulting-Institute-v3289/Development-Strategy-3D-Sensor-Unicorn-12566379/\">https://www.marketresearch.com/Market-Intelligence-Consulting-Institute-v3289/Development-Strategy-3D-Sensor-Unicorn-12566379/</a>\n [Description of Development Strategy of 3D Sensor Unicorn Orbbec]</li>\n </ol>\n "
}
]
}
},
{...}
],
"total": 342
}
}Case study additional data:
This will return a case study response with whichever options are added to the output.
| URL: | https://impact.ugc.edu.hk/api/case-studies/get/all?output=research_categories,impact_sectors,funders,geocoding,images |
| Method: | GET |
| Options: | ?output=research_categories,impact_sectors,funders,geocoding,images |
{
"code":200,
"status":"success",
"message":"Case studies fetched successfully",
"data":{
"body":[
{
"uid":"uoa14_cityu_impact_case_study_001",
"title":"3D Speckle Vision from Academic Research to the Real-World",
"order": 119,
"impact_china": 1,
"impact_global": 1,
"unit_of_assessment": {
"unit_of_assessment":"UoA 14 - Mechanical engineering, production engineering (incl. manufacturing & industrial engineering), textile technology and aerospace engineering",
"uoa": 14,
"panel_name":"Engineering",
"uoa_name":"Mechanical engineering, production engineering (incl. manufacturing & industrial engineering), textile technology and aerospace engineering"
},
"institution":"City University of Hong Kong",
"topic_primary":{
"label":"Imaging & Diagnostics"
},
"impact_sectors":[
{
"name":"Health",
"weight":"1"
},
{
"name":"Law, politics and community services",
"weight":"1"
}
],
"research_categories":[
{
"category_code":"SY",
"weight":"3.0"
},
{
"category_code":"UB",
"weight":"2.0"
}
],
"funders":[
{
"funder":"Ryerson University",
"weight":"1.0"
},
{
"funder":"Natural Sciences and Engineering Research Council of Canada (NSERC)",
"weight":"1.0"
}
],
"geocoding":[
{
"geonames_id":"1795565",
"latitude":"22.5455400",
"longitude":"114.0683000",
"name":"Shenzhen",
"country_code":"CN",
"country_name":"China",
"continent_code":"AS",
"continent_name":"Asia",
"china_region":"1",
"weight":"2"
},
{
"geonames_id":"1814991",
"latitude":"35.0000000",
"longitude":"105.0000000",
"name":"China",
"country_code":"CN",
"country_name":"China",
"continent_code":"AS",
"continent_name":"Asia",
"china_region":"1",
"weight":"2"
}
],
"images": [
{
"image_name":"Im0.6.jpg",
"image_type":"jpg",
"image_value":"data:image/jpg;base64,/9j/4AAQSkZJRgABAgAAYABgAAD/2wCEABALChAYKDM9DAwOExo6PDcODRAYKDlFOA4RFh0zV1A+EhYlOERtZ00YIzdAUWhxXDFATldneXhlSFxfYnBkZ2MBERIYL2NjY2MSFRpCY2NjYxgaOGNjY2NjL0JjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY//EAaIAAAEFAQEBAQEBAAAAAAAAAAABAgMEBQYHCAkKCxAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6AQADAQEBAQEBAQEBAAAAAAAAAQIDBAUGBwgJCgsRAAIBAgQEAwQHBQQEAAECdwABAgMRBAUhMQYSQVEHYXETIjKBCBRCkaGxwQkjM1LwFWJy0QoWJDThJfEXGBkaJicoKSo1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoKDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uLj5OXm5+jp6vLz9PX29/j5+v/AABEIAUgBQAMBIgACEQEDEQH/2gAMAwEAAhEDEQA/AKoBH3acMN98YNNVgvfNDOG+7xTMgZtvSjYG74pA4H3+aazZ+4aBEhkx29qQ2+eQaYrj+Kly38J4oAUuvQio9mO9SHafTNRYP8XSgB/DfdqMqV+/UvA+5j3pm/d98UgGMufu0mR/EKcSR06U5Y1brQMh3kfdzTCc9alkXHSoSKQx6H1HFSiVR90VWzTsUAWAVbrwakL7e1VM1Ksox8xpiJVVTzn3xSmUNxj8arZPY8UvmDt1ouBP5OzljmopArfd4oSYj/Wcio5JB/BQCIicUA+tIW9aQPSGWt6EfJw1IEP/AC2NRB1H3RzUkcof/WcehqhDJbb/AJ4nIpVtlx8x5p7SGP7oyKGTPOcd8UAQbT36etO24+6M0hkJ7UgyvXn2oGI3zfeGKFuWHHaldg3TilXyu/X1oAYT701pM+1K6EdDkU9LZn+4uPUmgZEr7evNKqM33QT9Kuxaev8Ay0O4+lW47c/wKB6CocuxSiUord8fMAvvUqwY6kmrXkn+NiKlEH90K3qfSoci1ErLGP4alFu3px7VPhe6L+FBh/55sfpU8w7GVu/vUuf7ppAuetKUK1uc4dfvU05HSnde2KRuKABcd6d5pHSo+tAIoAcfY0wsacVqNjUgSgAd80pcN7VGjDvUhUH/AFf41QDTlevNN57VJtP8ZoKkfdpMCPzPUUwmpNnrimYx1oGMJqWPH8QphA7U5BnrQAr7f4aciqfvHmmMuKAtAAcjpSMvoafvHdfxprIB70ANLH+L86Y3HSpGw33VqIpjrQA00zcakZCelRGgBytjqKUuD04qPNDY7UxlhJwPvc+9TbC3RuOtZ4NTIWHQnFMRO8i9hzUQ/wBqm7qN2eppAOMZ/hpUQemT2FT29vK33Rhf7x/oK0LeyUdFyf7x/pUuRSRVh0/vKc99np9atCP0AFTFCOlKP9oA1j6mqQ0RD6/SnbFPZhThtP3Tj2P9KDnv+dDGNZXHuPSgFD6oacshH3gfrTjGrfdwaEwGKhX743DsRS/MPucj0pAGX/A0/ePT6ikwMd5QegxTVmI61Du9KXNdRzkpbP3TUisMfORVbPpRu9aQmSkf3akXaPvdarCQjpT8560APYntUZFKZMU0mpAB9KcHI+7QHz1pQAOtCARpSfvUgkI70NtP3TTOnWmA4tSF6TaewpDQMcCB1o3Z6cU0e9OOO1AC5x1oLGmZ9aMntQBMHXHI5pvPem7xSq+fvdO9AD9w7Go2P96nyBR9w5qJmB60AIzH+Go3I7U8sR0FBh9/wpoCDNO8snpTSKUSEdKYxfJPc0oJHWpY4zJ90nNXY7ID743Gpb7jSKcVs7fdXj1P+NaEGnoPv4Y9f/1CpgnoMVKh9V/Gs2y0hQB604IB0Y0uPRaAKkoMZ70u0+ooBA6rR9BQA3yz2FOBx95acVYU0yH+IZoAUbe/I/lTWj/55tn2pyqOxH0pCvrxUjGCZx94Z+tOwp+4ce1OyD94fjUboy9D9KaAwRTwc0m00fQ10HMOximHnpSgnvQR6UANz60bvSj60GkAu6gGkAHrRSAfn0pUcfx9KZS5z1FMB7lf4KbvHcU3pSdaBknm46UjEGmZoxQAv1pSPSm7qXOKAHBc+1NPHSkLE9KTOOtAAwpA1KcnrTkVT0PNADMkUh5pzRlfv01ufu0AOWYDqPxppJ9eKao9aUKx6fhQAxjVm1sGf7+VX+f0qxbaeB/rBk9h6VfRDUOXY0Ue4yK3RR8q4/r9amAB7CgLTgp7AVBY3BpQT3p5PsBTdppgKpPY4p3I68+9NCGnCkAvB607Z6NQqg9Kb0ouCQ/ee4ppUehFKGNPUk+lSMgZSKBIf4uf6VKR/wDqpjxEdBTEBHpyP5UoYHqaajEdac6elSNmF9RUhtxjioy+aehI6n8K6jmI9nrSGMjtUzEHpSK+PvHNICHZmm4xUsjA/dpnHegBmDQM0pHoaBSASnbs0Yo+lMY3p1oP+yaPrQfagABHelK+hplAzQAtAOPvUfSgsT1oAUn+7SAjvTAcdKeq560wBiR9Ki8zH3eKslzjGzPvVd4sUmAvnbv9Y1K2B9w1EE9qmgtmY8cD+Jv8KQx8NuG6Zz/KtK2tY068t6+n0pIoVX7v4+5qYVm5djRR7jqcM0KuelSlAvuaRTGbaKCaBQAtOXPam0tMBHkYdQaVZgeop5Gabt9BQCFDegpwwaaDjpSgH1qbDH4WkHHegE9xTgVPamhC7QenWoySOtPIIoY5HNIBhCnpwfSlQ+tRkMO1PBz9f50DMDijJ9aaaaG9q3OYkBprN60E4ppbNABu9KMjvTc00mkA8mkzTQ9IWoGSFqTPpUe+l3UAP3Z60pAqMGl3Y60wHgZpDim9ehpN1AEmKQtmmhiOvSnEg/doAZyKcBnvSjjrSeWT92gCQTgUxl9TRgd6mgtifv8ATsPWhvuNLsLb2bSdFOPX1+lXViC9Bj2pyO3qQOgHtSisJPsbRiAFOFJS5qSiaKQDrTpHB6VCKVTVJisOFLmpViU96a0eKoQ0UtJuoBpDHD607FMxRvIpgPK0lAlJ6ilGKA9Rw5poOKA2KCRSAerE04imrkdKC57igRFLn6j1pOnvUnzelN47j60DOcII70vmA9OtI4b04pRt/GtznDaR94mmsc9DSmQ96YeOlADlP96gr6U3dnrSgntSAMDvSFafsB6mhlA70AM2D1pCtOwKSgBuKWgj0pM0DFyaM+1NDU/j/wCtQAoPrS5H8NJ5g7ikYigCRWB+9SlsfdqJTn2qxawbj8x+X19aT8wSJIbcNyw/CrYTHapFkA/1YA9/WpFlB++BWb9TZehCKdUjQD+A/hUL7h2pNDuPFP8AKb0rPaWQetXLW9J+8PrVJeYrjqUVM0QPSo9uKTQ0x8chFK75pmaTNABU8cYPWogKerkUku4PyHOoHSm0jMTSU/Qa8yTZ6U3mkBNOz60CG5pcelJingUDGxOSOfp+VPVvWmBNvT6mnGkJi49Ka2ewz60oNNzt7/hSA5wzH0pGUdjmkQDufbNSraMP4uPSuk5yJcntin+Vgc81L8p6cGnLGV++cikIrJGD7U/bt6c05tp/1Zozt+/zSAYYs9CRTGbHWpTk/cpCV/i60AQ7SKeHB7UrRt2PFJkH7owaYAEx945pDHn7tOCMPv04An7mKQyE8daaUNTMo/jIpvlv/D0pgRhs9qcI2H3gaCR/D1qWMsf9Z9APegBI4y54BA6k+3tWiigdPwoECoBjr1b/AD7VJEo79OtYTOiCHAH0pM1KswPbA7VG64P8qOXsxp90KrkdDUqtu61AKmXpVQ8xSRFJF6io4oyp4qcPnrSsvpQ/IF5kyPUTMe9JGTUrJmmgIwamRQaj209DSXmNrsKwxSKakdfSogfWk0CHMKaDT85FR5psSHijNIDSlhQAZpce9MBqK8uQinn2X3NAmWFdT0YH6Uo46/hWNpEEm7LZA6D/AGia2CwP9KTBCjilKA/Xt70q4ppbnj6VIGOIoj1xn+tM2SenFPFoDznB64oE7dNp9K6DmI3Vf4cZpsZc/wCs6VKbXHOc+1KAG6qR71IFdwB/qwDSAk/60Yp7xbPukmlVBIPm4/rTAjwR9wcU4qp+9jNOY7OgzTDHnr9aQxFJ7dKk8pOxGaYJO238aeIcc5z7UAIpJ/1gwO1IRj7nNMMhftijBj6gmnYCQIrffAFMcuPurkULlvahrkDgAntRYBPLUcgjPpVm0UnmRQB/D71BBalzknA6t9P/AK9Xic9BgdAPSpmzSnEUAsakk44H1NOhXFMkPNQ0aoRBU8y8VHCuanbBqooUmVhU0YyKhKkdakibFTFlyXYQjFSouRSSJSRtjvR6h6DTxU4ORUcq0RvikmDF5NKMjrT+Ka7CnbzFfyHCQUxyO1NCml2H1qhaBvNH0NNbA6kVmXerqOIQWPTNO3cTfY1C4/vD296bIzdse4rGht7lyC5I7qP/AK1ah3Hvj+9UtAmJdXgjXJ5PRR6mqNjG9w2bhiVHRe2fYe1Q6rOCcLye/wBa17CDYgDDB6t9T602SS5x0HsKkUetMUgnipAtZ3KAN6UwZp4HPFIRj/GmBktG5OUcgdfwqT7RH0Jwe1QuZc/J0/pTtkffG7tXQcw5UdeWbilMytxGcGoh5v8AF92kLov+rxmlYBpDp985FPbDj902KjWVz/rcY7Urvx+4AosA8Sqn+tOfekMe77sgx1xVfeP+WwGe1Rhn/wCWecUxlxpo+nfpmnJCRy7celQIFHUjPvR58v8AFjbSsBLLJE3+rODSBgg/eHdVbaT/AKvrTjG3/LXimAjkt/qzinw7c4IJboPrTDG//LPp7VoQxBeqjd/KpkyooeqBRgdf4jSqKfHHnrTiB2FYPz+RuvL5ksbioJFwaehxUrKrVe4iCI4qR1YdKYVxUqSnuKlPuymuyEK7h05qLpVlZV9KSVF7CiS7MafdAGyOarn2o8wjp/8AqpHbFQ2JCm4x1qMXC98imdaZIUHvTXmD9S8J1I+VgaQVkNM4+6MdhVuG/wAjnqOvv9K0SIuX/MA6ms671pV4gG9unHY1Qlu5pzhcqO4Hp71ft7WKPsCe7H+lXcRWW1uZubmRlXqF/wDrVcjtoI/uoufU/wCNDXBP3B+NCx/3jU3Kt3JPNJ+4KC+0ZdgO9Qz38UY67j2Uf1qokNxcH94Sidh6j2o9RN9kMsI/NkywJH3zXQEZ6Gq9vBHGMRqfXj+tTjd/dYe1RJlJDlAUf55NPY4HpTEG7k/QD0+tK7ZP6n6UJA/+HHH60pwfvVG70rEmgRkvMU4EZI6UqwIeec9cVJ56LxJknpmm/ZjnKycdcV0HMN88ngpx6017UDlee+Kn+1RtxjB9aj8ll5d8jsKAK+S/VdvvSmPyx+7Bapjtl/1ZKn1pVj8n/WEtQIhS2WT/AFi7aVl2cJGT71K5Mn+rBFOW5VOJFJ96QxhsUPPf0qOJSTh4yB61ZNoSchyB1xTWuweApB9aAI2tkj5Tk+npTMrL/rRtoaJk5ZmPfFAi83oSvrQNE0UAH3enrUqD1pVUDhenSpkiH8VYS8joiu43d6UqipNqUo2joKLfzNDv2REwxT4801jmpEGOtOK7BJ9xj1LGo9Kic0+KnEGIy4NK7DFPIB71DNx1PFFhXK+6mOxNR+Zn7p4ppkxSUQuTFgBxURj/AL34ChGHVyAP4c/1qhc6hKSRArAdA4HLj2PvTa7EjruRVbAbJHDAdif8Kdag7ufpj2qrBavnMqkDrg9WP0rRtY8nJHsPqaEuzG2SAqv3EGe9LtLfe4okmhj++659P/rVRl1Vm4t0Ppn/AAFO3cd/5UXJbiOIfMRnsPWqiSzzn93uUe3Ye5p1tpEj83LEd9vc/Wtq3tUjH7tQB/P61XoR6lK10ZF5lO89ee1X41B+6Panfe+7+JqVVC1DLSIYOCd/B7Z7j2qYEnORj09xSzRbvY9QfQ0yMFh1IPT8feoKGYweuR1z6H3pWX+6P/r0qoO457ihTjhv+An1piYAg/yI9KRc9/8AIpShHT8aU8/d/CmIoBYv+WwXd/Woisufl+73qT7MknLHB64pDcMpxsyOlbnKO2Rfw7d1RKsmf3pG2pfIjHIPPUCowzOcOhA9aAH4T/l22574oQMP+Psj2+lKIFi5h+Y9TSqfNH79NvagBsisf+PYjFOURj/X7d3r70j5j/1C5FO8pG/1vB6496BjGWbPysAv9KR3jP3MBvWlMsmcBPl9acbZP4cZoAiiSQf60gjsKnwB91cU1C/8YGP4aeAfSsZy7G9OPcdHH60889KBJ7UeZjoKjTozX1Q4QnvTWXHel8xj0o2MetO3ZMV+7Q1BUjHFCx+ppxK9zVxEyDk1NwBzTC6joKTJahA/MA1JMNwpxAFMdgByaEJmKA6HB/KpGNJPLuPH4U6QHFNCaK0wdgBuwvQj1p8SlfuOwHaljwTyKvJCo/gH1oE0VRGcfMeO7etRSTSvxbKQOhI7/U1ptEh++M+1WFhVR8qBfpSXkU13MeLQyf8AXP7kD/GtKGyjj+5GB7//AF6nQ+1S+WDTv2Yrd0RIwqQyDtSxRj+lSmMelTr5FO3ZhEoHb606RQR+opsbYp8oOOKQkKDkVEnDHj3qbt8v4VGHx98Y9D/jSGgkU9QPr7imsFPT/wDVUoHvTHQZ5OP60gIwzfxDPv8A40Nx0HvTz/s0hQ98VRJmNAW5STA9KV5MD1PrWj9kX0pPsaf3a2OdGVGnOSx+lWTOCMbMe9XPsa/3RR9jT0FGo9ChGhU8En2p8rK/3sj6VbNmtAsV9KA0KIYJ0JP1qNpATyCK0/sqegpv2JP7oosF0UvtJ7LREmTkk+9XHt41HIHsPWoCPoKmTLigCk1NlR1qMN/dpMH0NZX/AOCb2JCq0m1aQRnvTvJPY1S/wi/7eFDAUeZ6Unkn1pwUDrVai0GksaQRGnNL6UKSaQ7sTYo6mguB0pGXHeoi1F+yD1Yu7NVb2U9Aask4HNZlxJuP8qbEiONcmluZcdPxqVAFHP1NVCGc8D2FAMuabaluT9FrRmjxTrWEIB/nmiQ5NKTCIkEWTzU83SnxJgUyY0ug76jY4s1KIfQ06IcUM+O1CS6hd9Bm0r15FTIwPQ0uAaiZdvT8RQHqOaI9RUinI/nQpz0NMBwf5fWgBN20+3b2NOYZ60PHn+dR4cdCD9aA+YqZH3unY+lPaJfQVH5hH3x7ZHrUm0HuTUAxhbH3eT/Ie9Jtb+JvwFOYqvQewHqaZtJ+8cew/qaYhTKaPNNIXX0pvmL6V1HFccZTTd/1o8xfSjzF9KAuG8+9G8+9HmD+7R5o9KQXDcaQufel80elRSPnpx6UpMuCI5HLd/pQIz3oxjpT0UmuZ+Z2LysKoUVKuKZ5XvShT2p83kFvMc0Z7Uz5h1qZXHegsp602uzBegwSimNuPQVIVSkMo7U9erD0QzyfWhjt6Uvm1ExzTuugrPqNaQ01VJqZIx3pssij7tNebJ9EVrt8DiqMaZPP1qzKSaZt2jn60FEE7+n41Z0y2ycsPpVM8n9K24IwijH4/WgPQs7eKihXnmp0ORUUQ5qZAiaq7cmp3NMhXNKYQJY1pJAKeRioo+TzVMSHJu7mlYZpWbFMTJpAOh470sqZ6dexoMeOhINNJkHoaPVD9GJul77ab5v94EU5JQevBp+B7UJdmDfeJH8rdwfahFYdGHtmnNGp7VGcr1yR6+lDXcSfYcU9SSfX/CmglvYdvel8rPc49KGX+7/+qkwuQkGjB9Kn2+1G32rpOEg2n0o2mp8UmKQyLYaTYe9TYNNY46//AK6GCRBISOn41HupWYnpSiOueT7M7ILuh4YU9ZKYEHrSgCmr+RWhNkGlU4qEnHSk3mn6oVuxI2e1Jt9TTBLSGWlZdStegpBpwj9aaJaDKT0NFkGo8xj1pBEB1NMDGhpDT07BZ9x0jDtVWRqkIPc1GQPWhiQ0KKqXEmelWpnx0qoEJpvyBeY+xt9zcjgcn61teUDVSCMIP1Jp6XDdhSduoWfQuMMCo4aa0rH+E0sAPcVN+wW7kkgpIBTpBxTYGpsFsSyHAqKE1I/NRKwWhiRI656U6NABURn/ALqk0oRz95sewp+gW7sfIhP3WxTgD/Ec1F5R7OaaXdfvHNHqmHo0PaFT2qMwsPuMfpUqyg07NVZdCeZ9SASkffH4084PSnlRUQQg8E47ikwuPVGx1x/hSqF7HPqaeahZMfdOPWiwr92T7V/vCk2r/eFQG19zR9lHqau5iyYhf7woyn98VF9mHqaBaii4rEuU/vCqlzIOx46D3NLMqr0696hC5qJM2hEaoPanlTQHA7VKHFQl5m3yI14p+aGHpTM00DFNKAKaaaHp+ovQcyelN2Gk30GSjQY4R07AHWofNNIzmi/ZB8yfK9qjYgU1DTZAafyFfzFaQHvUZKjpTcGlWEnrRfyBrzIn5qa3t/7wqVIVHXmnuSB8tHqJvsK656GpoYgKpq7d81ainHekmhtMmLKOtPVl7YphUHrTHTb9002/IhepLI9NhFIkZP3jUigCkimxJGx0FIkf97rTiwpjTge9VbuyU39lEoUelRSSsOi0Cf1BFCyL60PyYK/VDo3J6inkA9aasi9qcT6VS9SH6DDF6cU3y27OaXc3eneYO1ToO7GAP3wfent/s/iaRnPpSeYKPmDfkJuI6mgnPagEH3p4FAn5osbRRtFGPejaaoyDAqOdwo9+gHvT8GqVxJk+3b3NTJlwRAxPc0qA0EU5D7VkjqsRsvqKcq051ojoRQx9w6God7VakHoKgI9qJMUfkCOx6ihj/smpBiopZPSqb7k27C5HpTWP+zTVJ7ZqX61KYNEIY/3aU59KDJ6CpAPalfzBoiywpodz2p75qRFFLm8wa7kJkYfwikMjntipzGDSvGBT5xJFaMtnk1Y3nuKiEZ7VOMd6uLCQKy+1OKZ+7SeWD0p2xl68j+VN+ZK8iaLd/FRMfekilBpJetDBeZMKhLsTxUqmhVA7U2uzEn/wBog/vE08RKOgqJrg9hTln9aFYHceYx6UeSvpTlYHoaU/Wrsuxnd92QmEj7ppySf3qcZBSYBqbdim/wCYHcChaZLShvQUCF3Z9qQKD0FOCE9qlWH+8fwpkX8yIClAbsKnCqOgFOzRYVxcUUmaTNMAk4HFZrNWkTnrVZrJezEe1RJdjSEl1Kw5pwcVP9kXsxposF/56Gp5fI1511ZG54qBCe1Ou5404Vix7+1URekdFoaKi+xoO4HWmCVTWdLfuewpiTTn7i/jTfqgXoajMKrkc802ITfxYz60/wAp/Wk0OLJeBS59aiCP3an+Sx/ipWE13GKBnipM0iwMKR1cd6mw2K656U6NcdaaqP7UeVJ61LiTfuShRQ6A9aYC3enbT3pcorjQB2oaMnpT1T2p44rSMROXYSGM9zVho1NMC+9KWPatLE37DSqr0pSAetIqf3uadjFCQX8yLJXvUivmmSDNKq46U0DZLtHpSGIHtUYz3NOYmn8ib+YuzH3TSgH+I5pi7qXax6tij7xN+aBl98UKfTJp4Qd+acKCHIaEJ608IoozSZpkXJAaN1R0ZoESbx70F6jBpc0DJaQ0tJQaCZoJoNJQJhu9ao3V6f8AlmcDoT61LdSHoPxqiyk9BUSka049yu4J96FtCetTmMDrUyEGpv2NyGGxTvirCxoO9OXAqNkOetHyGvNlnaPamtjtTFcDvT81RDKzNUkcnrQ6CmotIpsn3Co3A9adtprAetFjLmG+fjoKkVs1F5XvUqrinYUmBxSpjtSMhNORBRYVwxSjFPpOKokATQxPagYp2aAuRhz3pS+e1O4/u0AH0xQDaGbfXilPtk07FFBDl2Q0A/SnYpaKZFwFKKKBQIWiiigBaSiigYhNGaU0lAgpaTFFAE+aKbmjNM0HUlJmlzSAguICen41UCkda0iaikhB9j/OoaNIyKRAPWmCIj7pqz9nb0oEZH8JpWNObzK4J71JjNSeUT2NO8k+hqkS2VvKPrUoPvTjA3pSC3Pegly7sa1NXPrU3k+ppREvpQTzDMmk8snrU4A7Clz7U7C5iIRe1PEftTt1G6iwcwhjo20u6kLUCuGBRgelJuo3UxDvwopm6lzQIduozTKKCR2aSjNFABRmiigBaWm0tAC5paQU6gBKKWigBKSnGkIoGJSUuKSgCTNGaQ0UFMXNGabRQAuaPqaKKAQopc0lAoGLSGlooASkzTqa1IBKQilFBoAbSZpTTTTJDNG6kpKAHbqTNJRQAuaQ0UtACUZoooEKDS5ptLQIXNKKSloAWjFFKKBiAUtAooEAp1NFOoAKKKDQAUlLSGgApMUtFBQA/9kK"
}
]
},
{...}
],
"total": 342
}
}Case study full data:
This will return a case study response with full topic information, research categories, impact sectors, funders and geocoding. "content" and "images" need to be added in addition
| URL: | https://impact.ugc.edu.hk/api/case-studies/get/all?output=full |
| Method: | GET |
| Options: | ?output=full |
{
"code":200,
"status":"success",
"message":"Case studies fetched successfully",
"data":{
"body":[
{
"uid":"uoa14_cityu_impact_case_study_001",
"title":"3D Speckle Vision from Academic Research to the Real-World",
"order": 119,
"impact_china": 1,
"impact_global": 1,
"unit_of_assessment": {
"unit_of_assessment":"UoA 14 - Mechanical engineering, production engineering (incl. manufacturing & industrial engineering), textile technology and aerospace engineering",
"uoa": 14,
"panel_name":"Engineering",
"uoa_name":"Mechanical engineering, production engineering (incl. manufacturing & industrial engineering), textile technology and aerospace engineering"
},
"institution":"City University of Hong Kong",
"topic_primary":{
"id":30,
"topic_hex":"#E2A98D",
"cluster":7,
"cluster_label":"Health & health care",
"original_cluster":8,
"cluster_hex":"",
"primary_count":14,
"all_count":34,
"label":"Imaging & Diagnostics",
"top_terms":[
"3d",
"imaging",
"medical",
"mapping",
"company",
"accuracy",
"camera",
"geometric",
"diagnostic",
"develop"
],
"top_subjects":[
"robots",
"diagnostics",
"algorithms",
"cancerous diseases",
"technology",
"robotics",
"imaging",
"Monte Carlo methods",
"urban design",
"remote sensing"
],
"top_uoa":"UoA 14 - mechanical engineering, production engineering (incl. manufacturing & industrial engineering), textile technology and aerospace engineering"
},
"topic_secondary":{
"id":29,
"topic_hex":"#12B27E",
"cluster":11,
"cluster_label":"Production & technology transfer",
"original_cluster":8,
"cluster_hex":"",
"primary_count":24,
"all_count":68,
"label":"Productisation",
"top_terms":[
"products",
"company",
"production",
"product",
"textile",
"rmb",
"textiles",
"business",
"manufacturing",
"new"
],
"top_subjects":[
"enterprises",
"People's Republic of China",
"innovations",
"product development",
"textiles",
"technology",
"sustainable development",
"organisations (systems)",
"robots",
"corporate strategies"
],
"top_uoa":"UoA 14 - mechanical engineering, production engineering (incl. manufacturing & industrial engineering), textile technology and aerospace engineering"
},
"topic_tertiary":{
"id":null,
"topic_hex":null,
"cluster":null,
"cluster_label":null,
"original_cluster":null,
"cluster_hex":null,
"primary_count":null,
"all_count":null,
"label":null,
"top_terms":null,
"top_subjects":null,
"top_uoa":null
},
"impact_sectors":[
{
"name":"Health",
"weight":"1"
},
{
"name":"Law, politics and community services",
"weight":"1"
}
],
"research_categories":[
{
"category_code":"SY",
"weight":"3.0"
},
{
"category_code":"UB",
"weight":"2.0"
}
],
"funders":[
{
"funder":"Ryerson University",
"weight":"1.0"
},
{
"funder":"Natural Sciences and Engineering Research Council of Canada (NSERC)",
"weight":"1.0"
}
],
"geocoding":[
{
"geonames_id":"1795565",
"latitude":"22.5455400",
"longitude":"114.0683000",
"name":"Shenzhen",
"country_code":"CN",
"country_name":"China",
"continent_code":"AS",
"continent_name":"Asia",
"china_region":"1",
"weight":"2"
},
{
"geonames_id":"1814991",
"latitude":"35.0000000",
"longitude":"105.0000000",
"name":"China",
"country_code":"CN",
"country_name":"China",
"continent_code":"AS",
"continent_name":"Asia",
"china_region":"1",
"weight":"2"
}
]
},
{...}
],
"total": 342
}
}Case study combining outputs:
This will return a case study response with full topic information, research categories, funders and geocoding and content.
| URL: | https://impact.ugc.edu.hk/api/case-studies/get/all?output=content,full |
| Method: | GET |
| Options: | ?output=content,full |
Searching:
This will search through the content of the case study and return an array of case studies.
| URL: | https://impact.ugc.edu.hk/api/case-studies/get/all?search=mechanical%20engineering |
| Method: | GET |
| Search: | Search option should be URL encoded |
| Output: | You can add on the output options from above to include in the response |
Fetching individual case studies
To return a single case study, the call should look like:
| URL: | https://impact.ugc.edu.hk/api/case-studies/get/{uid} |
| Example: | https://impact.ugc.edu.hk/api/case-studies/get/uoa14-cityu-impact-case-study-001 |
| Method: | GET |
| Options: | ?output=content,full |
{
"code":200,
"status":"success",
"message":"Case study fetched successfully",
"data":{
"body":{
"uid":"uoa14_cityu_impact_case_study_001",
"title":"3D Speckle Vision from Academic Research to the Real-World",
"order": 119,
"impact_china": 1,
"impact_global": 1,
"unit_of_assessment": {
"unit_of_assessment":"UoA 14 - Mechanical engineering, production engineering (incl. manufacturing & industrial engineering), textile technology and aerospace engineering",
"uoa": 14,
"panel_name":"Engineering",
"uoa_name":"Mechanical engineering, production engineering (incl. manufacturing & industrial engineering), textile technology and aerospace engineering"
},
"institution":"City University of Hong Kong",
"topic_primary":{
"label":"Imaging & Diagnostics"
}
}
}
}Note: fetching an individual case study works the same as fetching all case studies. You can simply add?outputto the URL and pass the options you would like to use:?output=content,full
Fetching filters
To return all available filters, the call would look like:
| URL: | https://impact.ugc.edu.hk/api/filters/get | If no options are provided, it will default to returning all options |
| Method: | GET | |
| unit_of_assessment | /api/filters/get?options=unit_of_assessment | |
| Options: | institution | /api/filters/get?options=institution |
| impact_sectors | /api/filters/get?options=impact_sectors | |
| research_categories | /api/filters/get?options=research_categories | |
| topic_labels | /api/filters/get?options=topic_labels | |
| locations | /api/filters/get?options=locations | |
| funders | /api/filters/get?options=funders |
Note: The options can be combined similar to the?outputon case studies. For example:
https://impact.ugc.edu.hk/api/filters/get?options=institution,unit_of_assessment,topic_labels
{
"code":200,
"status":"success",
"message":"Filters fetched successfully",
"data":{
"body":{
"institution":[
"City University of Hong Kong",
"Hong Kong Baptist University",
"Lingnan University",
...
],
"unit_of_assessment":[
"UoA 1 - biological sciences (incl. environmental biology, biotechnology, agriculture & food science, veterinary studies)",
"UoA 2 - pre-clinical studies",
"UoA 3 - clinical medicine",
...
],
"topic_labels":[
"Art & culture",
"Business & commerce",
"Chinese language, translation & interpretation",
...
]
}
}
}Filter case studies
Filtering case studies is a POST request and therefore we need to send over the options as part request payload.
| URL: | https://impact.ugc.edu.hk/api/filter |
| Method: | POST |
Example post body structure
Note: impact_area is a string that accepts "impact_china" or "impact_global". All other values are arrays
{
"unit_of_assessment": []
"institution": []
"impact_sectors": []
"research_categories": []
"topic_labels": []
"locations": []
"funders": [],
"impact_area": ""
}Example with values
The values for each section can be any value returned from the filters endpoint in the prvious section. For example:
{
"unit_of_assessment": ["UoA 2 - pre-clinical studies", "UoA 3 - clinical medicine"]
"institution": ["Hong Kong Baptist University"]
"topic_labels": ["Art & culture"],
"impact_area": "impact_china"
}