Skip to content

jobEventsXml

Supported, no replacement yet

This endpoint remains fully supported. No replacement exists in the new API yet, and no action is needed. When a replacement ships you will get 12 months' notice, and this site will be updated.

Reference

/rest/workflow/job/jobEventsXML/{startDate}/{endDate}/{clientRef}/{eventIdList}

GET
Gets job details for all jobs that have undergone the specified job event IDs (provided in a comma-separated list) within the period specified (start date/time to end date/time inclusive), for the client ref specified.

Parameters

startDate - date to get events from in format dd-mmm-yyyy hh:mm:ss
endDate - date to get events to in format dd-mmm-yyyy hh:mm:ss
clientRef - the ID of the client
eventIdList - the ID of the events to include, in a comma-separated list

e.g. rest/workflow/job/jobEventsXML/29-May-2012%2010:30:00/30-May-2012%2000:00:00/1/71,135,326

available response representations:
  • 200 - XML

<root>    <jobs>        <job jobRef="J007TG"             jobId="8167"             eventRecordedBy="IT-Admin"             eventDateTime="12/07/2011 12:34:34"             eventRef="BDH6"             eventDescription="move"             eventNotes="notes"             eventNotedescription="note desc"             eventCount="2"             appointmentId="8343"             ownerName="ITAdmin"             ownerEmail="email"             siteRef="abc123"             siteName="14 New Street"             siteAdd1="Add 1"             siteAdd2="Add 2"             siteAdd3="Add 3"             siteAdd4="Add 4"             sitePostCode="Post Code"             siteType="Flat"             siteGroup="central belt"             siteRegion="EDINBURGH"             usageType="central belt"             contact_c1="07729882990"             contact_c2="PETERGRANT1957@GMAIL.COM"             contact_c3=""             contact_c4=""             contact_c1type="10"             contact_c2type="6"             contact_c3type="1"             contact_c4type="1"             contactNotes="notes"             contactConsiderations="considerations"             contactRef="3790"             workLogType="23"             jobClientRef="hfhei"             workTypeCode="CYCL"             serviceDescription="Electrical"             priorityRef="M34"             supplierName="Direct Team"             supplierEmail="DirectEmail"             supplierGroup="Direct"             jobDescription="fix tap"             jobStatus="In Progress"             jobExportedDate="06/05/2013 10:30:00"             codeID=""             code=""             siteConsiderations="dkjf"             contactSal="Mr"             contactForename="Bob"             contactSurname="Smith"             contactPreferred="07845 377899"             reportedBy="bob"             reportedDateTime="11/07/2011 12:32:17"             createDateTime="11/07/2011 12:32:17"             targetDateTime="11/07/2011 12:32:17"             plannedStartDateTime="11/07/2011 12:32:17"             plannedEndDateTime="11/07/2011 12:32:17"             actualStartDateTime="11/07/2011 12:32:17"             actualEndDateTime="11/07/2011 12:32:17"             jobVersion="2"             damage="ABC23"             versionStatus="3"             invoiceNumber="3838"             invoiceDate="11/07/2011 12:32:43">
            <activities>                <activity activityId="15546"                          libraryActivityCode="fbfdjj"                          description="fix tap"                          activityRef=""                          quantity="2"                          completedQuantity="0"                          category="Activity category 1"                          assetId=""                          siteLocation="location"                          resourceName="John Doe"                          addedBy="itadmin"                          addedOn="12/03/2011 12:34:34"                          notes=""/>            </activities>
            <appointments>                <appointment ref="abjdjd"                             status="5"                             sequence=""                             resourceName=""                             resourceId=""                             resourceRef=""                             resourceEmail=""                             plannedStartDateTime="12/03/2011 12:34:34"                             plannedEndDateTime="12/03/2011 12:34:34"                             actualStartDateTime="12/03/2011 12:34:34"                             actualEndDateTime="12/03/2011 12:34:34"                             resolutionNotes="All work completed"                             clientRef=""                             dayDivision="AM"                             movedToId="" />            </appointments>
            <jobCosts>                <jobCost jobCostId="500"                         jobCostRef="null"                         description="description"                         activityCode="abc"                         activityId=""                         supplier=""                         resource=""                         costType=""                         postingTypeId="1"                         statusId="1"                         financialDate="17/11/2011"                         quantity="50.0"                         unitCost="0.9"                         total="0.0"                         cost="0.0"                         supplierCost="0.9"                         plusTax="0.99"                         plusUplift="0.9"                         plusProfit="0.9"/>            </jobCosts>
            <jobParts>                <jobPart jobRef="J007TG"                         partRef="489419"                         status="USED"                         partDescription="VAILLANT 114286 KNOB (SET OF 3) "                         partUnitSalesValue="0.0"                         quantityRequested="0.00"                         quantityReceived="0.00">                    <stockTransactions>                        <stockTransaction                                quantityUsed="1.0"                                resourceID="71"                                resourceName="IT Admin"                                employeeRef="12345"/>                    </stockTransactions>                </jobPart>            </jobParts>
            <attributes>                <attribute id = ""                           name="Issue Date"                           value="12/12/2009 12:34:56"                           attributeGroupId=""                           attributeGroup=""/>            </attributes>        </job>    </jobs></root>

