POST api/list/sitesurveyUS?trackingId={trackingId}

Midasizer SiteSurvey

Request Information

URI Parameters

Name	Description	Type	Additional information
trackingId	An ID supplied by the client to track or name this request	string	Required

Body Parameters

Addresses to be Midasized with SiteSurvey additions

MidasizerRequestRequestAddressCandidateList

Name	Description	Type	Additional information
RequestAddressCandidate		Collection of MidasizerRequestRequestAddressCandidateListRequestAddressCandidate	None.
Count		string	None.

Request Formats

application/json, text/json

Sample:

{
  "requestAddressCandidate": [
    {
      "requestAddress": {
        "address": "sample string 1",
        "aptSuiteOther": "sample string 2",
        "city": "sample string 3",
        "state": "Item",
        "stateSpecified": true,
        "zipCode": "sample string 5",
        "preferenceName": "sample string 6"
      },
      "clientAddressKey": "sample string 1"
    },
    {
      "requestAddress": {
        "address": "sample string 1",
        "aptSuiteOther": "sample string 2",
        "city": "sample string 3",
        "state": "Item",
        "stateSpecified": true,
        "zipCode": "sample string 5",
        "preferenceName": "sample string 6"
      },
      "clientAddressKey": "sample string 1"
    }
  ],
  "count": "sample string 1"
}

application/xml, text/xml

Sample:

<MidasizerRequestRequestAddressCandidateList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twc.MidasWebServices">
  <countField>sample string 1</countField>
  <requestAddressCandidateField>
    <MidasizerRequestRequestAddressCandidateListRequestAddressCandidate>
      <clientAddressKeyField>sample string 1</clientAddressKeyField>
      <requestAddressField>
        <addressField>sample string 1</addressField>
        <aptSuiteOtherField>sample string 2</aptSuiteOtherField>
        <cityField>sample string 3</cityField>
        <preferenceNameField>sample string 6</preferenceNameField>
        <stateField>Item</stateField>
        <stateFieldSpecified>true</stateFieldSpecified>
        <zIPCodeField>sample string 5</zIPCodeField>
      </requestAddressField>
    </MidasizerRequestRequestAddressCandidateListRequestAddressCandidate>
    <MidasizerRequestRequestAddressCandidateListRequestAddressCandidate>
      <clientAddressKeyField>sample string 1</clientAddressKeyField>
      <requestAddressField>
        <addressField>sample string 1</addressField>
        <aptSuiteOtherField>sample string 2</aptSuiteOtherField>
        <cityField>sample string 3</cityField>
        <preferenceNameField>sample string 6</preferenceNameField>
        <stateField>Item</stateField>
        <stateFieldSpecified>true</stateFieldSpecified>
        <zIPCodeField>sample string 5</zIPCodeField>
      </requestAddressField>
    </MidasizerRequestRequestAddressCandidateListRequestAddressCandidate>
  </requestAddressCandidateField>
</MidasizerRequestRequestAddressCandidateList>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

success

MidasizerSiteSurveyUSResponse

