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


Searches for jobs which have been generated from recurrences.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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 jobs generated from recurrences which are currently suspended.

 boolean

Required
dateFrom

Search for generated jobs which are scheduled on or after this DateTime.

 date

Required
dateTo

Search for generated jobs which are scheduled on or before this DateTime.

 date

Required
searchString

Search for generated jobs containing this string in the searchString.

 string

None.

Body Parameters

None.

Response Information

Resource Description

An array of jobs and the total count.

API.Domain.ViewModels.Job.JobPage
NameDescriptionTypeAdditional information
JobsCount

integer

None.
JobPageItems

Collection of API.Domain.ViewModels.Job.JobListItem

None.

Response Formats

application/json, text/json

Sample: 
{
  "jobsCount": 1,
  "jobPageItems": [
    {
      "state": {
        "name": "sample string 1",
        "id": "2439d9e8-7eea-4aac-8d75-4e9b64a6d4bb"
      },
      "allocatedTo": {
        "id": "50b5d64a-cc0e-42f8-8569-6c4589328361",
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "email": "sample string 4",
        "userTypeName": "sample string 5"
      },
      "clientName": "sample string 1",
      "siteAddress": {
        "id": "0462c866-ebff-4ec9-9ad7-fa0da75c11e1",
        "address1": "sample string 1",
        "address2": "sample string 2",
        "address3": "sample string 3",
        "address4": "sample string 4",
        "city": "sample string 5",
        "county": "sample string 6",
        "country": "sample string 7",
        "zip": "sample string 8"
      },
      "jobType": {
        "name": "sample string 1",
        "version": 2,
        "state": "new"
      },
      "siteName": "sample string 2",
      "assetName": "sample string 3",
      "isOverdue": false,
      "completedDateByUser": "2026-07-25T23:25:09.3374489Z",
      "completedDate": "2026-07-25T23:25:09.3374489+00:00",
      "isRecurrence": true,
      "recurrenceTypeName": "sample string 5",
      "jobRecurrenceId": "4a30d27a-02cc-4169-a7f1-9e183805a1d3",
      "monitoringRegimeId": "sample string 6",
      "currentRamsStateId": "47685d53-40bb-4dba-90fb-43a52a0acfd3",
      "customFields": {
        "rtcNumber": "sample string 1",
        "operator": "sample string 2",
        "dayType": "sample string 3",
        "shift": "sample string 4",
        "stopId": "sample string 5",
        "direction": "sample string 6",
        "timeFrom": "sample string 7",
        "timeTo": "sample string 8",
        "serviceRestrictions": "sample string 9"
      },
      "id": "ea3d06d4-320d-47ff-9574-298a52932b33",
      "name": "sample string 8",
      "jobTypeId": "00dca0a9-80c2-4760-9b77-465707397273",
      "tenantNumericCode": 10,
      "numericCode": 11,
      "externalReference": "sample string 12",
      "timeInMinutes": 13,
      "jobReferenceCode": "10-11",
      "scheduledDate": "2026-07-25T23:25:09.3374489Z",
      "updatedDate": "2026-07-25T23:25:09.3374489Z",
      "createdDate": "2026-07-25T23:25:09.3374489Z",
      "scheduledDateAndTimeOffset": "2026-07-25T23:25:09.3374489+00:00",
      "updatedDateAndTimeOffset": "2026-07-25T23:25:09.3374489+00:00",
      "createdDateAndTimeOffset": "2026-07-25T23:25:09.3374489+00:00",
      "parentJobId": "75c02b6e-2e40-4cc3-9609-3aecfbd05213",
      "jobCategoryId": "7b20fb6a-e3bd-4dad-8b43-99adfc1e55cc"
    },
    {
      "state": {
        "name": "sample string 1",
        "id": "2439d9e8-7eea-4aac-8d75-4e9b64a6d4bb"
      },
      "allocatedTo": {
        "id": "50b5d64a-cc0e-42f8-8569-6c4589328361",
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "email": "sample string 4",
        "userTypeName": "sample string 5"
      },
      "clientName": "sample string 1",
      "siteAddress": {
        "id": "0462c866-ebff-4ec9-9ad7-fa0da75c11e1",
        "address1": "sample string 1",
        "address2": "sample string 2",
        "address3": "sample string 3",
        "address4": "sample string 4",
        "city": "sample string 5",
        "county": "sample string 6",
        "country": "sample string 7",
        "zip": "sample string 8"
      },
      "jobType": {
        "name": "sample string 1",
        "version": 2,
        "state": "new"
      },
      "siteName": "sample string 2",
      "assetName": "sample string 3",
      "isOverdue": false,
      "completedDateByUser": "2026-07-25T23:25:09.3374489Z",
      "completedDate": "2026-07-25T23:25:09.3374489+00:00",
      "isRecurrence": true,
      "recurrenceTypeName": "sample string 5",
      "jobRecurrenceId": "4a30d27a-02cc-4169-a7f1-9e183805a1d3",
      "monitoringRegimeId": "sample string 6",
      "currentRamsStateId": "47685d53-40bb-4dba-90fb-43a52a0acfd3",
      "customFields": {
        "rtcNumber": "sample string 1",
        "operator": "sample string 2",
        "dayType": "sample string 3",
        "shift": "sample string 4",
        "stopId": "sample string 5",
        "direction": "sample string 6",
        "timeFrom": "sample string 7",
        "timeTo": "sample string 8",
        "serviceRestrictions": "sample string 9"
      },
      "id": "ea3d06d4-320d-47ff-9574-298a52932b33",
      "name": "sample string 8",
      "jobTypeId": "00dca0a9-80c2-4760-9b77-465707397273",
      "tenantNumericCode": 10,
      "numericCode": 11,
      "externalReference": "sample string 12",
      "timeInMinutes": 13,
      "jobReferenceCode": "10-11",
      "scheduledDate": "2026-07-25T23:25:09.3374489Z",
      "updatedDate": "2026-07-25T23:25:09.3374489Z",
      "createdDate": "2026-07-25T23:25:09.3374489Z",
      "scheduledDateAndTimeOffset": "2026-07-25T23:25:09.3374489+00:00",
      "updatedDateAndTimeOffset": "2026-07-25T23:25:09.3374489+00:00",
      "createdDateAndTimeOffset": "2026-07-25T23:25:09.3374489+00:00",
      "parentJobId": "75c02b6e-2e40-4cc3-9609-3aecfbd05213",
      "jobCategoryId": "7b20fb6a-e3bd-4dad-8b43-99adfc1e55cc"
    }
  ]
}