200 - JSON with Multiple Activities

{
  "root": {
    "result": "success",
    "jobs": {
      "job": {
        "jobRef": "J009A5",
        "jobId": 8167,
        "eventRecordedBy": "homegroup Interface",
        "eventDateTime": "18/10/2021 10:42:28",
        "eventRef": "CE0083",
        "eventDescription": "getSlots Request",
        "eventNotes": "novus get appointment slots request",
        "eventNotedescription": "notes desc",
        "eventCount": 3,
        "appointmentId": "2343",
        "ownerName": "ITAdmin",
        "ownerEmail": "owner@email.com",
        "siteRef": 1111209,
        "siteName": "Orange Salamander Court",
        "siteAdd1": "Add 1",
        "siteAdd2": "Add 2",
        "siteAdd3": "Add 3",
        "siteAdd4": "Add 4",
        "sitePostCode": "EH6 7HY",
        "siteType": "Flat ",
        "siteGroup": "Central Belt",
        "siteRegion": "EDINBURGH",
        "usageType": "Central Belt",
        "contact_c1": "07729882990",
        "contact_c2": "PETERGRANT1957@GMAIL.COM",
        "contact_c3": "",
        "contact_c4": "",
        "contact_c1type": 10,
        "contact_c2type": 6,
        "contact_c3type": 1,
        "contact_c4type": 1,
        "contactNotes": "contact notes",
        "contactConsiderations": "contact considerations",
        "contactRef": 3790,
        "workLogType": 16,
        "jobClientRef": "TSR016733",
        "workTypeCode": "RESP",
        "serviceDescription": "Plumber",
        "priorityRef": "M34",
        "supplierName": "Scotland",
        "supplierEmail": "supplier@email.com",
        "supplierGroup": "Direct",
        "jobDescription": "Plumber Needed For Pipework\nPipe:Renew or supply and fix pipe clip for any diameter copper pipe including plugging and screwing as necessary.NEAREST CODE USED FOR THISAPPT UNAPPOINTED NO SLOTSLINKED TO CONTACT NUMBER 01312411693VULN NO COVID 19 = NOO RISKTHE PIPES ARE BANGING ON THE FLOOBOARDS PLEASE CAN YOU SEE WHAT CAN BE\nraised_by : David Thompson\nVulnerability : \nCOVNO COVID19 - No Risk\nAsbestos : \nPOST2000 Property",
        "jobStatus": "Waiting to Start",
        "jobExportedDate": "06/05/2013 10:30:00",
        "codeID": 14,
        "code": "R10220SC",
        "siteConsiderations": "dkjf",
        "contactSal": "Mr",
        "contactForename": "Peter",
        "contactSurname": "Grant",
        "contactPreferred": "07729882990",
        "reportedBy": "THOMPSONDA",
        "reportedDateTime": "15/10/2021 07:33:00",
        "createDateTime": "16/10/2021 23:02:27",
        "targetDateTime": "25/10/2021 07:33:00",
        "plannedStartDateTime": "18/10/2021 11:06:00",
        "plannedEndDateTime": "18/10/2021 11:11:00",
        "actualStartDateTime": "11/07/2011 12:32:17",
        "actualEndDateTime": "11/07/2011 12:32:17",
        "jobVersion": 1,
        "damage": "ABC23",
        "versionStatus": "Approved",
        "invoiceNumber": "3838",
        "invoiceDate": "11/07/2011 12:32:4",
        "activities": {
          "activity": [
            {
              "activityId": 84319,
              "libraryActivityCode": 635013,
              "description": "Pipe:Renew or supply and fix pipe clip for any diameter copper pipe including plugging and screwing as necessary.",
              "activityRef": "",
              "quantity": 1,
              "completedQuantity": 0,
              "category": "",
              "assetId": 1234,
              "siteLocation": "",
              "resourceName": "",
              "addedBy": "homegroup Interface",
              "addedOn": "24/10/2021 19:03:48",
              "notes": null 
            },
            {
              "activityId": 84320,
              "libraryActivityCode": 635091,
              "description": "Pipe:Renew or fix new any 15mm diameter pipe with copper pipe fixed with clips and including all made bends, connectors, fittings and any adaptors for jointing to pipes of other material.",
              "activityRef": "",
              "quantity": 1,
              "completedQuantity": 0,
              "category": "",
              "assetId": 8979,
              "siteLocation": "",
              "resourceName": "",
              "addedBy": "homegroup Interface",
              "addedOn": "24/10/2021 19:03:48",
              "notes": null 
            } 
          ] 
        },
        "appointments": {
          "appointment": {
            "ref": 12900,
            "status": 2,
            "sequence": 1,
            "resourceName": "Davie Gilliland",
            "resourceId": 159,
            "resourceRef": "",
            "resourceEmail": "davie.gilliland@novussolutions.co.uk",
            "plannedStartDateTime": "18/10/2021 11:06:00",
            "plannedEndDateTime": "18/10/2021 11:11:00",
            "actualStartDateTime": "06/03/2020 10:34:51",
            "actualEndDateTime": "06/03/2020 13:40:59",
            "resolutionNotes": "check over found controler failed.  supply and fit new controler set up run and test.",
            "clientRef": "J009A5OS12900",
            "dayDivision": "AM",
            "movedToId": "" 
          } 
        },
        "jobCosts": {
          "jobCost": {
            "jobCostId": 91559,
            "jobCostRef": "Callout",
            "description": "635013: PIPE:RENEW PLASTIC CLIP TO COPPER PIPE",
            "activityCode": 635013,
            "activityId": 84239,
            "supplier": "Scotland",
            "resource": "Davie Gilliland",
            "costType": "Activity",
            "postingTypeId": 1,
            "statusId": 1,
            "financialDate": "16/10/2021",
            "quantity": 1,
            "unitCost": 3.48,
            "total": 0,
            "cost": 0,
            "supplierCost": 3.48,
            "plusTax": 0,
            "plusUplift": 0,
            "plusProfit": 0 
          } 
        },
        "jobParts": {
          "jobPart": {
            "jobRef": "J00K30",
            "partRef": 103305,
            "status": "USED",
            "partDescription": "Dixell Controller",
            "partUnitSalesValue": 61.54,
            "quantityRequested": 0,
            "quantityReceived": 0,
            "stockTransactions": {
              "stockTransaction": {
                "quantityUsed": 1,
                "resourceID": 105,
                "resourceName": "Ian Suggett",
                "employeeRef": "" 
              } 
            } 
          } 
        },
        "attributes": {
          "attribute": [
            {
              "id": 367,
              "name": "Have you added notes to your Job?",
              "value": true,
              "attributeGroup": "Notes Added",
              "attributeGroupId": 50 
            },
            {
              "id": 373,
              "name": "Location",
              "value": "kitchen",
              "attributeGroup": "Appliance",
              "attributeGroupId": 68 
            } 
          ] 
        } 
      } 
    },
    "result_msg": "" 
  }
}

