GET api/v2/Resource/GetAvailableResourceListByLocation?startDateUtc={startDateUtc}&endDateUtc={endDateUtc}&locationId={locationId}&userId={userId}&resourceTypeId={resourceTypeId}&returnAllResults={returnAllResults}&pageNumber={pageNumber}&pageSize={pageSize}&resourceClassificationId={resourceClassificationId}
Get Available Resource List By Location Note: Paging will not decrease processing time as the available resources must be calculated prior to paging the result set
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| startDateUtc | string |
Required |
|
| endDateUtc | string |
Required |
|
| locationId | integer |
Required |
|
| userId | integer |
Required |
|
| resourceTypeId |
0 for all resource types |
integer |
Required |
| returnAllResults |
Optional parameter to return complete result set with error codes - True overrides pageNumber/pageSize |
boolean |
Default value is False |
| pageNumber |
Optional parameter - 0 for all results |
integer |
Default value is 0 |
| pageSize |
Optional parameter - 0 for all results |
integer |
Default value is 0 |
| resourceClassificationId |
Optional parameter - Exclude for all results |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
Resource Summary
Collection of ResourceSummary| Name | Description | Type | Additional information |
|---|---|---|---|
| ResourceId | integer |
None. |
|
| ResourceName | string |
None. |
|
| GroupId | integer |
None. |
|
| LocationId | integer |
None. |
|
| ResourceTypeId | integer |
None. |
|
| ErrorCode | integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ResourceId": 1,
"ResourceName": "sample string 2",
"GroupId": 3,
"LocationId": 4,
"ResourceTypeId": 5,
"ErrorCode": 6
},
{
"ResourceId": 1,
"ResourceName": "sample string 2",
"GroupId": 3,
"LocationId": 4,
"ResourceTypeId": 5,
"ErrorCode": 6
}
]
application/xml, text/xml
Sample:
<ArrayOfResourceSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RSMCP.Entities">
<ResourceSummary>
<ErrorCode>6</ErrorCode>
<GroupId>3</GroupId>
<LocationId>4</LocationId>
<ResourceId>1</ResourceId>
<ResourceName>sample string 2</ResourceName>
<ResourceTypeId>5</ResourceTypeId>
</ResourceSummary>
<ResourceSummary>
<ErrorCode>6</ErrorCode>
<GroupId>3</GroupId>
<LocationId>4</LocationId>
<ResourceId>1</ResourceId>
<ResourceName>sample string 2</ResourceName>
<ResourceTypeId>5</ResourceTypeId>
</ResourceSummary>
</ArrayOfResourceSummary>