Administrator Guide
210 | Using the W-ClearPass Configuration API Dell Networking W-ClearPass Deployment Guide
<TipsApiRequest xmlns="http://www.avendasys.com/tipsapiDefs/1.0">
<TipsHeader version="3.0" source="Guest"/>
<Filter entity="GuestUser"/>
</TipsApiRequest>
Retrieving a Local User Value
For other entity types, you do not need to include the source attribute.
If the Guest description is present in the XML request, the GuestUserDetails element is displayed in the Guest
details.
Post the XML request to the following URL:
https://<server>/tipsapi/config/read/LocalUser
Fetching All Local Users
The following is an example of an XML request used to fetch all local users:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TipsApiRequest xmlns="http://www.avendasys.com/tipsapiDefs/1.0">
<TipsHeader version="3.0"/>
<Filter entity="LocalUser"/>
</TipsApiRequest>
Using Criteria in a Filter
The following is an example of using Criteria in a filter:
<Filter entity="GuestUser">
<Criteria fieldName="name" filterString="reynolds" match="equals"/>
</Filter>
Retrieving a Specific Guest Name
The following is an example of the XML response that retrieves all Guest users with the name "reynolds."
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TipsApiResponse xmlns="http://www.avendasys.com/tipsapiDefs/1.0">
<TipsHeader exportTime="Wed Sep 24 10:47:26 PST 2016" version=6.x"/>
<StatusCode>Success</StatusCode>
<EntityMaxRecordCount>1</EntityMaxRecordCount>
<GuestUsers>
<GuestUser enabled="true" expiryTime="2016-12-29 12:24:37.0"
startTime="2016-09-29 12:26:08.28" sponsorName="admin" guestType="USER"
password="webco123#" name="reynolds">
<GuestUserDetails sendSms="false" sendEmail="true" description="Test"/>
<GuestUserTags tagName="Company Name" tagValue="WebCo"/>
<GuestUserTags tagName="Email Address" tagValue="reynolds@webco.net"/>
<GuestUserTags tagName="Location" tagValue="Room A"/>
</GuestUser>
</GuestUsers>
</TipsApiResponse>