GET api/v2/Resource/GetAvailableResourceSummaryList?userId={userId}&orderBy={orderBy}&minCapacity={minCapacity}&maxCapacity={maxCapacity}&udfIds={udfIds}&resourceTypeIds={resourceTypeIds}&groupIds={groupIds}&resourceClassificationId={resourceClassificationId}&locationId={locationId}&startDateUtc={startDateUtc}&endDateUtc={endDateUtc}&resourceName={resourceName}&pageNumber={pageNumber}&pageSize={pageSize}&udfInputType={udfInputType}&udfValue={udfValue}&excludeResourcesWithNoDefaultSetup={excludeResourcesWithNoDefaultSetup}&languageId={languageId}
Return the list of available resources according to filters
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userId | integer |
Required |
|
| orderBy |
order of the results ASC or DESC |
string |
Required |
| minCapacity | integer |
Required |
|
| maxCapacity | integer |
Required |
|
| udfIds |
Comma delimited list of udf Ids - Only resource characteristic udfs are returned (udf.type == 0) |
string |
Required |
| resourceTypeIds |
Comma delimited list of resource type Ids |
string |
Required |
| groupIds |
Comma delimited list of group Ids |
string |
Required |
| resourceClassificationId |
Comma delimited list of resource classification Ids |
string |
Required |
| locationId | integer |
Required |
|
| startDateUtc | string |
Required |
|
| endDateUtc | string |
Required |
|
| resourceName | string |
Default value is |
|
| pageNumber |
Optional parameter - 0 for all results |
integer |
Default value is 0 |
| pageSize |
Optional parameter - 0 for all results |
integer |
Default value is 0 |
| udfInputType |
Optional Parameter - 1 for UDF Checkbox 0 = Text 1 = Checkbox 2 = Choice 4 = Long Text |
integer |
Default value is 1 |
| udfValue |
Optional Parameter - empty for avoid check UDF value resource |
string |
Default value is |
| excludeResourcesWithNoDefaultSetup |
Optional Parameter - true to exclude resources with no default setup |
boolean |
Default value is False |
| languageId |
Optional Parameter - 1 for English |
integer |
Default value is 1 |
Body Parameters
None.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.