Difference between revisions of "API/Services/GetPortAvailabilityForAddress"

From Emersion
Jump to: navigation, search
(Created page with " '''Purpose ''' Determine if there are ports available at a given address '''Inputs''' <soapenv:Header/> <soapenv:Body> <ser:getPortAvailabilityRequest> ...")
 
 
Line 15: Line 15:
  
 
'''Output'''
 
'''Output'''
<SOAP-ENV:Body>
+
  <SOAP-ENV:Body>
 
       <ns1:getPortAvailabilityForAddressResponse>
 
       <ns1:getPortAvailabilityForAddressResponse>
 
         <ns1:gnaf_pid>false</ns1:gnaf_pid>
 
         <ns1:gnaf_pid>false</ns1:gnaf_pid>

Latest revision as of 17:19, 10 September 2014

Purpose

Determine if there are ports available at a given address

Inputs

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

Output

 <SOAP-ENV:Body>
     <ns1:getPortAvailabilityForAddressResponse>
        <ns1:gnaf_pid>false</ns1:gnaf_pid>
     </ns1:getPortAvailabilityForAddressResponse>
  </SOAP-ENV:Body>

Error String

Invalid or missing address_id

Invalid or missing carrier_id

Invalid or missing minimum_class_number