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	Type	Additional information
JobTypeId	globally unique identifier	Required
Name	string	Required
UserId	globally unique identifier	None.
CreateDaysBefore	integer	Required
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": "515e6041-705a-42dc-926b-e114b99d79ac",
  "name": "sample string 2",
  "userId": "598aa737-6566-493e-9b80-def26ed4145c",
  "createDaysBefore": 3,
  "siteId": "d93a7da0-ac09-4bcb-b151-9c9133f48023",
  "contactId": "8bf4b1d0-ab36-4d15-ab23-d02ef4652dda",
  "assetId": "8d237aca-0d12-49cb-8865-a3bc157c711a",
  "startDate": "2025-06-21T15:11:11.0492643Z",
  "endDate": "2025-06-21T15:11:11.0492643Z",
  "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": "e4fd3663-2abd-4efc-a10f-e5f337410a4d",
  "lastCompletedDate": "2025-06-21T15:11:11.0492643+00:00",
  "chained": true,
  "systems": [
    {
      "systemId": "sample string 1",
      "systemName": "sample string 2",
      "jobRecurrenceId": "a08241ce-0c0b-4f85-914e-6f49a91abdd1"
    },
    {
      "systemId": "sample string 1",
      "systemName": "sample string 2",
      "jobRecurrenceId": "a08241ce-0c0b-4f85-914e-6f49a91abdd1"
    }
  ]
}

text/html

Sample:

{"jobTypeId":"515e6041-705a-42dc-926b-e114b99d79ac","name":"sample string 2","userId":"598aa737-6566-493e-9b80-def26ed4145c","createDaysBefore":3,"siteId":"d93a7da0-ac09-4bcb-b151-9c9133f48023","contactId":"8bf4b1d0-ab36-4d15-ab23-d02ef4652dda","assetId":"8d237aca-0d12-49cb-8865-a3bc157c711a","startDate":"2025-06-21T15:11:11.0492643Z","endDate":"2025-06-21T15:11:11.0492643Z","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":"e4fd3663-2abd-4efc-a10f-e5f337410a4d","lastCompletedDate":"2025-06-21T15:11:11.0492643+00:00","chained":true,"systems":[{"systemId":"sample string 1","systemName":"sample string 2","jobRecurrenceId":"a08241ce-0c0b-4f85-914e-6f49a91abdd1"},{"systemId":"sample string 1","systemName":"sample string 2","jobRecurrenceId":"a08241ce-0c0b-4f85-914e-6f49a91abdd1"}]}

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": "2025-06-21T15:11:11.0492643Z"
}

text/html

Sample:

{"nextDate":"2025-06-21T15:11:11.0492643Z"}