Add a Recurrence to a Job
The AddJobRecurrence web service adds a recurrence to Jobs.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | AddJobRecurrence | Required |
JobId | Int | The unique identifier of the job, which can be retrieved using any of the methods listed under add something here. | Required |
JobReference | String | The reference of the job that is input as free text. | Optional - See Tip |
RecurrencePatternId | Int | JobWatch Recurrence Id | Required |
RecurToUnallocated | Bool | When true, allows the recurrence to recur to unallocated jobs | Optional |
tip
Either the Job Id or Reference can be supplied. If both parameters are provided, the Job Id will take precedence.
Response Codes
Code | Message | Information |
---|---|---|
0 | Response Data | See 'Response' example tab |
2 | JobId or JobRef parameter required | |
2 | Invalid or missing parameter - jobId | |
2 | Unable to locate job with details provided | |
2 | "Job with ID {job.JobId} already has a recurrence applied with ID {job.JobRecurrenceId.Value} No Update will be applied" | |
2 | RecurrencePatternId parameter required | |
2 | Invalid RecurrencePatternID | |
2 | "Failed to add recurrence pattern with ID {recurrencePatternID} |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=AddJobRecurrence&JobId=131252692&RecurrencePatternId=32
Response Data
{ "Code": 0, "Result": { "jobID": 131252692, "RecurrenceID": 95659849, "Recurrencedetails": "Every 1 days. End by 04/01/2000" } }