IM InfoSphere Identity Insight, Version 8.0


getNameTypes() SOAP API method

Requests and obtains the details of all configured name types. Client applications will generally call this service and cache the result for later use in order to lookup address type details by their code. If a address type code is ever encountered that is not recognized in the client cache, then this service can be called again in order to update the lookup table within the client application. The UMF API equivalent of the getNameTypes method are the SOA_NAME_TYPES_REQUEST input document and the SOA_NAME_TYPES_RESPONSE output document.

Syntax

getNameTypes
(
 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>
  <getNameTypes xmlns="http://services/">
   <additionalInfo xsi:nil="true" xmlns=""/>
  </getNameTypes>
 </soapenv:Body>
</soapenv:Envelope>

Description

Returns
getNameTypesResponse
maxOccurs="unbounded"
minOccurs="0"
nameTypes
type="xsd_4:NameTypeDetail"
NameTypeDetail
typeCode
type="xsd:string"
description
type="xsd:string"
status
minOccurs="0"
type="xsd_3:Status
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>
        <getNameTypesResponse xmlns="http://services/">
            <nameTypes xmlns="">
                <typeCode>A</typeCode>
                <description>AKA</description>
                <status>ACTIVE</status>
            </nameTypes>
            <nameTypes xmlns="">
                <typeCode>M</typeCode>
                <description>Main</description>
                <status>ACTIVE</status>
            </nameTypes>
        </getNameTypesResponse>
    </soapenv:Body>
</soapenv:Envelope>




Feedback



Last updated: 2011