Get a Resource
Retrieves the details for a resource.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | ResourceDetail | Required |
ResId | Int | The BigChange resource Id. Takes precedence over reference and code. | Required |
ResReference | String | Customer supplied resource reference. Takes precedence over code. | Required |
ResCode | String | Customer supplied resource code. | Required |
Response Codes
Code | Message | Information |
---|---|---|
0 | Response Data | See 'Response' example tab |
2 | There are no resources in JobWatch | No data returned or set-up in BigChange |
2 | ResId, ResReference or ResCode must be specified" | At-least one of the optional parameters listed mut be provided |
2 | Invalid ResId | Integer value is invalid or was not specified (when required) |
2 | Unable to locate Resource by ResId | No record found using the specified parameters |
2 | Unable to locate Resource by ResReference | No record found using the specified parameters |
2 | Unable to locate Resource by ResCode | No record found using the specified parameters |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=ResourceDetail&ResId=108103
Response Data
{ "Code": 0, "Result": { "ResourceId": 108103, "ResourceGroupId": 922, "ResourceName": "Alex Johnson", "ResourceReference": "X7K2R8QZ0D", "ResourceCode": "*2481", "ResourceUserId": 22143, "ResourceMobile": "+447595626064", "ResourceWorkingHours": [ { "WeekDay": 1, "Start": 540, "Stop": 1020 } ], "ResourceOutOfShiftPrivate": false, "ResourceTimeZoneId": "GMT Standard Time", "ResourceHasTrackingAlert": true, "Resource4Tracking": true, "Resource4Schedule": 1, "ResourceMaxTravelDist": 1.24, "ResourceCreationDate": "2024-02-27 14:55:47" } }