UpdateBuilding Documentation
UpdateBuilding
Draft documentation version
Documentation is partial and not validated !
Description
Version | V1 |
---|---|
Require User context | |
Authorization | |
Errors |
Request
Route
Parameters
Parameter | Required | Sample | Description |
---|---|---|---|
BuildingID | 8 | ID of Building | |
WAC | WAC123456789012 | Code of BusinessAccount | |
BuildingTypeLibraryID | 3 | ID of BuildingTypeLibrary | |
Code | MyBuildingCode | Your Infrastructure internal code | |
Description | My Building description | Infrastructure description | |
Name | My Building name | Infrastructure name | |
ParentInfrastructureID | 4 | ID of parent InfrastructureBase. Leave empty if no parent | |
Surface | 235 | Building surface (M2) |
Remarks
- To override Content-type in your clients HTTP Accept Header, append the
.csv
suffix or?format=csv
- To embed the response in a jsonp callback, append
?callback=myCallback
Post Data sample
POST /csv/reply/UpdateBuilding HTTP/1.1
Host: localhost
Content-Type: text/csv
Content-Length: length
BuildingID,Surface,Name,Description,Code,ParentInfrastructureID,WAC
0,0,String,String,String,0,String
cURL command sample
curl -k -H "Authorization: Bearer [YOUR_ACCESS_TOKEN]" -H "Content-Type:application/csv" -X PUT -d @filename.csv https://api.wit-datacenter.com/WAC123456789012/Infrastructure/Building/8
Remark
@filename.csv
contain your request parameters serialized in CSV as described in Post Data sample bottom
Response
Returned Entity
Updated BuildingCSV Sample
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length Surface,ParentInfrastructureID,Description,Code,CreationDate,UpdateDate,ID,Picture,Name 0,0,String,String,0001-01-01,0001-01-01,0,00000000000000000000000000000000,String