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": "72dd9f56-867a-4282-b75a-08b08df59383",
"name": "sample string 2",
"userId": "920d29f7-712c-461f-bb80-2f0caef45106",
"createDaysBefore": 3,
"siteId": "d6320f53-c0b1-4c62-ad68-a7c23e04457e",
"contactId": "192bfe8d-ff67-4c9f-baad-3e5b178d9733",
"assetId": "90794dc5-b75e-4c76-80f1-3749b0b76ef3",
"startDate": "2026-06-02T00:35:07.6236058Z",
"endDate": "2026-06-02T00:35:07.6236058Z",
"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": "73ab4053-373c-4187-b037-2cf54486ff02",
"lastCompletedDate": "2026-06-02T00:35:07.6236058+00:00",
"chained": true,
"systems": [
{
"systemId": "sample string 1",
"systemName": "sample string 2",
"jobRecurrenceId": "556cb6c3-b728-42a2-82dd-28a7f25e6ef8"
},
{
"systemId": "sample string 1",
"systemName": "sample string 2",
"jobRecurrenceId": "556cb6c3-b728-42a2-82dd-28a7f25e6ef8"
}
]
}
text/html
Sample:
{"jobTypeId":"72dd9f56-867a-4282-b75a-08b08df59383","name":"sample string 2","userId":"920d29f7-712c-461f-bb80-2f0caef45106","createDaysBefore":3,"siteId":"d6320f53-c0b1-4c62-ad68-a7c23e04457e","contactId":"192bfe8d-ff67-4c9f-baad-3e5b178d9733","assetId":"90794dc5-b75e-4c76-80f1-3749b0b76ef3","startDate":"2026-06-02T00:35:07.6236058Z","endDate":"2026-06-02T00:35:07.6236058Z","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":"73ab4053-373c-4187-b037-2cf54486ff02","lastCompletedDate":"2026-06-02T00:35:07.6236058+00:00","chained":true,"systems":[{"systemId":"sample string 1","systemName":"sample string 2","jobRecurrenceId":"556cb6c3-b728-42a2-82dd-28a7f25e6ef8"},{"systemId":"sample string 1","systemName":"sample string 2","jobRecurrenceId":"556cb6c3-b728-42a2-82dd-28a7f25e6ef8"}]}
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-06-02T00:35:07.6236058Z"
}
text/html
Sample:
{"nextDate":"2026-06-02T00:35:07.6236058Z"}