jobEventsXmlV2

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"              eventRecordedBy="IT-Admin"
             eventDateTime="12/07/2011 12:34:34" 
             eventRef="BDH6" 
             eventDescription="move"             
             eventNotes="notes"             eventNoteDescription="note desc"             ownerName="ITAdmin"             ownerEmail="email"
             siteRef="abc123"
             siteName="14 New Street"
             workLogType="23"
             jobClientRef="hfhei"
             workTypeCode="CYCL"
             serviceDescription="Electrical"
             priorityRef="M34"
             supplierName="Direct Team"
             supplierEmail="DirectEmail"
             jobDescription="fix tap"
             jobStatus="In Progress"
             siteConsiderations="dkjf"
             contactSal="Mr"
             contactForename="Bob"
             contactSurname="Smith"
             contactPreferred="07845 377899"
             appointmentId="2343"
             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 libraryActivityCode="fbfdjj" activityRef"dd" description="fix tap" quantity="2" />
             </activities>
               <appointments>
                   <appointment ref="abjdjd"                                 status="5"                                 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"
                                dayDivision="AM" />               </appointments>               <jobCosts>
                    <jobCost jobCostId="500"                              jobCostRef="null"                              description="description"                                 activityCode="abc" 
                             supplier=""                              resource=""                              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>
                <attributes>
                    <attribute name="Issue Date" value="12/12/2009 12:34:56"/>
                </attributes>
        </job>    </jobs>
</root>

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