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": "99ba20d7-26f1-4005-9fdd-de36900e0add",
"name": "sample string 2",
"userId": "23175c7b-29cf-4249-a3a8-8a4a13b2ee90",
"createDaysBefore": 3,
"siteId": "56062f1c-20e1-4c03-b906-d51a7cf3d723",
"contactId": "d9f1ebd9-d5a8-404a-b486-8462fab41eb0",
"assetId": "906e07b1-aafb-49e9-b50b-a58b3f2135db",
"startDate": "2026-01-09T19:24:15.595525Z",
"endDate": "2026-01-09T19:24:15.595525Z",
"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": "27d783c2-03d4-49a0-8815-5c073970b7e5",
"lastCompletedDate": "2026-01-09T19:24:15.595525+00:00",
"chained": true,
"systems": [
{
"systemId": "sample string 1",
"systemName": "sample string 2",
"jobRecurrenceId": "646ddd45-e470-4a9d-b07a-a106d56f401f"
},
{
"systemId": "sample string 1",
"systemName": "sample string 2",
"jobRecurrenceId": "646ddd45-e470-4a9d-b07a-a106d56f401f"
}
]
}
text/html
Sample:
{"jobTypeId":"99ba20d7-26f1-4005-9fdd-de36900e0add","name":"sample string 2","userId":"23175c7b-29cf-4249-a3a8-8a4a13b2ee90","createDaysBefore":3,"siteId":"56062f1c-20e1-4c03-b906-d51a7cf3d723","contactId":"d9f1ebd9-d5a8-404a-b486-8462fab41eb0","assetId":"906e07b1-aafb-49e9-b50b-a58b3f2135db","startDate":"2026-01-09T19:24:15.595525Z","endDate":"2026-01-09T19:24:15.595525Z","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":"27d783c2-03d4-49a0-8815-5c073970b7e5","lastCompletedDate":"2026-01-09T19:24:15.595525+00:00","chained":true,"systems":[{"systemId":"sample string 1","systemName":"sample string 2","jobRecurrenceId":"646ddd45-e470-4a9d-b07a-a106d56f401f"},{"systemId":"sample string 1","systemName":"sample string 2","jobRecurrenceId":"646ddd45-e470-4a9d-b07a-a106d56f401f"}]}
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-01-09T19:24:15.595525Z"
}
text/html
Sample:
{"nextDate":"2026-01-09T19:24:15.595525Z"}