IM Relationship Resolution Information Center, Version 4.2

getAddressTypes() SOAP API method

Requests and obtains the details of all configured name types. The UMF API equivalent of the getNameTypes method are the SOA_ADDRESS_TYPES_REQUEST input document and the SOA_ADDRESS_TYPES_RESPONSE output document.

Syntax

getAddressTypes
(
 additionalinfo
 
);

Description

Parameters
additionalinfo
Type: CustomInformation
Nullable: Yes
This parameter is reserved for field customizations to the WSDL and XSLT transforms without changing the signature of the method.
Example Request
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <soapenv:Body>
  <getAddressTypes xmlns="http://services/">
   <additionalInfo xsi:nil="true" xmlns=""/>
  </getAddressTypes>
 </soapenv:Body>
</soapenv:Envelope>

Description

Returns
getAddressTypesResponse
maxOccurs="unbounded"
minOccurs="0"
Value:
addressTypes
Type: xsd_4:AddressTypeDetail
Value:
AddressTypeDetail
Value:
typeCode
Type: xsd:string
description
Type: xsd:string
status
minOccurs="0"
Type: xsd:xsd_3:Status
Value:
Status
Type: xsd:string
Values: ACTIVE, INACTIVE, OTHER
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 <soapenv:Body>
  <getAddressTypesResponse xmlns="http://services/">
   <addressTypes xmlns="">
    <typeCode>B</typeCode>
    <description>Business</description>
    <status>ACTIVE</status>
   </addressTypes>
   <addressTypes xmlns="">
    <typeCode>H</typeCode>
    <description>Home</description>
    <status>ACTIVE</status>
   </addressTypes>
   <addressTypes xmlns="">
    <typeCode>O</typeCode>
    <description>Other</description>
    <status>ACTIVE</status>
   </addressTypes>
  </getAddressTypesResponse>
 </soapenv:Body>
</soapenv:Envelope>



Feedback

Last updated: 2009