RecordsSearch
Provides records based on different criteria plus access levels. It can be used for output records paging via offset and limit parameters in a conjunction with a previous GetRecordsSearchCountRequest element. The userName is detected based on the user name logged in and the current tenant. tenantName is optional and can be used only by a Super Admin only. The default sorting criteria are by date descending. Output is limited to 200 records. The sortBy valid values are date, (the default) title and room.
This method can use the following parameters.
Request parameters
|
Name |
Type |
Description |
Required |
|---|---|---|---|
|
tenantName |
String |
For Super Admin level |
No |
|
usernameFilter |
String |
For Admin level |
No |
|
roomFilter |
String |
Filter based on roomName |
No |
|
sortBy |
sortBy |
The field by which the results should be sorted by. Valid values are “date,” “title,” and “room”. |
Yes |
|
query |
String |
The search string that uses the above filter criteria. |
No |
|
recordScope |
recordScopeFilter |
new public private organizational |
Yes |
|
dir |
sortDirection |
Sort direction: ASC, DESC |
Yes |
|
limit |
Integer |
Max 200 |
No |
|
start |
Integer |
Start search record from a specific recordnumber |
No |
|
webcast |
Boolean |
Search by webcast |
No |
Response parameters
|
Name |
Type |
Description |
Required |
|---|---|---|---|
|
allVideosCount |
Integer |
Total available user records count including public and organizational records from other users |
No |
|
searchCount |
Integer |
Available user records count after applying search filtering |
No |
|
myVideosCount |
Integer |
Total user records count for user own records Note: Admin has access for all available user records under particular tenant. |
No |
|
webcastCount |
Integer |
Total webcasts count for particular user |
No |
|
newCount |
Integer |
Total private records count for particular user |
No |
|
privateCount |
Integer |
Total organizational records count for particular user |
No |
|
organizationalCount |
Integer |
Total public records count for particular user |
No |
|
publicCount |
Integer |
Records array returned based on limit and offset criteria. Maximum output limit is 200 records |
No |
Faults
|
Name |
Description |
|---|---|
|
AccessViolationFault |
Access Violation Fault |
|
GeneralFault |
An unspecified error occurred |