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": "fd29ea8c-0fc2-4bc2-a17f-99238f367204",
"name": "sample string 2",
"userId": "be1a385c-95a9-4085-8d25-e4aa52e97ce3",
"createDaysBefore": 3,
"siteId": "97fb2eaf-7aae-4a63-aca2-ae1dd94dd683",
"contactId": "c70103de-11a8-45ed-82b8-996a2dc1dce0",
"assetId": "ab7e9387-2626-4021-9ca7-17ecfb80f358",
"startDate": "2026-02-27T04:03:05.4915481Z",
"endDate": "2026-02-27T04:03:05.4915481Z",
"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": "93182945-b8eb-463d-86e0-032cb6e2660c",
"lastCompletedDate": "2026-02-27T04:03:05.4915481+00:00",
"chained": true,
"systems": [
{
"systemId": "sample string 1",
"systemName": "sample string 2",
"jobRecurrenceId": "391eac41-5379-4797-87da-0e0cd136637b"
},
{
"systemId": "sample string 1",
"systemName": "sample string 2",
"jobRecurrenceId": "391eac41-5379-4797-87da-0e0cd136637b"
}
]
}
text/html
Sample:
{"jobTypeId":"fd29ea8c-0fc2-4bc2-a17f-99238f367204","name":"sample string 2","userId":"be1a385c-95a9-4085-8d25-e4aa52e97ce3","createDaysBefore":3,"siteId":"97fb2eaf-7aae-4a63-aca2-ae1dd94dd683","contactId":"c70103de-11a8-45ed-82b8-996a2dc1dce0","assetId":"ab7e9387-2626-4021-9ca7-17ecfb80f358","startDate":"2026-02-27T04:03:05.4915481Z","endDate":"2026-02-27T04:03:05.4915481Z","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":"93182945-b8eb-463d-86e0-032cb6e2660c","lastCompletedDate":"2026-02-27T04:03:05.4915481+00:00","chained":true,"systems":[{"systemId":"sample string 1","systemName":"sample string 2","jobRecurrenceId":"391eac41-5379-4797-87da-0e0cd136637b"},{"systemId":"sample string 1","systemName":"sample string 2","jobRecurrenceId":"391eac41-5379-4797-87da-0e0cd136637b"}]}
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-02-27T04:03:05.4915481Z"
}
text/html
Sample:
{"nextDate":"2026-02-27T04:03:05.4915481Z"}