Requests and obtains the details of all configured number types. Client applications will generally call this service and cache the result for later use in order to lookup number type details by their "internal ID". If a number 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 getNumberTypes method are the SOA_NUMBER_TYPES_REQUEST input document and the SOA_NUMBER_TYPES_RESPONSE output document.
getNumberTypes ( additionalinfo );
<?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> <getNumberTypes xmlns="http://services/"> <additionalInfo xsi:nil="true" xmlns=""/> </getNumberTypes> </soapenv:Body> </soapenv:Envelope>
<?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> <getNumberTypesResponse xmlns="http://services/"> <numberTypes xmlns=""> <internalID>2</internalID> <typeCode>SSN</typeCode> <description>Social Security Number</description> <unique>TRUE</unique> <numberClass>PERSONAL_ID</numberClass> <minimumLength>1</minimumLength> <maximumLength>9</maximumLength> <validationMask>999-99-9999</validationMask> <fillDirection>FROM_LEFT</fillDirection> <fillCharacter> </fillCharacter> <maintainMultipleValues>TRUE</maintainMultipleValues> <status>ACTIVE</status> </numberTypes> <numberTypes xmlns=""> <internalID>3</internalID> <typeCode>PP</typeCode> <description>Passport</description> <unique>FALSE</unique> <numberClass>PERSONAL_ID</numberClass> <minimumLength>1</minimumLength> <maximumLength>25</maximumLength> <fillCharacter> </fillCharacter> <maintainMultipleValues>TRUE</maintainMultipleValues> <status>ACTIVE</status> </numberTypes> <numberTypes xmlns=""> <internalID>4</internalID> <typeCode>CC</typeCode> <description>Credit Card</description> <unique>FALSE</unique> <numberClass>CREDIT_CARD</numberClass> <minimumLength>1</minimumLength> <maximumLength>25</maximumLength> <fillCharacter> </fillCharacter> <maintainMultipleValues>TRUE</maintainMultipleValues> <status>ACTIVE</status> </numberTypes> <numberTypes xmlns=""> <internalID>5</internalID> <typeCode>FF</typeCode> <description>Frequent Flier</description> <unique>FALSE</unique> <numberClass>MISCELLANEOUS</numberClass> <minimumLength>1</minimumLength> <maximumLength>25</maximumLength> <fillCharacter> </fillCharacter> <maintainMultipleValues>TRUE</maintainMultipleValues> <status>ACTIVE</status> </numberTypes> <numberTypes xmlns=""> <internalID>6</internalID> <typeCode>PH</typeCode> <description>Phone</description> <unique>FALSE</unique> <numberClass>PHONE</numberClass> <minimumLength>1</minimumLength> <maximumLength>25</maximumLength> <validationMask>999-999-9999</validationMask> <fillDirection>FROM_RIGHT</fillDirection> <fillCharacter> </fillCharacter> <maintainMultipleValues>TRUE</maintainMultipleValues> <status>ACTIVE</status> </numberTypes> <numberTypes xmlns=""> <internalID>7</internalID> <typeCode>DL</typeCode> <description>Drivers License</description> <unique>FALSE</unique> <numberClass>PERSONAL_ID</numberClass> <minimumLength>1</minimumLength> <maximumLength>25</maximumLength> <fillCharacter> </fillCharacter> <maintainMultipleValues>TRUE</maintainMultipleValues> <status>ACTIVE</status> </numberTypes> </getNumberTypesResponse> </soapenv:Body> </soapenv:Envelope>