Schedule A Job
This web service schedules a job for a selected time.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | JobSchedule | Required |
JobId | Int | The Id of the job. | See note. |
JobRef | String | The job reference. | See note. |
ResourceId | Int | The resource Id. | Required - see note. |
ResourceRef | String | The resource reference. | Required - see note. |
AssetId | Int | The asset Id. | Required - see note. |
AssetRef | String | The asset reference. | Required - see note. |
ScheduleDate | DateTime | Date and time that the job should be scheduled, format : yyyy-MM-dd HH:mm:ss | Required |
DurationMins | Int | Duration time of the job in minutes. | Required |
note
If the asset Id or asset reference is not populated, resource reference or resource Id must be supplied.
note
Either the JobRef or JobId can be supplied. If both parameters are provided, JobId will take precedence.
Response Codes
Code | Message | Information |
---|---|---|
0 | scheduledJob.JobId | |
2 | JobId or JobRef parameter expected | |
2 | ResourceId | |
2 | Invalid parameter - scheduleDate | |
2 | durationMins parameter is missing | |
2 | Invalid parameter - durationMins | |
2 | Invalid parameter - jobId | |
2 | Invalid parameter - resourceId | |
2 | Invalid parameter - assetId | |
2 | Unable to locate Resource | |
2 | Unable to locate Asset | |
2 | Job not found |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=jobschedule
Response Data
{ "Code": 0, "Result": [ { "AssetCheckId": "12345" } ] }