|
|
|||||
| The RESPONSE_INCLUDE_ONLY integer tag is used in
certain function taglists, as the first tag in a section filled with tags
that represent the only information that should be included in the
response from the function. The response taglist will include the
specified tags only if they would have otherwise been returned in a full
response. The response taglist may also include tags that cannot be
excluded from a response, for example, the MESSAGE_HANDLE
tag cannot be excluded from the response taglist when calling GET_Q_ENTRIES_INFO.
Although this tag is optional, you are encouraged to include a RESPONSE_INCLUDE_ONLY section filled with tags that you truly need, particularly with the GET_Q_ENTRIES_INFO function, to limit the amount of data returned from the server. |
|||||
| Type | Max Size | Multiple Allowed | |||
| Integer | 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 = CAS.GetTag(Tl,"NUMBER_OF_USERS",0); // Each user is in their own sub-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_Q_ENTRIES_INFO, GET_USERS_INFO | |||||
|
|