Difference between revisions of "API/Services/GetServiceTypesForAddress"

Revision as of 13:20, 9 May 2018

Purpose

Get a list of service types available at a given address

NOTE This API call currently references a deprecated table and should be considered currently not operable.

Inputs

 <soapenv:Header/>
  <soapenv:Body>
     <ser:getServiceTypesForAddress>
        <ser:address_id>1</ser:address_id>
        <ser:carrier_id>1</ser:carrier_id>
        <ser:minimum_class_number>1</ser:minimum_class_number>
     </ser:getServiceTypesForAddress>
  </soapenv:Body>

Output

  <SOAP-ENV:Body>
     <ns1:getServiceTypesForAddressResponse>
        <ns1:ServiceTypeItem>
                 <ns1:service_id>1</ns1:service_id>
                 <ns1:type_name></ns1:type_name>
                 <ns1:port_available>false</ns1:port_available>
        </ns1:ServiceTypeItem>
     </ns1:getServiceTypesForAddressResponse>
  </SOAP-ENV:Body>

Error String

Invalid or missing address_id

Invalid or missing carrier_id

Invalid or missing minimum_class_number