Managed by the FaxBack Support Team

GET_USERS_INFO

NET SatisFAXtion CAS XML API Function

The GET_USERS_INFO function retrieves user information for one or more NET SatisFAXtion users. In the reply taglist from the server, each user is placed in a section that starts with the USER_NAME 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.
You are encouraged to include a section filled with tags that you truly need, beginning with the RESPONSE_INCLUDE_ONLY tag, to limit the amount of data returned from the server.

Request Parameters

REGISTERED_NAME (Required)
REGISTERED_PASSWORD (Required)
USER_NAME
UG_UNIQUE_ID
RESPONSE_INCLUDE_ONLY
VERIFY_MEMBER_OF

Response Parameters

USER_EMAIL_ADDRESS
USER_FULLNAME
USER_DESCRIPTION
USER_NAME
PB_FIRST_NAME
PB_MIDDLE_NAME
PB_LAST_NAME
USER_CSID_ROUTING
USER_DTMF_ROUTING
USER_T30_ROUTING
USER_LINE_ROUTING
UG_USER_AUTOFORWARD
USER_BILLING_CODE
USER_MESSAGE_PREVIEW
UG_USER_AUTOFORWARD_ON
USER_SHORT_NAME
USER_PASSWORD
STATUS
STATUS_NUM

Examples

Get information for one specific user.
<!-- Request -->
<?xml version="1.0" encoding="UTF-8"?>
<CAS>
    <DOMAIN_NAME>\\NETSATISFAXTION\NSTESTER</DOMAIN_NAME>
    <REMOTE_LOGON_NAME>NSTESTER</REMOTE_LOGON_NAME>
    <PROTOCOL>2</PROTOCOL>
    <TAGLIST>
        <GET_USERS_INFO/>
        <USER_NAME>Supervisor</USER_NAME>
        <REGISTERED_NAME>Supervisor</REGISTERED_NAME>
        <REGISTERED_PASSWORD></REGISTERED_PASSWORD>
    </TAGLIST>
</CAS>
 
<!-- Response -->
<?xml version="1.0" encoding="UTF-8"?>
<CAS>
    <TAGLIST>
        <USERS_INFO/>
        <STATUS_NUM>0</STATUS_NUM>
        <STATUS>No Errors</STATUS>
        <USERS_CHANGE_COUNT>38</USERS_CHANGE_COUNT>
        <UL_SYNCH_MODE>0</UL_SYNCH_MODE>
        <NUMBER_OF_USERS>1</NUMBER_OF_USERS>
        <NO_ACKNOWLEDGMENT>1</NO_ACKNOWLEDGMENT>
        <USER_NAME>
            Supervisor
            <UG_UNIQUE_ID>6</UG_UNIQUE_ID>
            <USER_DESCRIPTION>Default Supervisor</USER_DESCRIPTION>
            <USER_PRIVILEGES>4294967295</USER_PRIVILEGES>
            <USER_TYPE>131075</USER_TYPE>
            <UG_AUTOFORWARD/>
        </USER_NAME>
    </TAGLIST>
    <STATUS_NUM>0</STATUS_NUM>
    <STATUS_EXTENDED_NUM>0</STATUS_EXTENDED_NUM>
    <STATUS/>
</CAS>

Verify that the Supervisor user is a member of both the Supervisors and the All Users groups.
<!-- Request -->
<?xml version="1.0" encoding="UTF-8"?>
<CAS>
    <DOMAIN_NAME>\\NETSATISFAXTION\JIMDUO</DOMAIN_NAME>
    <REMOTE_LOGON_NAME>JIMDUO</REMOTE_LOGON_NAME>
    <PROTOCOL>2</PROTOCOL>
    <TAGLIST>
        <GET_USERS_INFO/>
        <USER_NAME>Supervisor</USER_NAME>
        <RESPONSE_INCLUDE_ONLY>
            <VERIFY_MEMBER_OF>All Users</VERIFY_MEMBER_OF>
            <VERIFY_MEMBER_OF>Supervisors</VERIFY_MEMBER_OF>
        </RESPONSE_INCLUDE_ONLY>
        <REGISTERED_NAME>Supervisor</REGISTERED_NAME>
        <REGISTERED_PASSWORD></REGISTERED_PASSWORD>
    </TAGLIST>
</CAS>
 
<!-- Response -->
<?xml version="1.0" encoding="UTF-8"?>
<CAS>
    <TAGLIST>
        <USERS_INFO/>
        <STATUS_NUM>0</STATUS_NUM>
        <STATUS>No Errors</STATUS>
        <USERS_CHANGE_COUNT>263</USERS_CHANGE_COUNT>
        <UL_SYNCH_MODE>0</UL_SYNCH_MODE>
        <NUMBER_OF_USERS>1</NUMBER_OF_USERS>
        <NO_ACKNOWLEDGMENT>1</NO_ACKNOWLEDGMENT>
        <USER_NAME>
            Supervisor
            <UG_UNIQUE_ID>6</UG_UNIQUE_ID>
            <MEMBER_OF>All Users</MEMBER_OF>
            <MEMBER_OF>Supervisors</MEMBER_OF>
        </USER_NAME>
    </TAGLIST>
    <STATUS_NUM>0</STATUS_NUM>
    <STATUS_EXTENDED_NUM>0</STATUS_EXTENDED_NUM>
    <STATUS/>
</CAS>
 

Copyright © FaxBack, Inc.