GET api/building/{id}/billing?trackingId={trackingId}

Building Billing 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

BillingViewOfBuildingResponse

Name	Type	Additional information
TrackingID	string	None.
BillingViewOfBuildingList	BillingViewOfBuildingResponseBillingViewOfBuildingList	None.
ServiceReturnStatus	ServiceReturnStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "trackingID": "sample string 1",
  "billingViewOfBuildingList": {
    "billingViewOfBuildingCandidate": [
      {
        "buildingKey": 1,
        "buildingKeySpecified": true,
        "buildingAddress": {
          "buildingName": "sample string 1",
          "address": "sample string 2",
          "city": "sample string 3",
          "state": "Item",
          "stateSpecified": true,
          "zipCode": "sample string 5"
        },
        "deliveryPointValidation": {
          "dpvResultCode": "sample string 1",
          "dpvResultCodeDescription": "sample string 2",
          "dpvResultFootnote": "sample string 3"
        },
        "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"
        },
        "billingHouseNumber": "sample string 3",
        "billingAccountNumber": "sample string 4",
        "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"
        },
        "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"
        },
        "itemNumber": "sample string 5"
      },
      {
        "buildingKey": 1,
        "buildingKeySpecified": true,
        "buildingAddress": {
          "buildingName": "sample string 1",
          "address": "sample string 2",
          "city": "sample string 3",
          "state": "Item",
          "stateSpecified": true,
          "zipCode": "sample string 5"
        },
        "deliveryPointValidation": {
          "dpvResultCode": "sample string 1",
          "dpvResultCodeDescription": "sample string 2",
          "dpvResultFootnote": "sample string 3"
        },
        "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"
        },
        "billingHouseNumber": "sample string 3",
        "billingAccountNumber": "sample string 4",
        "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"
        },
        "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"
        },
        "itemNumber": "sample string 5"
      }
    ],
    "count": "sample string 1"
  },
  "serviceReturnStatus": {
    "returnCode": 1,
    "returnMessage": "sample string 2",
    "responseTypeCode": 3,
    "responseTypeCodeSpecified": true,
    "responseTypeMessage": "sample string 5",
    "currentPeriodRequestsUsed": 6,
    "currentPeriodRequestsAvailable": 7
  }
}

application/xml, text/xml

Sample:

<BillingViewOfBuildingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twc.MidasWebServices">
  <BillingViewOfBuildingList>
    <billingViewOfBuildingCandidateField>
      <BillingViewOfBuildingResponseBillingViewOfBuildingListBillingViewOfBuildingCandidate>
        <billingAccountNumberField>sample string 4</billingAccountNumberField>
        <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>
        <billingHouseNumberField>sample string 3</billingHouseNumberField>
        <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>
        <buildingKeyField>1</buildingKeyField>
        <buildingKeyFieldSpecified>true</buildingKeyFieldSpecified>
        <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>
        <deliveryPointValidationField>
          <dPVResultCodeDescriptionField>sample string 2</dPVResultCodeDescriptionField>
          <dPVResultCodeField>sample string 1</dPVResultCodeField>
          <dPVResultFootnoteField>sample string 3</dPVResultFootnoteField>
        </deliveryPointValidationField>
        <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>
        <itemNumberField>sample string 5</itemNumberField>
      </BillingViewOfBuildingResponseBillingViewOfBuildingListBillingViewOfBuildingCandidate>
      <BillingViewOfBuildingResponseBillingViewOfBuildingListBillingViewOfBuildingCandidate>
        <billingAccountNumberField>sample string 4</billingAccountNumberField>
        <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>
        <billingHouseNumberField>sample string 3</billingHouseNumberField>
        <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>
        <buildingKeyField>1</buildingKeyField>
        <buildingKeyFieldSpecified>true</buildingKeyFieldSpecified>
        <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>
        <deliveryPointValidationField>
          <dPVResultCodeDescriptionField>sample string 2</dPVResultCodeDescriptionField>
          <dPVResultCodeField>sample string 1</dPVResultCodeField>
          <dPVResultFootnoteField>sample string 3</dPVResultFootnoteField>
        </deliveryPointValidationField>
        <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>
        <itemNumberField>sample string 5</itemNumberField>
      </BillingViewOfBuildingResponseBillingViewOfBuildingListBillingViewOfBuildingCandidate>
    </billingViewOfBuildingCandidateField>
    <countField>sample string 1</countField>
  </BillingViewOfBuildingList>
  <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>
</BillingViewOfBuildingResponse>