Managed by the FaxBack Support Team

GET_USER_ALIASES_INFO

NET SatisFAXtion CAS XML API Function


The GET_USER_ALIASES_INFO function retrieves user aliases for one or more NET SatisFAXtion users. In the reply taglist from the server, each alias is placed in a section that starts with the UG_UNIQUE_ID tag. Information about a specific user can be retrieved by providing the user's name with the USER_NAME tag. If this tag is not supplied, the fax server returns information for all users.

Request Parameters

REGISTERED_NAME (Required)
REGISTERED_PASSWORD (Required)
GET_USER_ALIASES_INFO (Required)

Response Parameters

USER_ALIASES_INFO
UG_UNIQUE_ID
USER_ALIAS_NAME
STATUS
STATUS_NUM

Examples

Get alias information for all users,.
<!-- Request -->
<?xml version="1.0" encoding="UTF-8"?>
<CAS>
  <DOMAIN_NAME>\\NETSATISFAXTION\MYFAXSERVER</DOMAIN_NAME>>
  <REMOTE_LOGON_NAME>MYFAXSERVER</REMOTE_LOGON_NAME>
  <PROTOCOL>2</PROTOCOL>
  <TAGLIST>
    <GET_USER_ALIASES_INFO/>
    <REGISTERED_NAME>Supervisor</REGISTERED_NAME>
    <REGISTERED_PASSWORD></REGISTERED_PASSWORD>
  </TAGLIST>
</CAS>
 
<!-- Response -->
<?xml version="1.0" encoding="UTF-8"?>
<CAS>
    <TAGLIST>
        <USER_ALIASES_INFO/>
        <STATUS_NUM>0</STATUS_NUM>
        <STATUS>No Errors</STATUS>
        <NO_ACKNOWLEDGMENT>1</NO_ACKNOWLEDGMENT>
        <UG_UNIQUE_ID>
            6
            <USER_ALIAS_NAME>Supervisor</USER_ALIAS_NAME>
        </UG_UNIQUE_ID>
        <UG_UNIQUE_ID>
            7
            <USER_ALIAS_NAME>ClarityNS</USER_ALIAS_NAME>
        </UG_UNIQUE_ID>
        <UG_UNIQUE_ID>
            8
            <USER_ALIAS_NAME>Postmaster</USER_ALIAS_NAME>
        </UG_UNIQUE_ID>
        <UG_UNIQUE_ID>
            9
            <USER_ALIAS_NAME>Export</USER_ALIAS_NAME>
        </UG_UNIQUE_ID>
        <UG_UNIQUE_ID>
            10
            <USER_ALIAS_NAME>Autoprint</USER_ALIAS_NAME>
        </UG_UNIQUE_ID>
        <UG_UNIQUE_ID>
            12
            <USER_ALIAS_NAME>SMTPPost</USER_ALIAS_NAME>
        </UG_UNIQUE_ID>
        <UG_UNIQUE_ID>
            13
            <USER_ALIAS_NAME>Jroos</USER_ALIAS_NAME>
            <UG_UNIQUE_ID>13</UG_UNIQUE_ID>
            <USER_ALIAS_NAME>SMTPPost!dev.local!jroos</USER_ALIAS_NAME>
        </UG_UNIQUE_ID>
        <UG_UNIQUE_ID>
            14
            <USER_ALIAS_NAME>AKawasaki</USER_ALIAS_NAME>
        </UG_UNIQUE_ID>
        <UG_UNIQUE_ID>
            15
            <USER_ALIAS_NAME>AArmstrong</USER_ALIAS_NAME>
        </UG_UNIQUE_ID>
        <UG_UNIQUE_ID>
            16
            <USER_ALIAS_NAME>NSmith</USER_ALIAS_NAME>
        </UG_UNIQUE_ID>
        <UG_UNIQUE_ID>
            17
            <USER_ALIAS_NAME>TNielson</USER_ALIAS_NAME>
        </UG_UNIQUE_ID>
    </TAGLIST>
    <STATUS_NUM>0</STATUS_NUM>
    <STATUS_EXTENDED_NUM>0</STATUS_EXTENDED_NUM>
    <STATUS/>
</CAS>

Get aliases for a specific user.
<!-- Request -->
<?xml version="1.0" encoding="UTF-8"?>
  <CAS>
    <DOMAIN_NAME>\\NETSATISFAXTION\MYFAXSERVER</DOMAIN_NAME>>
    <REMOTE_LOGON_NAME>MYFAXSERVER</REMOTE_LOGON_NAME>
    <PROTOCOL>2</PROTOCOL>
    <TAGLIST>
      <GET_USER_ALIASES_INFO/>
      <USER_NAME>JRoos</USER_NAME>
      <REGISTERED_NAME>Supervisor</REGISTERED_NAME>
      <REGISTERED_PASSWORD></REGISTERED_PASSWORD>
    </TAGLIST>
  </CAS>
 
<!-- Response -->
<?xml version="1.0" encoding="UTF-8"?>
  <?xml version="1.0" encoding="UTF-8"?>
  <CAS>
    <TAGLIST>
      <USER_ALIASES_INFO/>
      <STATUS_NUM>0</STATUS_NUM>
      <STATUS>No Errors</STATUS>
      <NO_ACKNOWLEDGMENT>1</NO_ACKNOWLEDGMENT>
      <UG_UNIQUE_ID>
        13
        <USER_ALIAS_NAME>Jroos</USER_ALIAS_NAME>
        <USER_ALIAS_NAME>SMTPPost!dev.local!jroos</USER_ALIAS_NAME>
      </UG_UNIQUE_ID>
    </TAGLIST>
    <STATUS_NUM>0</STATUS_NUM>
    <STATUS_EXTENDED_NUM>0</STATUS_EXTENDED_NUM>
    <STATUS/>
  </CAS>
 

Copyright © FaxBack, Inc.