POST api/building/create?trackingId={trackingId}

Create Building

Request Information

URI Parameters

NameDescriptionTypeAdditional information
trackingId

An ID supplied by the client to track or name this request

string

Required

Body Parameters

Required Building Details

Building
NameDescriptionTypeAdditional information
Address

An Address

Address

None.

Georesult

Georesult associated with address

string

None.

Latitude

Latitude of Address

decimal number

None.

Longitude

Longitude of Address

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "address": {
    "addressLine1": "sample string 1",
    "aptSuiteOther": "sample string 2",
    "city": "sample string 3",
    "state": "Item",
    "zipCode": "sample string 4"
  },
  "georesult": "sample string 1",
  "latitude": 2.0,
  "longitude": 3.0
}

application/xml, text/xml

Sample:
<Building xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twc.Models">
  <Address>
    <AddressLine1>sample string 1</AddressLine1>
    <AptSuiteOther>sample string 2</AptSuiteOther>
    <City>sample string 3</City>
    <State>Item</State>
    <ZipCode>sample string 4</ZipCode>
  </Address>
  <Georesult>sample string 1</Georesult>
  <Latitude>2</Latitude>
  <Longitude>3</Longitude>
</Building>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Either new or existing Midas Building Key

CreateBuildingResponse
NameDescriptionTypeAdditional information
TrackingID

string

None.

BuildingKey

integer

None.

ServiceReturnStatus

ServiceReturnStatus

None.

Response Formats

application/json, text/json

Sample:
{
  "trackingID": "sample string 1",
  "buildingKey": 2,
  "serviceReturnStatus": {
    "returnCode": 1,
    "returnMessage": "sample string 2",
    "responseTypeCode": 3,
    "responseTypeCodeSpecified": true,
    "responseTypeMessage": "sample string 5",
    "currentPeriodRequestsUsed": 6,
    "currentPeriodRequestsAvailable": 7
  }
}

application/xml, text/xml

Sample:
<CreateBuildingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twc.MidasWebServices">
  <BuildingKey>2</BuildingKey>
  <ServiceReturnStatus>
    <currentPeriodRequestsAvailableField>7</currentPeriodRequestsAvailableField>
    <currentPeriodRequestsUsedField>6</currentPeriodRequestsUsedField>
    <responseTypeCodeField>3</responseTypeCodeField>
    <responseTypeCodeFieldSpecified>true</responseTypeCodeFieldSpecified>
    <responseTypeMessageField>sample string 5</responseTypeMessageField>
    <returnCodeField>1</returnCodeField>
    <returnMessageField>sample string 2</returnMessageField>
  </ServiceReturnStatus>
  <TrackingID>sample string 1</TrackingID>
</CreateBuildingResponse>