Name	Type	Additional information
TrackingID	string	None.
AddressCandidateListFromGeocoderForMidasizerSiteSurvey	AddressCandidateListFromGeocoderForMidasizerSiteSurveyUS	None.
ServiceReturnStatus	ServiceReturnStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "trackingID": "sample string 1",
  "addressCandidateListFromGeocoderForMidasizerSiteSurvey": {
    "addressCandidate": [
      {
        "address": "sample string 1",
        "city": "sample string 2",
        "state": "Item",
        "stateSpecified": true,
        "zipCode": "sample string 4",
        "midasizerSiteSurveyDetail": {
          "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"
          },
          "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"
          },
          "buildingServiceability": {
            "fiberBuildingStatus": "sample string 1",
            "coaxServiceabilityColor": "sample string 2",
            "wholesaleFiberStatus": "sample string 3",
            "installationInterval": "sample string 4",
            "pricingTier": "sample string 5",
            "serviceabilityStatusCodeNew": "sample string 6"
          },
          "serviceabilityProximity": {
            "distanceToClosestServiceableBuilding": 1,
            "distanceToClosestServiceableBuildingSpecified": true,
            "closestServiceableBuildingKey": 3,
            "closestServiceableBuildingKeySpecified": true,
            "fiberPointRightTriangleDistance": 5,
            "fiberPointRightTriangleDistanceSpecified": true
          },
          "addressType": "sample string 3",
          "siteSurveyDetailCoax": {
            "siteSurveyID": "sample string 1",
            "completedDate": "2024-09-19T09:44:33.1713934-05:00",
            "completedDateSpecified": true,
            "completeOutcome": "sample string 4",
            "totalCost": 5.0,
            "totalCostSpecified": true
          },
          "siteSurveyDetailFiber": {
            "siteSurveyID": "sample string 1",
            "completedDate": "2024-09-19T09:44:33.1713934-05:00",
            "completedDateSpecified": true,
            "completeOutcome": "sample string 4",
            "totalCost": 5.0,
            "totalCostSpecified": true
          },
          "spectrumDivision": "sample string 4",
          "spectrumRegion": "sample string 5",
          "spectrumMarketArea": "sample string 6",
          "modelFiberCost": "sample string 7"
        },
        "midasizerStatus": "sample string 5",
        "clientAddressKey": "sample string 6",
        "requestNumber": 7
      },
      {
        "address": "sample string 1",
        "city": "sample string 2",
        "state": "Item",
        "stateSpecified": true,
        "zipCode": "sample string 4",
        "midasizerSiteSurveyDetail": {
          "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"
          },
          "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"
          },
          "buildingServiceability": {
            "fiberBuildingStatus": "sample string 1",
            "coaxServiceabilityColor": "sample string 2",
            "wholesaleFiberStatus": "sample string 3",
            "installationInterval": "sample string 4",
            "pricingTier": "sample string 5",
            "serviceabilityStatusCodeNew": "sample string 6"
          },
          "serviceabilityProximity": {
            "distanceToClosestServiceableBuilding": 1,
            "distanceToClosestServiceableBuildingSpecified": true,
            "closestServiceableBuildingKey": 3,
            "closestServiceableBuildingKeySpecified": true,
            "fiberPointRightTriangleDistance": 5,
            "fiberPointRightTriangleDistanceSpecified": true
          },
          "addressType": "sample string 3",
          "siteSurveyDetailCoax": {
            "siteSurveyID": "sample string 1",
            "completedDate": "2024-09-19T09:44:33.1713934-05:00",
            "completedDateSpecified": true,
            "completeOutcome": "sample string 4",
            "totalCost": 5.0,
            "totalCostSpecified": true
          },
          "siteSurveyDetailFiber": {
            "siteSurveyID": "sample string 1",
            "completedDate": "2024-09-19T09:44:33.1713934-05:00",
            "completedDateSpecified": true,
            "completeOutcome": "sample string 4",
            "totalCost": 5.0,
            "totalCostSpecified": true
          },
          "spectrumDivision": "sample string 4",
          "spectrumRegion": "sample string 5",
          "spectrumMarketArea": "sample string 6",
          "modelFiberCost": "sample string 7"
        },
        "midasizerStatus": "sample string 5",
        "clientAddressKey": "sample string 6",
        "requestNumber": 7
      }
    ],
    "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:

<MidasizerSiteSurveyUSResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twc.MidasWebServices">
  <AddressCandidateListFromGeocoderForMidasizerSiteSurvey>
    <addressCandidateField>
      <AddressCandidateListFromGeocoderForMidasizerSiteSurveyUSAddressCandidate>
        <addressField>sample string 1</addressField>
        <cityField>sample string 2</cityField>
        <clientAddressKeyField>sample string 6</clientAddressKeyField>
        <midasizerSiteSurveyDetailField>
          <addressTypeField>sample string 3</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>
          <buildingKeyField>1</buildingKeyField>
          <buildingKeyFieldSpecified>true</buildingKeyFieldSpecified>
          <buildingServiceabilityField>
            <coaxServiceabilityColorField>sample string 2</coaxServiceabilityColorField>
            <fiberBuildingStatusField>sample string 1</fiberBuildingStatusField>
            <installationIntervalField>sample string 4</installationIntervalField>
            <pricingTierField>sample string 5</pricingTierField>
            <serviceabilityStatusCodeNewField>sample string 6</serviceabilityStatusCodeNewField>
            <wholesaleFiberStatusField>sample string 3</wholesaleFiberStatusField>
          </buildingServiceabilityField>
          <modelFiberCostField>sample string 7</modelFiberCostField>
          <serviceabilityProximityField>
            <closestServiceableBuildingKeyField>3</closestServiceableBuildingKeyField>
            <closestServiceableBuildingKeyFieldSpecified>true</closestServiceableBuildingKeyFieldSpecified>
            <distanceToClosestServiceableBuildingField>1</distanceToClosestServiceableBuildingField>
            <distanceToClosestServiceableBuildingFieldSpecified>true</distanceToClosestServiceableBuildingFieldSpecified>
            <fiberPointRightTriangleDistanceField>5</fiberPointRightTriangleDistanceField>
            <fiberPointRightTriangleDistanceFieldSpecified>true</fiberPointRightTriangleDistanceFieldSpecified>
          </serviceabilityProximityField>
          <siteSurveyDetailCoaxField>
            <completeOutcomeField>sample string 4</completeOutcomeField>
            <completedDateField>2024-09-19T09:44:33.1713934-05:00</completedDateField>
            <completedDateFieldSpecified>true</completedDateFieldSpecified>
            <siteSurveyIDField>sample string 1</siteSurveyIDField>
            <totalCostField>5</totalCostField>
            <totalCostFieldSpecified>true</totalCostFieldSpecified>
          </siteSurveyDetailCoaxField>
          <siteSurveyDetailFiberField>
            <completeOutcomeField>sample string 4</completeOutcomeField>
            <completedDateField>2024-09-19T09:44:33.1713934-05:00</completedDateField>
            <completedDateFieldSpecified>true</completedDateFieldSpecified>
            <siteSurveyIDField>sample string 1</siteSurveyIDField>
            <totalCostField>5</totalCostField>
            <totalCostFieldSpecified>true</totalCostFieldSpecified>
          </siteSurveyDetailFiberField>
          <spectrumDivisionField>sample string 4</spectrumDivisionField>
          <spectrumMarketAreaField>sample string 6</spectrumMarketAreaField>
          <spectrumRegionField>sample string 5</spectrumRegionField>
        </midasizerSiteSurveyDetailField>
        <midasizerStatusField>sample string 5</midasizerStatusField>
        <requestNumberField>7</requestNumberField>
        <stateField>Item</stateField>
        <stateFieldSpecified>true</stateFieldSpecified>
        <zIPCodeField>sample string 4</zIPCodeField>
      </AddressCandidateListFromGeocoderForMidasizerSiteSurveyUSAddressCandidate>
      <AddressCandidateListFromGeocoderForMidasizerSiteSurveyUSAddressCandidate>
        <addressField>sample string 1</addressField>
        <cityField>sample string 2</cityField>
        <clientAddressKeyField>sample string 6</clientAddressKeyField>
        <midasizerSiteSurveyDetailField>
          <addressTypeField>sample string 3</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>
          <buildingKeyField>1</buildingKeyField>
          <buildingKeyFieldSpecified>true</buildingKeyFieldSpecified>
          <buildingServiceabilityField>
            <coaxServiceabilityColorField>sample string 2</coaxServiceabilityColorField>
            <fiberBuildingStatusField>sample string 1</fiberBuildingStatusField>
            <installationIntervalField>sample string 4</installationIntervalField>
            <pricingTierField>sample string 5</pricingTierField>
            <serviceabilityStatusCodeNewField>sample string 6</serviceabilityStatusCodeNewField>
            <wholesaleFiberStatusField>sample string 3</wholesaleFiberStatusField>
          </buildingServiceabilityField>
          <modelFiberCostField>sample string 7</modelFiberCostField>
          <serviceabilityProximityField>
            <closestServiceableBuildingKeyField>3</closestServiceableBuildingKeyField>
            <closestServiceableBuildingKeyFieldSpecified>true</closestServiceableBuildingKeyFieldSpecified>
            <distanceToClosestServiceableBuildingField>1</distanceToClosestServiceableBuildingField>
            <distanceToClosestServiceableBuildingFieldSpecified>true</distanceToClosestServiceableBuildingFieldSpecified>
            <fiberPointRightTriangleDistanceField>5</fiberPointRightTriangleDistanceField>
            <fiberPointRightTriangleDistanceFieldSpecified>true</fiberPointRightTriangleDistanceFieldSpecified>
          </serviceabilityProximityField>
          <siteSurveyDetailCoaxField>
            <completeOutcomeField>sample string 4</completeOutcomeField>
            <completedDateField>2024-09-19T09:44:33.1713934-05:00</completedDateField>
            <completedDateFieldSpecified>true</completedDateFieldSpecified>
            <siteSurveyIDField>sample string 1</siteSurveyIDField>
            <totalCostField>5</totalCostField>
            <totalCostFieldSpecified>true</totalCostFieldSpecified>
          </siteSurveyDetailCoaxField>
          <siteSurveyDetailFiberField>
            <completeOutcomeField>sample string 4</completeOutcomeField>
            <completedDateField>2024-09-19T09:44:33.1713934-05:00</completedDateField>
            <completedDateFieldSpecified>true</completedDateFieldSpecified>
            <siteSurveyIDField>sample string 1</siteSurveyIDField>
            <totalCostField>5</totalCostField>
            <totalCostFieldSpecified>true</totalCostFieldSpecified>
          </siteSurveyDetailFiberField>
          <spectrumDivisionField>sample string 4</spectrumDivisionField>
          <spectrumMarketAreaField>sample string 6</spectrumMarketAreaField>
          <spectrumRegionField>sample string 5</spectrumRegionField>
        </midasizerSiteSurveyDetailField>
        <midasizerStatusField>sample string 5</midasizerStatusField>
        <requestNumberField>7</requestNumberField>
        <stateField>Item</stateField>
        <stateFieldSpecified>true</stateFieldSpecified>
        <zIPCodeField>sample string 4</zIPCodeField>
      </AddressCandidateListFromGeocoderForMidasizerSiteSurveyUSAddressCandidate>
    </addressCandidateField>
    <countField>sample string 1</countField>
  </AddressCandidateListFromGeocoderForMidasizerSiteSurvey>
  <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>
</MidasizerSiteSurveyUSResponse>