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

Midasizer Premise

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 Premise specifics

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

MidasizerPremiseResponse

Name	Type	Additional information
TrackingID	string	None.
AddressCandidateListFromGeocoderForMidasizerPremise	AddressCandidateListFromGeocoderForMidasizerPremise	None.
ServiceReturnStatus	ServiceReturnStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "trackingID": "sample string 1",
  "addressCandidateListFromGeocoderForMidasizerPremise": {
    "addressCandidate": [
      {
        "address": "sample string 1",
        "city": "sample string 2",
        "state": "Item",
        "stateSpecified": true,
        "zipCode": "sample string 4",
        "zipPlus4": "sample string 5",
        "deliveryPointValidation": {
          "dpvResultCode": "sample string 1",
          "dpvResultCodeDescription": "sample string 2",
          "dpvResultFootnote": "sample string 3"
        },
        "midasizerPremiseDetail": {
          "buildingKey": 1,
          "houseNumber": "sample string 2",
          "premiseKey": 3,
          "siteSys": "sample string 4",
          "coPrin": "sample string 5",
          "bundle": "sample string 6",
          "hsD_SRVCABLE_FLG": "sample string 7",
          "viD_SRVCABLE_FLG": "sample string 8",
          "dgtL_PHN_SRVCABLE_FLG": "sample string 9",
          "biServiceability": "sample string 10",
          "siteID": "sample string 11",
          "dbRoot": "sample string 12",
          "latitude": "sample string 13",
          "longitude": "sample string 14",
          "coaxColor": "sample string 15",
          "svcblActvWoutAcctFl": "sample string 16",
          "svcblNonBulkActvWoutInternetFl": "sample string 17",
          "svcblBulkActvWoutInternetFl": "sample string 18",
          "currSpectrumHSDCoaxCustFl": "sample string 19",
          "exstgPdResiInternetSvcFl": "sample string 20",
          "discoInternet30DaysOrLessFl": "sample string 21",
          "neverFl": "sample string 22",
          "dwlTypeCd": "sample string 23",
          "dwlType": "sample string 24",
          "installationType": "sample string 25",
          "fiberNode": "sample string 26",
          "drpHubAreaCd": "sample string 27",
          "headEndDesc": "sample string 28",
          "coaxOrFiber": "sample string 29",
          "customerNumber": "sample string 30",
          "fullName": "sample string 31",
          "accountNumber": "sample string 32",
          "tgtAddrFl": "sample string 33",
          "closestServiceableBuildingRightTriangleDistance": 34,
          "acpTribalInd": "sample string 35",
          "acpPreQlfdHighRiskFl": "sample string 36",
          "acpElgblyInd": "sample string 37",
          "lstInetConnDtSk": "sample string 38",
          "lstInetDiscoDtSk": "sample string 39",
          "acpStartDt": "sample string 40",
          "lstACPEndDt": "sample string 41",
          "ecfStartDt": "sample string 42",
          "lstECFEndDt": "sample string 43",
          "mduBldgInd": "sample string 44",
          "biExclnFl": "sample string 45",
          "comrclPremsSLIDInd": "sample string 46",
          "actvInetAcctCnt": "sample string 47"
        },
        "midasizerStatus": "sample string 6",
        "clientAddressKey": "sample string 7",
        "requestNumber": 8
      },
      {
        "address": "sample string 1",
        "city": "sample string 2",
        "state": "Item",
        "stateSpecified": true,
        "zipCode": "sample string 4",
        "zipPlus4": "sample string 5",
        "deliveryPointValidation": {
          "dpvResultCode": "sample string 1",
          "dpvResultCodeDescription": "sample string 2",
          "dpvResultFootnote": "sample string 3"
        },
        "midasizerPremiseDetail": {
          "buildingKey": 1,
          "houseNumber": "sample string 2",
          "premiseKey": 3,
          "siteSys": "sample string 4",
          "coPrin": "sample string 5",
          "bundle": "sample string 6",
          "hsD_SRVCABLE_FLG": "sample string 7",
          "viD_SRVCABLE_FLG": "sample string 8",
          "dgtL_PHN_SRVCABLE_FLG": "sample string 9",
          "biServiceability": "sample string 10",
          "siteID": "sample string 11",
          "dbRoot": "sample string 12",
          "latitude": "sample string 13",
          "longitude": "sample string 14",
          "coaxColor": "sample string 15",
          "svcblActvWoutAcctFl": "sample string 16",
          "svcblNonBulkActvWoutInternetFl": "sample string 17",
          "svcblBulkActvWoutInternetFl": "sample string 18",
          "currSpectrumHSDCoaxCustFl": "sample string 19",
          "exstgPdResiInternetSvcFl": "sample string 20",
          "discoInternet30DaysOrLessFl": "sample string 21",
          "neverFl": "sample string 22",
          "dwlTypeCd": "sample string 23",
          "dwlType": "sample string 24",
          "installationType": "sample string 25",
          "fiberNode": "sample string 26",
          "drpHubAreaCd": "sample string 27",
          "headEndDesc": "sample string 28",
          "coaxOrFiber": "sample string 29",
          "customerNumber": "sample string 30",
          "fullName": "sample string 31",
          "accountNumber": "sample string 32",
          "tgtAddrFl": "sample string 33",
          "closestServiceableBuildingRightTriangleDistance": 34,
          "acpTribalInd": "sample string 35",
          "acpPreQlfdHighRiskFl": "sample string 36",
          "acpElgblyInd": "sample string 37",
          "lstInetConnDtSk": "sample string 38",
          "lstInetDiscoDtSk": "sample string 39",
          "acpStartDt": "sample string 40",
          "lstACPEndDt": "sample string 41",
          "ecfStartDt": "sample string 42",
          "lstECFEndDt": "sample string 43",
          "mduBldgInd": "sample string 44",
          "biExclnFl": "sample string 45",
          "comrclPremsSLIDInd": "sample string 46",
          "actvInetAcctCnt": "sample string 47"
        },
        "midasizerStatus": "sample string 6",
        "clientAddressKey": "sample string 7",
        "requestNumber": 8
      }
    ],
    "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:

<MidasizerPremiseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twc.MidasWebServices">
  <AddressCandidateListFromGeocoderForMidasizerPremise>
    <addressCandidateField>
      <AddressCandidateListFromGeocoderForMidasizerPremiseAddressCandidate>
        <addressField>sample string 1</addressField>
        <cityField>sample string 2</cityField>
        <clientAddressKeyField>sample string 7</clientAddressKeyField>
        <deliveryPointValidationField>
          <dPVResultCodeDescriptionField>sample string 2</dPVResultCodeDescriptionField>
          <dPVResultCodeField>sample string 1</dPVResultCodeField>
          <dPVResultFootnoteField>sample string 3</dPVResultFootnoteField>
        </deliveryPointValidationField>
        <midasizerPremiseDetailField>
          <DBRootField>sample string 12</DBRootField>
          <DGTL_PHN_SRVCABLE_FLG_Field>sample string 9</DGTL_PHN_SRVCABLE_FLG_Field>
          <HSD_SRVCABLE_FLG_Field>sample string 7</HSD_SRVCABLE_FLG_Field>
          <VID_SRVCABLE_FLG_Field>sample string 8</VID_SRVCABLE_FLG_Field>
          <aCPElgblyInd>sample string 37</aCPElgblyInd>
          <aCPPreQlfdHighRiskFl>sample string 36</aCPPreQlfdHighRiskFl>
          <aCPStartDt>sample string 40</aCPStartDt>
          <aCPTribalInd>sample string 35</aCPTribalInd>
          <accountNumber>sample string 32</accountNumber>
          <actvInetAcctCnt>sample string 47</actvInetAcctCnt>
          <bIExclnFl>sample string 45</bIExclnFl>
          <biServiceability>sample string 10</biServiceability>
          <buildingKeyField>1</buildingKeyField>
          <bundle>sample string 6</bundle>
          <closestServiceableBuildingRightTriangleDistance>34</closestServiceableBuildingRightTriangleDistance>
          <coPrin>sample string 5</coPrin>
          <coaxColor>sample string 15</coaxColor>
          <coaxOrFiber>sample string 29</coaxOrFiber>
          <comrclPremsSLIDInd>sample string 46</comrclPremsSLIDInd>
          <currSpectrumHSDCoaxCustFl>sample string 19</currSpectrumHSDCoaxCustFl>
          <customerNumber>sample string 30</customerNumber>
          <discoInternet30DaysOrLessFl>sample string 21</discoInternet30DaysOrLessFl>
          <drpHubAreaCd>sample string 27</drpHubAreaCd>
          <dwlType>sample string 24</dwlType>
          <dwlTypeCd>sample string 23</dwlTypeCd>
          <eCFStartDt>sample string 42</eCFStartDt>
          <exstgPdResiInternetSvcFl>sample string 20</exstgPdResiInternetSvcFl>
          <fiberNode>sample string 26</fiberNode>
          <fullName>sample string 31</fullName>
          <headEndDesc>sample string 28</headEndDesc>
          <houseNumber>sample string 2</houseNumber>
          <installationType>sample string 25</installationType>
          <latitudeField>sample string 13</latitudeField>
          <longitudeField>sample string 14</longitudeField>
          <lstACPEndDt>sample string 41</lstACPEndDt>
          <lstECFEndDt>sample string 43</lstECFEndDt>
          <lstInetConnDtSk>sample string 38</lstInetConnDtSk>
          <lstInetDiscoDtSk>sample string 39</lstInetDiscoDtSk>
          <mDUBldgInd>sample string 44</mDUBldgInd>
          <neverFl>sample string 22</neverFl>
          <premiseKeyField>3</premiseKeyField>
          <siteIDField>sample string 11</siteIDField>
          <siteSys>sample string 4</siteSys>
          <svcblActvWoutAcctFl>sample string 16</svcblActvWoutAcctFl>
          <svcblBulkActvWoutInternetFl>sample string 18</svcblBulkActvWoutInternetFl>
          <svcblNonBulkActvWoutInternetFl>sample string 17</svcblNonBulkActvWoutInternetFl>
          <tgtAddrFl>sample string 33</tgtAddrFl>
        </midasizerPremiseDetailField>
        <midasizerStatusField>sample string 6</midasizerStatusField>
        <requestNumberField>8</requestNumberField>
        <stateField>Item</stateField>
        <stateFieldSpecified>true</stateFieldSpecified>
        <zIPCodeField>sample string 4</zIPCodeField>
        <zIPPlus4Field>sample string 5</zIPPlus4Field>
      </AddressCandidateListFromGeocoderForMidasizerPremiseAddressCandidate>
      <AddressCandidateListFromGeocoderForMidasizerPremiseAddressCandidate>
        <addressField>sample string 1</addressField>
        <cityField>sample string 2</cityField>
        <clientAddressKeyField>sample string 7</clientAddressKeyField>
        <deliveryPointValidationField>
          <dPVResultCodeDescriptionField>sample string 2</dPVResultCodeDescriptionField>
          <dPVResultCodeField>sample string 1</dPVResultCodeField>
          <dPVResultFootnoteField>sample string 3</dPVResultFootnoteField>
        </deliveryPointValidationField>
        <midasizerPremiseDetailField>
          <DBRootField>sample string 12</DBRootField>
          <DGTL_PHN_SRVCABLE_FLG_Field>sample string 9</DGTL_PHN_SRVCABLE_FLG_Field>
          <HSD_SRVCABLE_FLG_Field>sample string 7</HSD_SRVCABLE_FLG_Field>
          <VID_SRVCABLE_FLG_Field>sample string 8</VID_SRVCABLE_FLG_Field>
          <aCPElgblyInd>sample string 37</aCPElgblyInd>
          <aCPPreQlfdHighRiskFl>sample string 36</aCPPreQlfdHighRiskFl>
          <aCPStartDt>sample string 40</aCPStartDt>
          <aCPTribalInd>sample string 35</aCPTribalInd>
          <accountNumber>sample string 32</accountNumber>
          <actvInetAcctCnt>sample string 47</actvInetAcctCnt>
          <bIExclnFl>sample string 45</bIExclnFl>
          <biServiceability>sample string 10</biServiceability>
          <buildingKeyField>1</buildingKeyField>
          <bundle>sample string 6</bundle>
          <closestServiceableBuildingRightTriangleDistance>34</closestServiceableBuildingRightTriangleDistance>
          <coPrin>sample string 5</coPrin>
          <coaxColor>sample string 15</coaxColor>
          <coaxOrFiber>sample string 29</coaxOrFiber>
          <comrclPremsSLIDInd>sample string 46</comrclPremsSLIDInd>
          <currSpectrumHSDCoaxCustFl>sample string 19</currSpectrumHSDCoaxCustFl>
          <customerNumber>sample string 30</customerNumber>
          <discoInternet30DaysOrLessFl>sample string 21</discoInternet30DaysOrLessFl>
          <drpHubAreaCd>sample string 27</drpHubAreaCd>
          <dwlType>sample string 24</dwlType>
          <dwlTypeCd>sample string 23</dwlTypeCd>
          <eCFStartDt>sample string 42</eCFStartDt>
          <exstgPdResiInternetSvcFl>sample string 20</exstgPdResiInternetSvcFl>
          <fiberNode>sample string 26</fiberNode>
          <fullName>sample string 31</fullName>
          <headEndDesc>sample string 28</headEndDesc>
          <houseNumber>sample string 2</houseNumber>
          <installationType>sample string 25</installationType>
          <latitudeField>sample string 13</latitudeField>
          <longitudeField>sample string 14</longitudeField>
          <lstACPEndDt>sample string 41</lstACPEndDt>
          <lstECFEndDt>sample string 43</lstECFEndDt>
          <lstInetConnDtSk>sample string 38</lstInetConnDtSk>
          <lstInetDiscoDtSk>sample string 39</lstInetDiscoDtSk>
          <mDUBldgInd>sample string 44</mDUBldgInd>
          <neverFl>sample string 22</neverFl>
          <premiseKeyField>3</premiseKeyField>
          <siteIDField>sample string 11</siteIDField>
          <siteSys>sample string 4</siteSys>
          <svcblActvWoutAcctFl>sample string 16</svcblActvWoutAcctFl>
          <svcblBulkActvWoutInternetFl>sample string 18</svcblBulkActvWoutInternetFl>
          <svcblNonBulkActvWoutInternetFl>sample string 17</svcblNonBulkActvWoutInternetFl>
          <tgtAddrFl>sample string 33</tgtAddrFl>
        </midasizerPremiseDetailField>
        <midasizerStatusField>sample string 6</midasizerStatusField>
        <requestNumberField>8</requestNumberField>
        <stateField>Item</stateField>
        <stateFieldSpecified>true</stateFieldSpecified>
        <zIPCodeField>sample string 4</zIPCodeField>
        <zIPPlus4Field>sample string 5</zIPPlus4Field>
      </AddressCandidateListFromGeocoderForMidasizerPremiseAddressCandidate>
    </addressCandidateField>
    <countField>sample string 1</countField>
  </AddressCandidateListFromGeocoderForMidasizerPremise>
  <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>
</MidasizerPremiseResponse>