GET api/building/{id}?trackingId={trackingId}
Building Detail
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
trackingId |
An ID supplied by the client to track or name this request |
string |
Required |
id |
Midas Building Key |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
success
BuildingDetailResponseName | Description | Type | Additional information |
---|---|---|---|
TrackingID | string |
None. |
|
BuildingDetail | BuildingDetail |
None. |
|
ServiceReturnStatus | ServiceReturnStatus |
None. |
Response Formats
application/json, text/json
Sample:
{ "trackingID": "sample string 1", "buildingDetail": { "buildingKey": 1, "buildingKeySpecified": true, "buildingName": "sample string 3", "buildingAddress": { "buildingName": "sample string 1", "address": "sample string 2", "city": "sample string 3", "state": "Item", "stateSpecified": true, "zipCode": "sample string 5" }, "geographicIdentifiers": { "mapLocation": { "mapPoint": { "latitude": 1.0, "latitudeSpecified": true, "longitude": 3.0, "longitudeSpecified": true }, "mapConfidence": { "georesult": "sample string 1", "georesultDescription": "sample string 2", "confidence": "sample string 3", "matchCode": "sample string 4", "locationCode": "sample string 5", "mapDisplayFlag": true, "mapDisplayFlagSpecified": true } }, "state": "Item", "stateSpecified": true, "stateFIPSCode": "sample string 2", "countyName": "sample string 3", "countyFIPSCode": "sample string 4", "countyGNISKey": 5, "countyGNISKeySpecified": true, "placeTownshipName": "sample string 7", "placeTownshipFIPSCode": "sample string 8", "placeTownshipGNISKey": 9, "placeTownshipGNISKeySpecified": true, "countyAndPlaceName": "sample string 11", "subDivisionName": "sample string 12", "censusBlock": "sample string 13", "spectrumDivision": "sample string 14", "spectrumRegion": "sample string 15", "spectrumMarketArea": "sample string 16" }, "billingDescriptors": { "billingInstanceName": "sample string 1", "billingInstanceKey": 2, "billingInstanceKeySpecified": true, "billingSystemTypeIndicator": "sample string 4", "billingSiteID": 5, "billingSiteIDSpecified": true, "franchiseCode": { "fullFranchiseCode": "sample string 1", "csg": { "sys": "sample string 1", "prin": "sample string 2", "agent": "sample string 3" }, "icoms": { "siteID": "sample string 1", "company": "sample string 2", "division": "sample string 3", "franchiseArea": "sample string 4" } }, "legacyMSO": "sample string 7" }, "addressType": "sample string 4", "businessCount": 5, "businessCountSpecified": true, "accountCount": 7, "accountCountSpecified": true, "numberOfFloors": 9, "numberOfFloorsSpecified": true, "largestBusinessName": "sample string 11", "largestAccountName": "sample string 12", "dominantVerticalName": "sample string 13", "buildingEmployeeCount": 14, "buildingEmployeeCountSpecified": true, "rateCenter": { "rateCenterAbbreviation": "sample string 1", "rateCenterName": "sample string 2", "rateCenterState": "sample string 3", "voiceEligibleFlag": true, "voiceEligibleFlagSpecified": true }, "wireCenter": { "wireCenterCLLICode": "sample string 1", "dslDistance": 2, "dslDistanceSpecified": true, "clliFromClones": "sample string 4" }, "node": "sample string 16", "hub": "sample string 17", "fiberPointName": "sample string 18", "buildingServiceability": { "fiberBuildingStatus": "sample string 1", "coaxServiceabilityColor": "sample string 2", "wholesaleFiberServiceability": "sample string 3", "serviceabilityStatusCodeNew": "sample string 4", "tierType": "sample string 5", "fttpType": "sample string 6" }, "buildingServiceIndicators": { "commercialFlag": true, "commercialFlagSpecified": true, "cellTowerIndicator": true, "cellTowerIndicatorSpecified": true }, "serviceabilityProximity": { "distanceToClosestServiceableBuilding": 1, "distanceToClosestServiceableBuildingSpecified": true, "closestServiceableBuildingKey": 3, "closestServiceableBuildingKeySpecified": true, "fiberPointRightTriangleDistance": 5, "fiberPointRightTriangleDistanceSpecified": true }, "trunkTN": { "isSpaAvailable": "sample string 1", "trunkTNAvailability": "sample string 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:
<BuildingDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twc.MidasWebServices"> <BuildingDetail> <ServiceabilityStatusCodeNew i:nil="true" /> <accountCountField>7</accountCountField> <accountCountFieldSpecified>true</accountCountFieldSpecified> <addressTypeField>sample string 4</addressTypeField> <billingDescriptorsField> <billingInstanceKeyField>2</billingInstanceKeyField> <billingInstanceKeyFieldSpecified>true</billingInstanceKeyFieldSpecified> <billingInstanceNameField>sample string 1</billingInstanceNameField> <billingSiteIDField>5</billingSiteIDField> <billingSiteIDFieldSpecified>true</billingSiteIDFieldSpecified> <billingSystemTypeIndicatorField>sample string 4</billingSystemTypeIndicatorField> <franchiseCodeField> <cSGField> <agentField>sample string 3</agentField> <prinField>sample string 2</prinField> <sysField>sample string 1</sysField> </cSGField> <fullFranchiseCodeField>sample string 1</fullFranchiseCodeField> <iCOMSField> <companyField>sample string 2</companyField> <divisionField>sample string 3</divisionField> <franchiseAreaField>sample string 4</franchiseAreaField> <siteIDField>sample string 1</siteIDField> </iCOMSField> </franchiseCodeField> <legacyMSOField>sample string 7</legacyMSOField> </billingDescriptorsField> <buildingAddressField> <addressField>sample string 2</addressField> <buildingNameField>sample string 1</buildingNameField> <cityField>sample string 3</cityField> <stateField>Item</stateField> <stateFieldSpecified>true</stateFieldSpecified> <zIPCodeField>sample string 5</zIPCodeField> </buildingAddressField> <buildingEmployeeCountField>14</buildingEmployeeCountField> <buildingEmployeeCountFieldSpecified>true</buildingEmployeeCountFieldSpecified> <buildingKeyField>1</buildingKeyField> <buildingKeyFieldSpecified>true</buildingKeyFieldSpecified> <buildingNameField>sample string 3</buildingNameField> <buildingServiceIndicatorsField> <cellTowerIndicatorField>true</cellTowerIndicatorField> <cellTowerIndicatorFieldSpecified>true</cellTowerIndicatorFieldSpecified> <commercialFlagField>true</commercialFlagField> <commercialFlagFieldSpecified>true</commercialFlagFieldSpecified> </buildingServiceIndicatorsField> <buildingServiceabilityField> <coaxServiceabilityColorField>sample string 2</coaxServiceabilityColorField> <fTTPTypeField>sample string 6</fTTPTypeField> <fiberBuildingStatusField>sample string 1</fiberBuildingStatusField> <serviceabilityStatusCodeNewField>sample string 4</serviceabilityStatusCodeNewField> <tierTypeField>sample string 5</tierTypeField> <wholesaleFiberServiceabilityField>sample string 3</wholesaleFiberServiceabilityField> </buildingServiceabilityField> <businessCountField>5</businessCountField> <businessCountFieldSpecified>true</businessCountFieldSpecified> <dominantVerticalNameField>sample string 13</dominantVerticalNameField> <fiberPointNameField>sample string 18</fiberPointNameField> <geographicIdentifiersField> <censusBlockField>sample string 13</censusBlockField> <countyAndPlaceNameField>sample string 11</countyAndPlaceNameField> <countyFIPSCodeField>sample string 4</countyFIPSCodeField> <countyGNISKeyField>5</countyGNISKeyField> <countyGNISKeyFieldSpecified>true</countyGNISKeyFieldSpecified> <countyNameField>sample string 3</countyNameField> <mapLocationField> <mapConfidenceField> <confidenceField>sample string 3</confidenceField> <georesultDescriptionField>sample string 2</georesultDescriptionField> <georesultField>sample string 1</georesultField> <locationCodeField>sample string 5</locationCodeField> <mapDisplayFlagField>true</mapDisplayFlagField> <mapDisplayFlagFieldSpecified>true</mapDisplayFlagFieldSpecified> <matchCodeField>sample string 4</matchCodeField> </mapConfidenceField> <mapPointField> <latitudeField>1</latitudeField> <latitudeFieldSpecified>true</latitudeFieldSpecified> <longitudeField>3</longitudeField> <longitudeFieldSpecified>true</longitudeFieldSpecified> </mapPointField> </mapLocationField> <placeTownshipFIPSCodeField>sample string 8</placeTownshipFIPSCodeField> <placeTownshipGNISKeyField>9</placeTownshipGNISKeyField> <placeTownshipGNISKeyFieldSpecified>true</placeTownshipGNISKeyFieldSpecified> <placeTownshipNameField>sample string 7</placeTownshipNameField> <spectrumDivisionField>sample string 14</spectrumDivisionField> <spectrumMarketAreaField>sample string 16</spectrumMarketAreaField> <spectrumRegionField>sample string 15</spectrumRegionField> <stateFIPSCodeField>sample string 2</stateFIPSCodeField> <stateField>Item</stateField> <stateFieldSpecified>true</stateFieldSpecified> <subDivisionNameField>sample string 12</subDivisionNameField> </geographicIdentifiersField> <hubField>sample string 17</hubField> <largestAccountNameField>sample string 12</largestAccountNameField> <largestBusinessNameField>sample string 11</largestBusinessNameField> <nodeField>sample string 16</nodeField> <numberOfFloorsField>9</numberOfFloorsField> <numberOfFloorsFieldSpecified>true</numberOfFloorsFieldSpecified> <rateCenterField> <rateCenterAbbreviationField>sample string 1</rateCenterAbbreviationField> <rateCenterNameField>sample string 2</rateCenterNameField> <rateCenterStateField>sample string 3</rateCenterStateField> <voiceEligibleFlagField>true</voiceEligibleFlagField> <voiceEligibleFlagFieldSpecified>true</voiceEligibleFlagFieldSpecified> </rateCenterField> <serviceabilityProximityField> <closestServiceableBuildingKeyField>3</closestServiceableBuildingKeyField> <closestServiceableBuildingKeyFieldSpecified>true</closestServiceableBuildingKeyFieldSpecified> <distanceToClosestServiceableBuildingField>1</distanceToClosestServiceableBuildingField> <distanceToClosestServiceableBuildingFieldSpecified>true</distanceToClosestServiceableBuildingFieldSpecified> <fiberPointRightTriangleDistanceField>5</fiberPointRightTriangleDistanceField> <fiberPointRightTriangleDistanceFieldSpecified>true</fiberPointRightTriangleDistanceFieldSpecified> </serviceabilityProximityField> <trunkTNField> <isSpaAvailableField>sample string 1</isSpaAvailableField> <trunkTNAvailabilityField>sample string 2</trunkTNAvailabilityField> </trunkTNField> <wireCenterField> <cLLIFromClonesField>sample string 4</cLLIFromClonesField> <dSLDistanceField>2</dSLDistanceField> <dSLDistanceFieldSpecified>true</dSLDistanceFieldSpecified> <wireCenterCLLICodeField>sample string 1</wireCenterCLLICodeField> </wireCenterField> </BuildingDetail> <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> </BuildingDetailResponse>