API documentation

 
 
Get Projects Details
To get room based projects with finish level options and room unit sizes.
Usage
<<Base URL>>/api/
project/getProjects/?accessToken=<kukunEnterpriseAccessToken>& projectType=<projectType>
Example:
https://apidev.mykukun.com/api/project/getProjects/?accessToken=xxxxxxxxxxxxxxx0x1x2x3x4xac97ece0>&projectType=room
https://apidev.mykukun.com/api/project/ getProjects/?accessToken =xxxxxxxxxxxxxxx0x1x2x3x4xac97ece0 >&projectType=room
REST Methods
Method
Purpose
Input
Content-Type
Output
GET
Get room based projects with finish level options and room unit sizes.
AccessToken and projectType
Application/json
{"success":true,"message":[{"projectName":"Kitchen","projectTypeOrganizationId":5,"projectTypeId":5,"projectRoomConfigurations":{"estimationTypes":[{"id":1,"name":"Addition"},{"id":2,"name":"Expansion"},{"id":3,"name":"Renovation"}],"expansionTypeDetails":[{"id":1,"name":"Adding to the size of the home","additionalSize":null},{"id":2,"name":"Moving internal walls","additionalSize":null}],"additionTypeDetails":[{"id":1,"name":"Second story"},{"id":2,"name":"Single story"}]},"finishLevelDetails":[{"finishLevelOrganizationId":2,"finishLevelName":"Ready to sell"},{"finishLevelOrganizationId":3,"finishLevelName":"Typical Renovation"},{"finishLevelOrganizationId":4,"finishLevelName":"Down to the Studs"}],"projectUnitDetails": [{"projectUnitOrganizationId": 16,"projectUnitName": "Small","projectUnitWidth": 10.0,"projectUnitLength": 7.0,"projectUnitTotalUnit": 70.0,"projectSizeName": "sq.ft"},{"projectUnitOrganizationId": 17,"projectUnitName": "Medium","projectUnitWidth": 10.0,"projectUnitLength": 14.0,"projectUnitTotalUnit": 140.0,"projectSizeName": "sq.ft"},{"projectUnitOrganizationId": 18,"projectUnitName": "Large","projectUnitWidth": 16.0,"projectUnitLength": 18.0,"projectUnitTotalUnit": 288.0,"projectSizeName": "sq.ft"},{"projectUnitOrganizationId": 19,"projectUnitName": "Custom","projectUnitWidth": 0.0,"projectUnitLength": 0.0,"projectUnitTotalUnit": 0.0,"projectSizeName": "sq.ft"}]}]}
Method
GET
Purpose
Get room based projects with finish level options and room unit sizes.
Input
AccessToken and projectType
Content-Type
Application/json
Output
{"success":true,"message":[{"projectName":"Kitchen","projectTypeOrganizationId":5,"projectTypeId":5,"projectRoomConfigurations":{"estimationTypes":[{"id":1,"name":"Addition"},{"id":2,"name":"Expansion"},{"id":3,"name":"Renovation"}],"expansionTypeDetails":[{"id":1,"name":"Adding to the size of the home","additionalSize":null},{"id":2,"name":"Moving internal walls","additionalSize":null}],"additionTypeDetails":[{"id":1,"name":"Second story"},{"id":2,"name":"Single story"}]},"finishLevelDetails":[{"finishLevelOrganizationId":2,"finishLevelName":"Ready to sell"},{"finishLevelOrganizationId":3,"finishLevelName":"Typical Renovation"},{"finishLevelOrganizationId":4,"finishLevelName":"Down to the Studs"}],"projectUnitDetails": [{"projectUnitOrganizationId": 16,"projectUnitName": "Small","projectUnitWidth": 10.0,"projectUnitLength": 7.0,"projectUnitTotalUnit": 70.0,"projectSizeName": "sq.ft"},{"projectUnitOrganizationId": 17,"projectUnitName": "Medium","projectUnitWidth": 10.0,"projectUnitLength": 14.0,"projectUnitTotalUnit": 140.0,"projectSizeName": "sq.ft"},{"projectUnitOrganizationId": 18,"projectUnitName": "Large","projectUnitWidth": 16.0,"projectUnitLength": 18.0,"projectUnitTotalUnit": 288.0,"projectSizeName": "sq.ft"},{"projectUnitOrganizationId": 19,"projectUnitName": "Custom","projectUnitWidth": 0.0,"projectUnitLength": 0.0,"projectUnitTotalUnit": 0.0,"projectSizeName": "sq.ft"}]}]}