POST api/monitoringvisits/hypotheticalnextdate
Gets the hypothetical next date for a job recurrence which has not already been created.
Request Information
URI Parameters
None.
Body Parameters
The recurrence details.
API.Infrastructure.Dto.JobRecurrence.JobRecurrenceDto| Name | Description | Type | Additional information |
|---|---|---|---|
| JobTypeId | globally unique identifier |
Required |
|
| Name | string |
Required |
|
| UserId | globally unique identifier |
None. |
|
| CreateDaysBefore | integer |
None. |
|
| SiteId | globally unique identifier |
Required |
|
| ContactId | globally unique identifier |
None. |
|
| AssetId | globally unique identifier |
None. |
|
| StartDate | date |
Required |
|
| EndDate | date |
None. |
|
| Limit | integer |
None. |
|
| ExternalReference | string |
None. |
|
| Pattern | API.Domain.JobRecurrence.RecurrencePattern |
Required |
|
| Notes | string |
None. |
|
| JobRecurrenceTypeId | globally unique identifier |
None. |
|
| LastCompletedDate | date |
None. |
|
| Chained | boolean |
None. |
|
| Systems | Collection of API.Infrastructure.Dto.JobRecurrence.JobRecurrenceSystemDto |
None. |
Request Formats
application/json, text/json
Sample:
{
"jobTypeId": "705b51d2-5ead-406d-abcf-40e9313ba5ce",
"name": "sample string 2",
"userId": "9723300b-df2c-4f69-935a-29e7d3f2936b",
"createDaysBefore": 3,
"siteId": "1ccd2dee-ff3c-4fe1-9067-3165bb98eb37",
"contactId": "6001e697-b27f-48b7-a06a-28e6ba73b7d7",
"assetId": "9b8e3a91-041b-44dc-8d3f-3a3830d3962e",
"startDate": "2026-04-15T00:19:33.4056895Z",
"endDate": "2026-04-15T00:19:33.4056895Z",
"limit": 1,
"externalReference": "sample string 6",
"pattern": {
"checked": "daily",
"underoption": "dailyCycle",
"daily": {
"cycle": 1,
"type": "daily"
},
"weekly": {
"cycle": 1,
"weekdays": [
1,
2
],
"type": "weekly"
},
"monthly": {
"dayOfMonth": 1,
"cycle": 2,
"numberOfWeekdayInMonth": 3,
"weekday": "sunday",
"type": "monthly"
},
"yearly": {
"month": 1,
"day": 2,
"numberOfWeekdayInMonth": 3,
"weekday": "sunday",
"type": "yearly"
}
},
"notes": "sample string 7",
"jobRecurrenceTypeId": "460f95ff-2064-40d0-91e7-66cb1a4f08cf",
"lastCompletedDate": "2026-04-15T00:19:33.4056895+00:00",
"chained": true,
"systems": [
{
"systemId": "sample string 1",
"systemName": "sample string 2",
"jobRecurrenceId": "60c55e05-306c-4d2c-995a-fae361b51b9a"
},
{
"systemId": "sample string 1",
"systemName": "sample string 2",
"jobRecurrenceId": "60c55e05-306c-4d2c-995a-fae361b51b9a"
}
]
}
text/html
Sample:
{"jobTypeId":"705b51d2-5ead-406d-abcf-40e9313ba5ce","name":"sample string 2","userId":"9723300b-df2c-4f69-935a-29e7d3f2936b","createDaysBefore":3,"siteId":"1ccd2dee-ff3c-4fe1-9067-3165bb98eb37","contactId":"6001e697-b27f-48b7-a06a-28e6ba73b7d7","assetId":"9b8e3a91-041b-44dc-8d3f-3a3830d3962e","startDate":"2026-04-15T00:19:33.4056895Z","endDate":"2026-04-15T00:19:33.4056895Z","limit":1,"externalReference":"sample string 6","pattern":{"checked":"daily","underoption":"dailyCycle","daily":{"cycle":1,"type":"daily"},"weekly":{"cycle":1,"weekdays":[1,2],"type":"weekly"},"monthly":{"dayOfMonth":1,"cycle":2,"numberOfWeekdayInMonth":3,"weekday":"sunday","type":"monthly"},"yearly":{"month":1,"day":2,"numberOfWeekdayInMonth":3,"weekday":"sunday","type":"yearly"}},"notes":"sample string 7","jobRecurrenceTypeId":"460f95ff-2064-40d0-91e7-66cb1a4f08cf","lastCompletedDate":"2026-04-15T00:19:33.4056895+00:00","chained":true,"systems":[{"systemId":"sample string 1","systemName":"sample string 2","jobRecurrenceId":"60c55e05-306c-4d2c-995a-fae361b51b9a"},{"systemId":"sample string 1","systemName":"sample string 2","jobRecurrenceId":"60c55e05-306c-4d2c-995a-fae361b51b9a"}]}
Response Information
Resource Description
What the next recurrence date should be based on the recurrence details.
API.Domain.ViewModels.JobRecurrence.JobRecurrencePossibleNextDate| Name | Description | Type | Additional information |
|---|---|---|---|
| NextDate | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"nextDate": "2026-04-15T00:19:33.4056895Z"
}
text/html
Sample:
{"nextDate":"2026-04-15T00:19:33.4056895Z"}