IM Relationship Resolution Information Center, Version 4.2

getCharacteristicTypes() SOAP API method

Requests and obtains the details of all configured characteristic types. Client applications will generally call this service and cache the result for later use in order to lookup characteristic type details by their "internal ID". If a characteristic type ID 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 getCharacteristicTypes method are the SOA_CHARACTERISTIC_TYPES_REQUEST input document and the SOA_CHARACTERISTIC_TYPES_RESPONSE output document.

Syntax

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

Description

Returns
getCharacteristicTypesResponse
maxOccurs="unbounded"
minOccurs="0"
Value:
characteristicTypes
Type xsd_4:CharacteristicTypeDetail
Value:
CharacteristicTypeDetail
Value:
internalID
Type: xsd:long
typeCode
Type: xsd:string
description
Type: xsd:string
characteristicClass
Type: xsd_1:CharacteristicClass
Values: LIFE, SYSTEM, LINK, CUSTOM
characteristicDataType
Type: xsd_1:CharacteristicDataType
Values: TEXT, DATE, CUSTOM
maintainMultipleValues
Type: xsd:boolean
status
minOccurs="0"
Type: xsd:xsd_3:Status
Value:
Status
Type: xsd:string
Values: ACTIVE, INACTIVE, OTHER
graphDisplayLevel
Type: xsd:int
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>
  <getCharacteristicTypesResponse xmlns="http://services/">
   <characteristicTypes xmlns="">
    <internalID>1</internalID>
    <typeCode>DOB</typeCode>
    <description>Date Of Birth</description>
    <characteristicClass>LIFE</characteristicClass>
    <dataType>DATE</dataType>
    <maintainMultipleValues>TRUE</maintainMultipleValues>
    <status>ACTIVE</status>
    <graphDisplayLevel>999</graphDisplayLevel>
   </characteristicTypes>
   <characteristicTypes xmlns="">
    <internalID>2</internalID>
    <typeCode>GENDER</typeCode>
    <description>Gender</description>
    <characteristicClass>LIFE</characteristicClass>
    <dataType>TEXT</dataType>
    <maintainMultipleValues>TRUE</maintainMultipleValues>
    <status>ACTIVE</status>
    <graphDisplayLevel>999</graphDisplayLevel>
   </characteristicTypes>
   <characteristicTypes xmlns="">
    <internalID>4</internalID>
    <typeCode>DIED</typeCode>
    <description>Deceased</description>
    <characteristicClass>LIFE</characteristicClass>
    <dataType>TEXT</dataType>
    <maintainMultipleValues>TRUE</maintainMultipleValues>
    <status>ACTIVE</status>
    <graphDisplayLevel>999</graphDisplayLevel>
   </characteristicTypes>
   <characteristicTypes xmlns="">
    <internalID>5</internalID>
    <typeCode>MARITAL</typeCode>
    <description>Marital Status</description>
    <characteristicClass>LIFE</characteristicClass>
    <dataType>TEXT</dataType>
    <maintainMultipleValues>TRUE</maintainMultipleValues>
    <status>ACTIVE</status>
    <graphDisplayLevel>999</graphDisplayLevel>
   </characteristicTypes>
   <characteristicTypes xmlns="">
    <internalID>6</internalID>
    <typeCode>CIRCA_DOB</typeCode>
    <description>Approximate DOB</description>
    <characteristicClass>LIFE</characteristicClass>
    <dataType>TEXT</dataType>
    <maintainMultipleValues>TRUE</maintainMultipleValues>
    <status>ACTIVE</status>
    <graphDisplayLevel>999</graphDisplayLevel>
   </characteristicTypes>
   <characteristicTypes xmlns="">
    <internalID>7</internalID>
    <typeCode>POB</typeCode>
    <description>Place of Birth</description>
    <characteristicClass>LIFE</characteristicClass>
    <dataType>TEXT</dataType>
    <maintainMultipleValues>TRUE</maintainMultipleValues>
    <status>ACTIVE</status>
    <graphDisplayLevel>999</graphDisplayLevel>
   </characteristicTypes>
   <characteristicTypes xmlns="">
    <internalID>8</internalID>
    <typeCode>NAT</typeCode>
    <description>Nationality</description>
    <characteristicClass>LIFE</characteristicClass>
    <dataType>TEXT</dataType>
    <maintainMultipleValues>TRUE</maintainMultipleValues>
    <status>ACTIVE</status>
    <graphDisplayLevel>999</graphDisplayLevel>
   </characteristicTypes>
   <characteristicTypes xmlns="">
    <internalID>9</internalID>
    <typeCode>CIT</typeCode>
    <description>Citizenship</description>
    <characteristicClass>LIFE</characteristicClass>
    <dataType>TEXT</dataType>
    <maintainMultipleValues>TRUE</maintainMultipleValues>
    <status>ACTIVE</status>
    <graphDisplayLevel>999</graphDisplayLevel>
   </characteristicTypes>
   <characteristicTypes xmlns="">
    <internalID>16</internalID>
    <typeCode>GNR_HASH_COMPOSITE</typeCode>
    <description>A composite attribute</description>
    <characteristicClass>LIFE</characteristicClass>
    <dataType>TEXT</dataType>
    <maintainMultipleValues>TRUE</maintainMultipleValues>
    <status>ACTIVE</status>
    <graphDisplayLevel>0</graphDisplayLevel>
   </characteristicTypes>
  </getCharacteristicTypesResponse>
 </soapenv:Body>
</soapenv:Envelope>



Feedback

Last updated: 2009