text/html

Sample: 
{"jobsCount":1,"jobPageItems":[{"state":{"name":"sample string 1","id":"2439d9e8-7eea-4aac-8d75-4e9b64a6d4bb"},"allocatedTo":{"id":"50b5d64a-cc0e-42f8-8569-6c4589328361","firstName":"sample string 2","lastName":"sample string 3","email":"sample string 4","userTypeName":"sample string 5"},"clientName":"sample string 1","siteAddress":{"id":"0462c866-ebff-4ec9-9ad7-fa0da75c11e1","address1":"sample string 1","address2":"sample string 2","address3":"sample string 3","address4":"sample string 4","city":"sample string 5","county":"sample string 6","country":"sample string 7","zip":"sample string 8"},"jobType":{"name":"sample string 1","version":2,"state":"new"},"siteName":"sample string 2","assetName":"sample string 3","isOverdue":false,"completedDateByUser":"2026-07-25T23:25:09.3374489Z","completedDate":"2026-07-25T23:25:09.3374489+00:00","isRecurrence":true,"recurrenceTypeName":"sample string 5","jobRecurrenceId":"4a30d27a-02cc-4169-a7f1-9e183805a1d3","monitoringRegimeId":"sample string 6","currentRamsStateId":"47685d53-40bb-4dba-90fb-43a52a0acfd3","customFields":{"rtcNumber":"sample string 1","operator":"sample string 2","dayType":"sample string 3","shift":"sample string 4","stopId":"sample string 5","direction":"sample string 6","timeFrom":"sample string 7","timeTo":"sample string 8","serviceRestrictions":"sample string 9"},"id":"ea3d06d4-320d-47ff-9574-298a52932b33","name":"sample string 8","jobTypeId":"00dca0a9-80c2-4760-9b77-465707397273","tenantNumericCode":10,"numericCode":11,"externalReference":"sample string 12","timeInMinutes":13,"jobReferenceCode":"10-11","scheduledDate":"2026-07-25T23:25:09.3374489Z","updatedDate":"2026-07-25T23:25:09.3374489Z","createdDate":"2026-07-25T23:25:09.3374489Z","scheduledDateAndTimeOffset":"2026-07-25T23:25:09.3374489+00:00","updatedDateAndTimeOffset":"2026-07-25T23:25:09.3374489+00:00","createdDateAndTimeOffset":"2026-07-25T23:25:09.3374489+00:00","parentJobId":"75c02b6e-2e40-4cc3-9609-3aecfbd05213","jobCategoryId":"7b20fb6a-e3bd-4dad-8b43-99adfc1e55cc"},{"state":{"name":"sample string 1","id":"2439d9e8-7eea-4aac-8d75-4e9b64a6d4bb"},"allocatedTo":{"id":"50b5d64a-cc0e-42f8-8569-6c4589328361","firstName":"sample string 2","lastName":"sample string 3","email":"sample string 4","userTypeName":"sample string 5"},"clientName":"sample string 1","siteAddress":{"id":"0462c866-ebff-4ec9-9ad7-fa0da75c11e1","address1":"sample string 1","address2":"sample string 2","address3":"sample string 3","address4":"sample string 4","city":"sample string 5","county":"sample string 6","country":"sample string 7","zip":"sample string 8"},"jobType":{"name":"sample string 1","version":2,"state":"new"},"siteName":"sample string 2","assetName":"sample string 3","isOverdue":false,"completedDateByUser":"2026-07-25T23:25:09.3374489Z","completedDate":"2026-07-25T23:25:09.3374489+00:00","isRecurrence":true,"recurrenceTypeName":"sample string 5","jobRecurrenceId":"4a30d27a-02cc-4169-a7f1-9e183805a1d3","monitoringRegimeId":"sample string 6","currentRamsStateId":"47685d53-40bb-4dba-90fb-43a52a0acfd3","customFields":{"rtcNumber":"sample string 1","operator":"sample string 2","dayType":"sample string 3","shift":"sample string 4","stopId":"sample string 5","direction":"sample string 6","timeFrom":"sample string 7","timeTo":"sample string 8","serviceRestrictions":"sample string 9"},"id":"ea3d06d4-320d-47ff-9574-298a52932b33","name":"sample string 8","jobTypeId":"00dca0a9-80c2-4760-9b77-465707397273","tenantNumericCode":10,"numericCode":11,"externalReference":"sample string 12","timeInMinutes":13,"jobReferenceCode":"10-11","scheduledDate":"2026-07-25T23:25:09.3374489Z","updatedDate":"2026-07-25T23:25:09.3374489Z","createdDate":"2026-07-25T23:25:09.3374489Z","scheduledDateAndTimeOffset":"2026-07-25T23:25:09.3374489+00:00","updatedDateAndTimeOffset":"2026-07-25T23:25:09.3374489+00:00","createdDateAndTimeOffset":"2026-07-25T23:25:09.3374489+00:00","parentJobId":"75c02b6e-2e40-4cc3-9609-3aecfbd05213","jobCategoryId":"7b20fb6a-e3bd-4dad-8b43-99adfc1e55cc"}]}