GET api/building/{id}/business?trackingId={trackingId}&maxResults={maxResults}

Building Business List

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
maxResults	Maximum Number of Results to Return	integer	Default value is 10

Body Parameters

None.

Response Information

Resource Description

success

BusinessesInBuildingResponse

Name	Type	Additional information
TrackingID	string	None.
BuildingKey	integer	None.
BusinessesInBuildingCandidateList	BusinessesInBuildingResponseBusinessesInBuildingCandidateList	None.
ServiceReturnStatus	ServiceReturnStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "trackingID": "sample string 1",
  "buildingKey": 2,
  "businessesInBuildingCandidateList": {
    "businessesInBuildingCandidate": [
      {
        "businessKey": 1,
        "businessKeySpecified": true,
        "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"
        },
        "businessName": "sample string 3",
        "businessNameAlternative": "sample string 4",
        "contactTitle": "sample string 5",
        "contactProfessionalTitle": "sample string 6",
        "contactFirstName": "sample string 7",
        "contactLastName": "sample string 8",
        "contactPhone": "sample string 9",
        "nixed": "sample string 10",
        "nixedReason": "sample string 11",
        "inCVC": true,
        "inCVCSpecified": true,
        "verticalName": "sample string 14",
        "segmentName": "sample string 15",
        "employeeCount": "sample string 16",
        "itemNumber": "sample string 17"
      },
      {
        "businessKey": 1,
        "businessKeySpecified": true,
        "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"
        },
        "businessName": "sample string 3",
        "businessNameAlternative": "sample string 4",
        "contactTitle": "sample string 5",
        "contactProfessionalTitle": "sample string 6",
        "contactFirstName": "sample string 7",
        "contactLastName": "sample string 8",
        "contactPhone": "sample string 9",
        "nixed": "sample string 10",
        "nixedReason": "sample string 11",
        "inCVC": true,
        "inCVCSpecified": true,
        "verticalName": "sample string 14",
        "segmentName": "sample string 15",
        "employeeCount": "sample string 16",
        "itemNumber": "sample string 17"
      }
    ],
    "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:

<BusinessesInBuildingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twc.MidasWebServices">
  <BuildingKey>2</BuildingKey>
  <BusinessesInBuildingCandidateList>
    <businessesInBuildingCandidateField>
      <BusinessesInBuildingResponseBusinessesInBuildingCandidateListBusinessesInBuildingCandidate>
        <actualEmployeeCountField i:nil="true" />
        <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>
        <businessKeyField>1</businessKeyField>
        <businessKeyFieldSpecified>true</businessKeyFieldSpecified>
        <businessNameAlternativeField>sample string 4</businessNameAlternativeField>
        <businessNameField>sample string 3</businessNameField>
        <contactFirstNameField>sample string 7</contactFirstNameField>
        <contactLastNameField>sample string 8</contactLastNameField>
        <contactPhoneField>sample string 9</contactPhoneField>
        <contactProfessionalTitleField>sample string 6</contactProfessionalTitleField>
        <contactTitleField>sample string 5</contactTitleField>
        <employeeCountField>sample string 16</employeeCountField>
        <inCVCField>true</inCVCField>
        <inCVCFieldSpecified>true</inCVCFieldSpecified>
        <itemNumberField>sample string 17</itemNumberField>
        <nixedField>sample string 10</nixedField>
        <nixedReasonField>sample string 11</nixedReasonField>
        <segmentNameField>sample string 15</segmentNameField>
        <verticalNameField>sample string 14</verticalNameField>
      </BusinessesInBuildingResponseBusinessesInBuildingCandidateListBusinessesInBuildingCandidate>
      <BusinessesInBuildingResponseBusinessesInBuildingCandidateListBusinessesInBuildingCandidate>
        <actualEmployeeCountField i:nil="true" />
        <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>
        <businessKeyField>1</businessKeyField>
        <businessKeyFieldSpecified>true</businessKeyFieldSpecified>
        <businessNameAlternativeField>sample string 4</businessNameAlternativeField>
        <businessNameField>sample string 3</businessNameField>
        <contactFirstNameField>sample string 7</contactFirstNameField>
        <contactLastNameField>sample string 8</contactLastNameField>
        <contactPhoneField>sample string 9</contactPhoneField>
        <contactProfessionalTitleField>sample string 6</contactProfessionalTitleField>
        <contactTitleField>sample string 5</contactTitleField>
        <employeeCountField>sample string 16</employeeCountField>
        <inCVCField>true</inCVCField>
        <inCVCFieldSpecified>true</inCVCFieldSpecified>
        <itemNumberField>sample string 17</itemNumberField>
        <nixedField>sample string 10</nixedField>
        <nixedReasonField>sample string 11</nixedReasonField>
        <segmentNameField>sample string 15</segmentNameField>
        <verticalNameField>sample string 14</verticalNameField>
      </BusinessesInBuildingResponseBusinessesInBuildingCandidateListBusinessesInBuildingCandidate>
    </businessesInBuildingCandidateField>
    <countField>sample string 1</countField>
  </BusinessesInBuildingCandidateList>
  <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>
</BusinessesInBuildingResponse>