CreateBuilding Documentation
CreateBuilding
Draft documentation version
Documentation is partial and not validated !
Description
Version | V1 |
---|---|
Require User context | |
Authorization | |
Errors |
Request
Route
Parameters
Parameter | Required | Sample | Description |
---|---|---|---|
WAC | WAC123456789012 | Code of BusinessAccount | |
BuildingTypeLibraryID | 2 | ID of BuildingTypeLibrary | |
Code | MyBuildingCode | Your Infrastructure internal code | |
Description | My Buildingdescription | 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
.xml
suffix or?format=xml
- To embed the response in a jsonp callback, append
?callback=myCallback
Post Data sample
POST /xml/reply/CreateBuilding HTTP/1.1
Host: localhost
Content-Type: application/xml
Content-Length: length
<CreateBuilding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WIT.DataCenter.DTOs.Request">
<WAC>String</WAC>
<Code>String</Code>
<Description>String</Description>
<Name>String</Name>
<ParentInfrastructureID>0</ParentInfrastructureID>
<Surface>0</Surface>
</CreateBuilding>
cURL command sample
curl -k -H "Authorization: Bearer [YOUR_ACCESS_TOKEN]" -H "Content-Type:application/xml" -X POST -d @filename.xml https://api.wit-datacenter.com/WAC123456789012/Infrastructure/Building
Remark
@filename.xml
contain your request parameters serialized in XML as described in Post Data sample bottom
Response
Returned Entity
Created BuildingXML Sample
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <Building xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.wit-datacenter.com/"> <ID>0</ID> <Name>String</Name> <Picture>00000000-0000-0000-0000-000000000000</Picture> <Code>String</Code> <CreationDate>0001-01-01T00:00:00</CreationDate> <Description>String</Description> <UpdateDate>0001-01-01T00:00:00</UpdateDate> <ParentInfrastructureID>0</ParentInfrastructureID> <Surface>0</Surface> </Building>