IM Relationship Resolution Information Center, Version 4.2

SOA_NUMBER_TYPES_REQUEST input document

The SOA_NUMBER_TYPES_REQUEST input document contains the request and search criteria to obtain details of all configured number types. The results of this Web services input document are returned to the calling application in a SOA_NUMBER_TYPES_RESPONSE output document.

These UMF tags comprise the ROOT segment for the SOA_NUMBER_TYPES_REQUEST input document:
N/A
There are no required UMF tags other than the self-closing SOA_NUMBER_TYPES_REQUEST tag.

The SOAP-RPC equivalent of the SOA_NUMBER_TYPES_REQUEST input document and the SOA_NUMBER_TYPES_RESPONSE output document is the getNumberTypes method.

Example SOA_NUMBER_TYPES_REQUEST input document

This example SOA_NUMBER_TYPES_REQUEST input document requests the details of all configured number types.
Note: This example is formatted for readability and does not follow the required one line per UMF record format.
<SOA_NUMBER_TYPES_REQUEST />

Example SOA_NUMBER_TYPES_RESPONSE output document

This example SOA_NUMBER_TYPES_RESPONSE output document returns details of all configured number types.
Note: This example is formatted for readability and does not follow the required one line per UMF record format.
<SOA_NUMBER_TYPES_RESPONSE>
   <NUMBER_TYPE>
      <NUM_TYPE_ID>2</NUM_TYPE_ID>
      <NUM_TYPE>SSN</NUM_TYPE>
      <NUM_DESC>Social Security Number</NUM_DESC>
      <NUM_CLASS>PID</NUM_CLASS>
      <MIN_LENGTH>1</MIN_LENGTH>
      <MAX_LENGTH>9</MAX_LENGTH>
      <UNIQUE_FLAG>Y</UNIQUE_FLAG>
      <VALID_MASK>999-99-9999</VALID_MASK>
      <VALID_MASK_FILL>L</VALID_MASK_FILL>
      <FILL_CHAR> </FILL_CHAR>
      <KEEP_HIST>Y</KEEP_HIST>
      <REC_STAT>A</REC_STAT>
   </NUMBER_TYPE>
   <NUMBER_TYPE>
      <NUM_TYPE_ID>3</ROLE_ID>
      <NUM_TYPE>PP</ROLE_CODE>
      <NUM_DESC>Passport</ROLE_DESC>
      <NUM_CLASS>PID</NUM_CLASS>
      <MIN_LENGTH>1</MIN_LENGTH>
      <MAX_LENGTH>25</MAX_LENGTH>
      <UNIQUE_FLAG>N</UNIQUE_FLAG>
      <KEEP_HIST>Y</KEEP_HIST>
      <REC_STAT>A</REC_STAT>
   </NUMBER_TYPE>
   <SYS_CREATE_DT>2008-06-26 05:18:55</SYS_CREATE_DT>
</SOA_NUMBER_TYPES_RESPONSE>


Feedback

Last updated: 2009