GET v1/schedule/xpresscollect

Gets the xpress collect tasks.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

XpressCollectJobs
NameDescriptionTypeAdditional information
Jobs

Collection of XpressCollectTask

None.

Errors

Collection of Exception

None.

IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Jobs": [
    {
      "Type": 0,
      "JobId": "1e05c464-8011-4fa7-b2b5-12f56f0768c2",
      "FacilityId": "197bd232-356b-4965-b018-b3a41bf09804",
      "FacilityName": "sample string 2",
      "NextRun": "2021-10-18T09:34:34.5771704-07:00"
    },
    {
      "Type": 0,
      "JobId": "1e05c464-8011-4fa7-b2b5-12f56f0768c2",
      "FacilityId": "197bd232-356b-4965-b018-b3a41bf09804",
      "FacilityName": "sample string 2",
      "NextRun": "2021-10-18T09:34:34.5771704-07:00"
    }
  ],
  "Errors": [
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    },
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    }
  ],
  "IsSuccess": true
}

application/xml, text/xml

Sample:
<XpressCollectJobs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
  </Errors>
  <IsSuccess>true</IsSuccess>
  <Jobs>
    <XpressCollectTask>
      <FacilityId>197bd232-356b-4965-b018-b3a41bf09804</FacilityId>
      <FacilityName>sample string 2</FacilityName>
      <JobId>1e05c464-8011-4fa7-b2b5-12f56f0768c2</JobId>
      <NextRun>2021-10-18T09:34:34.5771704-07:00</NextRun>
      <Type>TextMessage</Type>
    </XpressCollectTask>
    <XpressCollectTask>
      <FacilityId>197bd232-356b-4965-b018-b3a41bf09804</FacilityId>
      <FacilityName>sample string 2</FacilityName>
      <JobId>1e05c464-8011-4fa7-b2b5-12f56f0768c2</JobId>
      <NextRun>2021-10-18T09:34:34.5771704-07:00</NextRun>
      <Type>TextMessage</Type>
    </XpressCollectTask>
  </Jobs>
</XpressCollectJobs>