Logo Onuma Inc.
 ONUMA Web Services
Architecture Services - Solutons Products


Products > 'REST' Web Services > Onuma Web Services API
Onuma Web Services API

ONUMA Web Services API (Phase 1 - 'GET'):

RESTful Web Services (V2-2012-01-03) (SOAP is also available on demand):

  1. GET 'ONUMA Studios':
    https://www.onuma.com/rest/<username>/<password>/
    -> returned XML file: getSys.xml

  2. GET 'ONUMA Schemes':
    https://www.onuma.com/rest/<username>/<password>/studios/<Studio ID>/
    -> returned XML file: getSite.xml

  3. GET 'ONUMA Buildings':
    https://www.onuma.com/rest/<username>/<password>/sites/S<Studio ID>_<Site ID>/
    -> returned XML file: getBldg.xml

  4. GET 'ONUMA Spaces':
    https://www.onuma.com/rest/<username>/<password>/buildings/
    B<Studio ID>_<Building ID>/
    -> returned XML file: getSpace.xml

  5. GET 'Space Attributes' Excel file:
    https://www.onuma.com/rest/<username>/<password>/buildings/
    B<Studio ID>_<Building ID>/SpaceAttributes/
    -> returned Excel file same as "Space Attribute Export" in ONUMA

  6. GET 'BIMXML':
    https://www.onuma.com/rest/<username>/<password>/buildings/
    B<Studio ID>_<Building ID>/BIMXML/
    -> returned XML file: same as BIMXML Revit 2011 Export in ONUMA

  7. GET 'Components' (FF&E):
    https://www.onuma.com/rest/<username>/<password>/buildings/
    B<Studio ID>_<Building ID>/Components/
    -> returned XML file: component.xml

  8. GET 'Building Attribute Value List of Schemes':
    https://www.onuma.com/rest/<username>/<password>/sites/
    S<Studio ID>_<Site ID>/BuildingValueLists/1/
    - > returned XML file: buildingValueList.xml

  9. GET 'Space Attribute Value List of Schemes':
    https://www.onuma.com/rest/<username>/<password>/sites/
    S<Studio ID>_<Site ID>/SpaceValueLists/1/
    - > returned XML file: spaceValueList.xml

  10. GET 'Department List of Schemes':
    https://www.onuma.com/rest/<username>/<password>/sites/
    S<Studio ID>_<Site ID>/Departments/
    -> returned XML file: departments.xml

  11. GET Data of individual spaces:
    https://www.onuma.com/rest/<username>/<password>/buildings/
    B<Studio ID>_<Building ID>/Spaces/<Space Number>
    or
    https://www.onuma.com/rest/<username>/<password>/buildings/
    B<Studio ID>_<Building ID>/Spaces/<Space ifcGUID>

  12. GET Data of individual components:
    https://www.onuma.com/rest/<username>/<password>/buildings/
    B<Studio ID>_<Building ID>/Components/<Component Name>
    or
    https://www.onuma.com/rest/<username>/<password>/buildings/
    B<Studio ID>_<Building ID>/Components/<Component ifcGUID>

Sample Code for PHP (using cURL and SimpleXML):
<?php

$u=<username>
$p=<password>
$sysID=<sysID>

$rs=urlencode("https://www.onuma.com/rest/".$u."/".$p."/");
$level = "studios/".$sysID."/";
$uri=$rs.$level;
//instantiate the cURL object
$cobj=curl_init($uri);
// the CURLOPT_RETURNTRANSFER parameter specifies that we
// want the data to transmit even if errors are encountered
curl_setopt($cobj,CURLOPT_RETURNTRANSFER,1);
// we then execute the transfer and pass the resulting data into a variable called $siteData
$siteData=curl_exec($cobj);
curl_close($cobj);

// we can now parse the XML data with SimpleXML
$siteXml = new SimpleXMLElement($siteData);

// to get the values in all rows in specific 'columns'
// in the array created by SimpleXML
foreach ($siteXml->RESULTSET[0]->ROW as $site){
  // prints all site IDs and names
  echo $site->COL[0]->DATA." - ".echo $site->COL[3]->DATA."<br />";
}

?>