200 - JSON with single activity

{
  "root": {
    "result": "success",
    "jobs": {
      "job": {
        "jobRef": "J009A5",
        "jobId": 8167,
        "eventRecordedBy": "homegroup Interface",
        "eventDateTime": "18/10/2021 10:42:28",
        "eventRef": "CE0083",
        "eventDescription": "getSlots Request",
        "eventNotes": "novus get appointment slots request",
        "eventNotedescription": "notes desc",
        "eventCount": 3,
        "appointmentId": "2343",
        "ownerName": "ITAdmin",
        "ownerEmail": "owner@email.com",
        "siteRef": 1111209,
        "siteName": "Orange Salamander Court",
        "siteAdd1": "Add 1",
        "siteAdd2": "Add 2",
        "siteAdd3": "Add 3",
        "siteAdd4": "Add 4",
        "sitePostCode": "EH6 7HY",
        "siteType": "Flat ",
        "siteGroup": "Central Belt",
        "siteRegion": "EDINBURGH",
        "usageType": "Central Belt",
        "contact_c1": "07729882990",
        "contact_c2": "PETERGRANT1957@GMAIL.COM",
        "contact_c3": "",
        "contact_c4": "",
        "contact_c1type": 10,
        "contact_c2type": 6,
        "contact_c3type": 1,
        "contact_c4type": 1,
        "contactNotes": "contact notes",
        "contactConsiderations": "contact considerations",
        "contactRef": 3790,
        "workLogType": 16,
        "jobClientRef": "TSR016733",
        "workTypeCode": "RESP",
        "serviceDescription": "Plumber",
        "priorityRef": "M34",
        "supplierName": "Scotland",
        "supplierEmail": "supplier@email.com",
        "supplierGroup": "Direct",
        "jobDescription": "Plumber Needed For Pipework\nPipe:Renew or supply and fix pipe clip for any diameter copper pipe including plugging and screwing as necessary.NEAREST CODE USED FOR THISAPPT UNAPPOINTED NO SLOTSLINKED TO CONTACT NUMBER 01312411693VULN NO COVID 19 = NOO RISKTHE PIPES ARE BANGING ON THE FLOOBOARDS PLEASE CAN YOU SEE WHAT CAN BE\nraised_by : David Thompson\nVulnerability : \nCOVNO COVID19 - No Risk\nAsbestos : \nPOST2000 Property",
        "jobStatus": "Waiting to Start",
        "jobExportedDate": "06/05/2013 10:30:00",
        "codeID": 14,
        "code": "R10220SC",
        "siteConsiderations": "dkjf",
        "contactSal": "Mr",
        "contactForename": "Peter",
        "contactSurname": "Grant",
        "contactPreferred": "07729882990",
        "reportedBy": "THOMPSONDA",
        "reportedDateTime": "15/10/2021 07:33:00",
        "createDateTime": "16/10/2021 23:02:27",
        "targetDateTime": "25/10/2021 07:33:00",
        "plannedStartDateTime": "18/10/2021 11:06:00",
        "plannedEndDateTime": "18/10/2021 11:11:00",
        "actualStartDateTime": "11/07/2011 12:32:17",
        "actualEndDateTime": "11/07/2011 12:32:17",
        "jobVersion": 1,
        "damage": "ABC23",
        "versionStatus": "Approved",
        "invoiceNumber": "3838",
        "invoiceDate": "11/07/2011 12:32:4",
        "activities": {
          "activity": {
            "activityId": 84320,
            "libraryActivityCode": 635091,
            "description": "Pipe:Renew or fix new any 15mm diameter pipe with copper pipe fixed with clips and including all made bends, connectors, fittings and any adaptors for jointing to pipes of other material.",
            "activityRef": "",
            "quantity": 1,
            "completedQuantity": 0,
            "category": "",
            "assetId": 8979,
            "siteLocation": "",
            "resourceName": "",
            "addedBy": "homegroup Interface",
            "addedOn": "24/10/2021 19:03:48",
            "notes": null 
          } 
        },
        "appointments": {
          "appointment": {
            "ref": 12900,
            "status": 2,
            "sequence": 1,
            "resourceName": "Davie Gilliland",
            "resourceId": 159,
            "resourceRef": "",
            "resourceEmail": "davie.gilliland@novussolutions.co.uk",
            "plannedStartDateTime": "18/10/2021 11:06:00",
            "plannedEndDateTime": "18/10/2021 11:11:00",
            "actualStartDateTime": "06/03/2020 10:34:51",
            "actualEndDateTime": "06/03/2020 13:40:59",
            "resolutionNotes": "check over found controler failed.  supply and fit new controler set up run and test.",
            "clientRef": "J009A5OS12900",
            "dayDivision": "AM",
            "movedToId": "" 
          } 
        },
        "jobCosts": {
          "jobCost": {
            "jobCostId": 91559,
            "jobCostRef": "Callout",
            "description": "635013: PIPE:RENEW PLASTIC CLIP TO COPPER PIPE",
            "activityCode": 635013,
            "activityId": 84239,
            "supplier": "Scotland",
            "resource": "Davie Gilliland",
            "costType": "Activity",
            "postingTypeId": 1,
            "statusId": 1,
            "financialDate": "16/10/2021",
            "quantity": 1,
            "unitCost": 3.48,
            "total": 0,
            "cost": 0,
            "supplierCost": 3.48,
            "plusTax": 0,
            "plusUplift": 0,
            "plusProfit": 0 
          } 
        },
        "jobParts": {
          "jobPart": {
            "jobRef": "J00K30",
            "partRef": 103305,
            "status": "USED",
            "partDescription": "Dixell Controller",
            "partUnitSalesValue": 61.54,
            "quantityRequested": 0,
            "quantityReceived": 0,
            "stockTransactions": {
              "stockTransaction": {
                "quantityUsed": 1,
                "resourceID": 105,
                "resourceName": "Ian Suggett",
                "employeeRef": "" 
              } 
            } 
          } 
        },
        "attributes": {
          "attribute": [
            {
              "id": 367,
              "name": "Have you added notes to your Job?",
              "value": true,
              "attributeGroup": "Notes Added",
              "attributeGroupId": 50 
            },
            {
              "id": 373,
              "name": "Location",
              "value": "kitchen",
              "attributeGroup": "Appliance",
              "attributeGroupId": 68 
            } 
          ] 
        } 
      } 
    },
    "result_msg": "" 
  }
}



Field Notes

eventCount - the number of events of this type that are currently (at time API is called) recorded against the job - if a Note has also been recorded against the event it will be the count of the number of events of this type with this note ID that have been recorded against the job.


See the Workflow API matrix for the full list of endpoints in this category.