GET_USERS_INFO

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.

A valid REGISTERED_NAME, REGISTERED_PASSWORD tag pair is required to execute this function.

Type

Max Size

Multiple Allowed

Function

N/A

No

Example:

function GetAllUsersInfo()
{
var Tl, Count = 0;
var Users = "";

Tl = CAS.New();
CAS.AddTag(Tl,"GET_USERS_INFO","");
CAS.AddTag(Tl,"REGISTERED_NAME",REGISTERED_NAME.value);
CAS.AddTag(Tl,"REGISTERED_PASSWORD",REGISTERED_PASSWORD.value);

Sl = CAS.CreateSection(Tl,"RESPONSE_INCLUDE_ONLY","");
   CAS.AddTag(Sl,"USER_FULLNAME",0);
   CAS.AddTag(Sl,"USER_DESCRIPTION","");
   CAS.AddTag(Sl,"USER_EMAIL_ADDRESS","");
CAS.CloseSection(Sl);

    // Get users on this already open session
Tl = CAS.Send(Instance,Tl);

if ( CAS.GetTag(Tl,"STATUS_NUM",0) == 0 )
    {
      // The number of users is in the root of the reply taglist
    Count = parseInt(CAS.GetTag(Tl,"NUMBER_OF_USERS",0));

      // Each user is in their own section
    for ( Index=0; Index<Count; Index++)
      {
      Sl = CAS.OpenSection(Tl,"USER_NAME["+Index+"]");
        Users += CAS.GetTag(Sl,"USER_NAME",0) + ",";
        Users += CAS.GetTag(Sl,"USER_FULLNAME",0) + ",";
        Users += CAS.GetTag(Sl,"USER_DESCRIPTION",0) + ",";
        Users += CAS.GetTag(Sl,"USER_EMAIL_ADDRESS",0) + "\r\n";
      CAS.CloseSection(Sl);
      }
    }
else
    {
      // Return the status
    Users = CAS.GetTag(Tl,"STATUS",0);
    }

return(Users);
}

See Also:

Get Users Info, USER_NAME, USER_DESCRIPTION, USER_FULLNAME, REGISTERED_NAME, REGISTERED_PASSWORD