GET api/monitoringvisits/whatsdue/recurrencesduetogeneratejobs/search?skip={skip}&take={take}&includeSuspended={includeSuspended}&dateFrom={dateFrom}&dateTo={dateTo}&searchString={searchString}

Searches for recurrences which are due to generate jobs.

Request Information

URI Parameters

Name	Description	Type	Additional information
skip	Skip over this numnber of elements in the search results (e.g. 10 will discard the first 10 search results).	integer	Required
take	Return this number of elements in the search results (e.g. 50 will return 50 results).	integer	Required
includeSuspended	Set to true if we want to include suspended recurrences.	boolean	Required
dateFrom	Search for recurrences which are going to generate jobs on or after this DateTime.	date	Required
dateTo	Search for recurrences which are going to generate jobs on or before this DateTime.	date	Required
searchString	Search for recurrences with this searchString.	string	None.

Body Parameters

None.

Response Information

Resource Description

An array of job recurrences and the total count.

API.Domain.ViewModels.JobRecurrence.JobRecurrencePage

Name	Description	Type	Additional information
JobRecurrenceCount		integer	None.
JobRecurrenceListItems		Collection of API.Domain.ViewModels.JobRecurrence.JobRecurrenceListItem	None.

Response Formats

application/json, text/json

Sample:

{
  "jobRecurrenceCount": 1,
  "jobRecurrenceListItems": [
    {
      "id": "10f4a757-d34e-4863-a7e2-9dedd9f5e693",
      "name": "sample string 2",
      "site": "sample string 3",
      "contact": {
        "id": "4af69239-1d1c-4f97-b749-9b022b26e652",
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "contactTypeName": "sample string 4"
      },
      "user": {
        "id": "c1637992-0151-4b92-8ad7-232ffc30cf89",
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "email": "sample string 4",
        "userTypeName": "sample string 5"
      },
      "lastDate": "2025-06-21T16:52:27.4360204Z",
      "nextDate": "2025-06-21T16:52:27.4360204Z",
      "lastDateOffset": "2025-06-21T16:52:27.4360204+00:00",
      "nextDateOffset": "2025-06-21T16:52:27.4360204+00:00",
      "lastCompletedDate": "2025-06-21T16:52:27.4360204Z",
      "lastCompletedDateOffset": "2025-06-21T16:52:27.4360204+00:00",
      "jobTypeGroupId": "c4bb969e-5cb0-47f0-979d-396ba6be944d",
      "jobTypeName": "sample string 4",
      "suspended": true
    },
    {
      "id": "10f4a757-d34e-4863-a7e2-9dedd9f5e693",
      "name": "sample string 2",
      "site": "sample string 3",
      "contact": {
        "id": "4af69239-1d1c-4f97-b749-9b022b26e652",
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "contactTypeName": "sample string 4"
      },
      "user": {
        "id": "c1637992-0151-4b92-8ad7-232ffc30cf89",
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "email": "sample string 4",
        "userTypeName": "sample string 5"
      },
      "lastDate": "2025-06-21T16:52:27.4360204Z",
      "nextDate": "2025-06-21T16:52:27.4360204Z",
      "lastDateOffset": "2025-06-21T16:52:27.4360204+00:00",
      "nextDateOffset": "2025-06-21T16:52:27.4360204+00:00",
      "lastCompletedDate": "2025-06-21T16:52:27.4360204Z",
      "lastCompletedDateOffset": "2025-06-21T16:52:27.4360204+00:00",
      "jobTypeGroupId": "c4bb969e-5cb0-47f0-979d-396ba6be944d",
      "jobTypeName": "sample string 4",
      "suspended": true
    }
  ]
}

text/html

Sample:

{"jobRecurrenceCount":1,"jobRecurrenceListItems":[{"id":"10f4a757-d34e-4863-a7e2-9dedd9f5e693","name":"sample string 2","site":"sample string 3","contact":{"id":"4af69239-1d1c-4f97-b749-9b022b26e652","firstName":"sample string 2","lastName":"sample string 3","contactTypeName":"sample string 4"},"user":{"id":"c1637992-0151-4b92-8ad7-232ffc30cf89","firstName":"sample string 2","lastName":"sample string 3","email":"sample string 4","userTypeName":"sample string 5"},"lastDate":"2025-06-21T16:52:27.4360204Z","nextDate":"2025-06-21T16:52:27.4360204Z","lastDateOffset":"2025-06-21T16:52:27.4360204+00:00","nextDateOffset":"2025-06-21T16:52:27.4360204+00:00","lastCompletedDate":"2025-06-21T16:52:27.4360204Z","lastCompletedDateOffset":"2025-06-21T16:52:27.4360204+00:00","jobTypeGroupId":"c4bb969e-5cb0-47f0-979d-396ba6be944d","jobTypeName":"sample string 4","suspended":true},{"id":"10f4a757-d34e-4863-a7e2-9dedd9f5e693","name":"sample string 2","site":"sample string 3","contact":{"id":"4af69239-1d1c-4f97-b749-9b022b26e652","firstName":"sample string 2","lastName":"sample string 3","contactTypeName":"sample string 4"},"user":{"id":"c1637992-0151-4b92-8ad7-232ffc30cf89","firstName":"sample string 2","lastName":"sample string 3","email":"sample string 4","userTypeName":"sample string 5"},"lastDate":"2025-06-21T16:52:27.4360204Z","nextDate":"2025-06-21T16:52:27.4360204Z","lastDateOffset":"2025-06-21T16:52:27.4360204+00:00","nextDateOffset":"2025-06-21T16:52:27.4360204+00:00","lastCompletedDate":"2025-06-21T16:52:27.4360204Z","lastCompletedDateOffset":"2025-06-21T16:52:27.4360204+00:00","jobTypeGroupId":"c4bb969e-5cb0-47f0-979d-396ba6be944d","jobTypeName":"sample string 4","suspended":true}]}