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

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 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

Name	Description	Type	Additional 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": "efedc249-35a4-4633-9be6-fbdfafc49a16"
      },
      "allocatedTo": {
        "id": "d46f9a30-89be-40d3-b908-601a666bb0dc",
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "email": "sample string 4",
        "userTypeName": "sample string 5"
      },
      "clientName": "sample string 1",
      "siteAddress": {
        "id": "dbb9f550-6145-4dd2-8a30-182274fdb6d2",
        "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",
      "isOverdue": false,
      "completedDateByUser": "2025-06-21T16:47:37.1009652Z",
      "completedDate": "2025-06-21T16:47:37.1009652+00:00",
      "isRecurrence": true,
      "recurrenceTypeName": "sample string 4",
      "monitoringRegimeId": "sample string 5",
      "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": "38a82095-f954-46ad-ba3c-3603c9ecd070",
      "name": "sample string 7",
      "jobTypeId": "4e938df4-4042-402c-8ef5-34bad8e4a60d",
      "tenantNumericCode": 9,
      "numericCode": 10,
      "externalReference": "sample string 11",
      "timeInMinutes": 12,
      "jobReferenceCode": "9-10",
      "scheduledDate": "2025-06-21T16:47:37.1009652Z",
      "updatedDate": "2025-06-21T16:47:37.1009652Z",
      "createdDate": "2025-06-21T16:47:37.1009652Z",
      "scheduledDateAndTimeOffset": "2025-06-21T16:47:37.1009652+00:00",
      "updatedDateAndTimeOffset": "2025-06-21T16:47:37.1009652+00:00",
      "createdDateAndTimeOffset": "2025-06-21T16:47:37.1009652+00:00",
      "parentJobId": "c97962a3-2c8b-4f76-bd01-f9ee4bba3c97"
    },
    {
      "state": {
        "name": "sample string 1",
        "id": "efedc249-35a4-4633-9be6-fbdfafc49a16"
      },
      "allocatedTo": {
        "id": "d46f9a30-89be-40d3-b908-601a666bb0dc",
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "email": "sample string 4",
        "userTypeName": "sample string 5"
      },
      "clientName": "sample string 1",
      "siteAddress": {
        "id": "dbb9f550-6145-4dd2-8a30-182274fdb6d2",
        "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",
      "isOverdue": false,
      "completedDateByUser": "2025-06-21T16:47:37.1009652Z",
      "completedDate": "2025-06-21T16:47:37.1009652+00:00",
      "isRecurrence": true,
      "recurrenceTypeName": "sample string 4",
      "monitoringRegimeId": "sample string 5",
      "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": "38a82095-f954-46ad-ba3c-3603c9ecd070",
      "name": "sample string 7",
      "jobTypeId": "4e938df4-4042-402c-8ef5-34bad8e4a60d",
      "tenantNumericCode": 9,
      "numericCode": 10,
      "externalReference": "sample string 11",
      "timeInMinutes": 12,
      "jobReferenceCode": "9-10",
      "scheduledDate": "2025-06-21T16:47:37.1009652Z",
      "updatedDate": "2025-06-21T16:47:37.1009652Z",
      "createdDate": "2025-06-21T16:47:37.1009652Z",
      "scheduledDateAndTimeOffset": "2025-06-21T16:47:37.1009652+00:00",
      "updatedDateAndTimeOffset": "2025-06-21T16:47:37.1009652+00:00",
      "createdDateAndTimeOffset": "2025-06-21T16:47:37.1009652+00:00",
      "parentJobId": "c97962a3-2c8b-4f76-bd01-f9ee4bba3c97"
    }
  ]
}

text/html

Sample:

{"jobsCount":1,"jobPageItems":[{"state":{"name":"sample string 1","id":"efedc249-35a4-4633-9be6-fbdfafc49a16"},"allocatedTo":{"id":"d46f9a30-89be-40d3-b908-601a666bb0dc","firstName":"sample string 2","lastName":"sample string 3","email":"sample string 4","userTypeName":"sample string 5"},"clientName":"sample string 1","siteAddress":{"id":"dbb9f550-6145-4dd2-8a30-182274fdb6d2","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","isOverdue":false,"completedDateByUser":"2025-06-21T16:47:37.1009652Z","completedDate":"2025-06-21T16:47:37.1009652+00:00","isRecurrence":true,"recurrenceTypeName":"sample string 4","monitoringRegimeId":"sample string 5","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":"38a82095-f954-46ad-ba3c-3603c9ecd070","name":"sample string 7","jobTypeId":"4e938df4-4042-402c-8ef5-34bad8e4a60d","tenantNumericCode":9,"numericCode":10,"externalReference":"sample string 11","timeInMinutes":12,"jobReferenceCode":"9-10","scheduledDate":"2025-06-21T16:47:37.1009652Z","updatedDate":"2025-06-21T16:47:37.1009652Z","createdDate":"2025-06-21T16:47:37.1009652Z","scheduledDateAndTimeOffset":"2025-06-21T16:47:37.1009652+00:00","updatedDateAndTimeOffset":"2025-06-21T16:47:37.1009652+00:00","createdDateAndTimeOffset":"2025-06-21T16:47:37.1009652+00:00","parentJobId":"c97962a3-2c8b-4f76-bd01-f9ee4bba3c97"},{"state":{"name":"sample string 1","id":"efedc249-35a4-4633-9be6-fbdfafc49a16"},"allocatedTo":{"id":"d46f9a30-89be-40d3-b908-601a666bb0dc","firstName":"sample string 2","lastName":"sample string 3","email":"sample string 4","userTypeName":"sample string 5"},"clientName":"sample string 1","siteAddress":{"id":"dbb9f550-6145-4dd2-8a30-182274fdb6d2","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","isOverdue":false,"completedDateByUser":"2025-06-21T16:47:37.1009652Z","completedDate":"2025-06-21T16:47:37.1009652+00:00","isRecurrence":true,"recurrenceTypeName":"sample string 4","monitoringRegimeId":"sample string 5","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":"38a82095-f954-46ad-ba3c-3603c9ecd070","name":"sample string 7","jobTypeId":"4e938df4-4042-402c-8ef5-34bad8e4a60d","tenantNumericCode":9,"numericCode":10,"externalReference":"sample string 11","timeInMinutes":12,"jobReferenceCode":"9-10","scheduledDate":"2025-06-21T16:47:37.1009652Z","updatedDate":"2025-06-21T16:47:37.1009652Z","createdDate":"2025-06-21T16:47:37.1009652Z","scheduledDateAndTimeOffset":"2025-06-21T16:47:37.1009652+00:00","updatedDateAndTimeOffset":"2025-06-21T16:47:37.1009652+00:00","createdDateAndTimeOffset":"2025-06-21T16:47:37.1009652+00:00","parentJobId":"c97962a3-2c8b-4f76-bd01-f9ee4bba3c97"}]}