GET api/v1/WorkOrders/{WorkOrderID}/Diary

Gather a list of appointments associated to the work order.

Request Information

URI Parameters

Name	Description	Type	Additional information
WorkOrderID	The unique identifier of the work order	integer	Required

Body Parameters

None.

Response Information

Resource Description

A list of appointments

IBMS_Cloud_API.DiaryModel+DiaryFields

Name	Description	Type	Additional information
DiaryID	Unique identifier for a appointment	integer	None.
EmployeeID	Associated employee	integer	None.
AppointmentStatusID	Current status of the appointment	integer	None.
WorkOrderID	Unique identifier for a work order	integer	None.
WOStatusID	Work order status	integer	None.
StartDateTime	Start time of the appointment	date	None.
DiaryNotes	Any notes added to the appointment	string	None.
Status	Status label of the appointment	string	None.
WORef	Reference of the work order	string	None.
WODescription	Description of the work order	string	None.
WODetails	Details of the work order	string	None.
WONotes	Notes of the work order	string	None.
PeriodicalID	Associated contract internal ID	integer	None.
TypeID	The type id of work order	integer	None.
OrderNumber	Associated order number against the work order	string	None.
WOtype	The type of work order label	string	None.
PeriodicalRef	Contract reference associated to the work order	string	None.
SiteName	The site name associated to the work order	string	None.
SiteRef	The site reference associated to the work order	string	None.
AddressLine1	Address line 1 of the associated site	string	None.
AddressLine2	Address line 2 of the associated site	string	None.
AddressLine3	Address line 3 of the associated site	string	None.
CityTown	City / Town of the associated site	string	None.
County	County of the associated site	string	None.
PostCode	Postal code of the associated site	string	None.
SiteID	Internal site ID of the associated work order	integer	None.
Contact1	Contact name of the associated site	string	None.
Phone1	Contact number of the associated site	string	None.
Email	Contact email of the associated site	string	None.
ClientID	Internal client id of the associated work order	integer	None.
ClientName	Client label of the associated work order	string	None.
ClientRef	Client label of the associated work order	string	None.
SupplierName	Supplier associated to the work order	string	None.
SLAhours	SLA of the work order	decimal number	None.
WorkOrderDocs	Documents associated to the work order	string	None.

Response Formats

application/json, text/json

Sample:

{
  "DiaryID": 1,
  "EmployeeID": 2,
  "AppointmentStatusID": 3,
  "WorkOrderID": 4,
  "WOStatusID": 5,
  "StartDateTime": "2025-04-28T15:21:49.1213385+01:00",
  "DiaryNotes": "sample string 7",
  "Status": "sample string 8",
  "WORef": "sample string 9",
  "WODescription": "sample string 10",
  "WODetails": "sample string 11",
  "WONotes": "sample string 12",
  "PeriodicalID": 13,
  "TypeID": 14,
  "OrderNumber": "sample string 15",
  "WOtype": "sample string 16",
  "PeriodicalRef": "sample string 17",
  "SiteName": "sample string 18",
  "SiteRef": "sample string 19",
  "AddressLine1": "sample string 20",
  "AddressLine2": "sample string 21",
  "AddressLine3": "sample string 22",
  "CityTown": "sample string 23",
  "County": "sample string 24",
  "PostCode": "sample string 25",
  "SiteID": 26,
  "Contact1": "sample string 27",
  "Phone1": "sample string 28",
  "Email": "sample string 29",
  "ClientID": 30,
  "ClientName": "sample string 31",
  "ClientRef": "sample string 32",
  "SupplierName": "sample string 33",
  "SLAhours": 34.1,
  "WorkOrderDocs": "sample string 35"
}

text/html

Sample:

{"DiaryID":1,"EmployeeID":2,"AppointmentStatusID":3,"WorkOrderID":4,"WOStatusID":5,"StartDateTime":"2025-04-28T15:21:49.1213385+01:00","DiaryNotes":"sample string 7","Status":"sample string 8","WORef":"sample string 9","WODescription":"sample string 10","WODetails":"sample string 11","WONotes":"sample string 12","PeriodicalID":13,"TypeID":14,"OrderNumber":"sample string 15","WOtype":"sample string 16","PeriodicalRef":"sample string 17","SiteName":"sample string 18","SiteRef":"sample string 19","AddressLine1":"sample string 20","AddressLine2":"sample string 21","AddressLine3":"sample string 22","CityTown":"sample string 23","County":"sample string 24","PostCode":"sample string 25","SiteID":26,"Contact1":"sample string 27","Phone1":"sample string 28","Email":"sample string 29","ClientID":30,"ClientName":"sample string 31","ClientRef":"sample string 32","SupplierName":"sample string 33","SLAhours":34.1,"WorkOrderDocs":"sample string 35"}

application/xml, text/xml

Sample:

<DiaryModel.DiaryFields xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBMS_Cloud_API">
  <AddressLine1>sample string 20</AddressLine1>
  <AddressLine2>sample string 21</AddressLine2>
  <AddressLine3>sample string 22</AddressLine3>
  <AppointmentStatusID>3</AppointmentStatusID>
  <CityTown>sample string 23</CityTown>
  <ClientID>30</ClientID>
  <ClientName>sample string 31</ClientName>
  <ClientRef>sample string 32</ClientRef>
  <Contact1>sample string 27</Contact1>
  <County>sample string 24</County>
  <DiaryID>1</DiaryID>
  <DiaryNotes>sample string 7</DiaryNotes>
  <Email>sample string 29</Email>
  <EmployeeID>2</EmployeeID>
  <OrderNumber>sample string 15</OrderNumber>
  <PeriodicalID>13</PeriodicalID>
  <PeriodicalRef>sample string 17</PeriodicalRef>
  <Phone1>sample string 28</Phone1>
  <PostCode>sample string 25</PostCode>
  <SLAhours>34.1</SLAhours>
  <SiteID>26</SiteID>
  <SiteName>sample string 18</SiteName>
  <SiteRef>sample string 19</SiteRef>
  <StartDateTime>2025-04-28T15:21:49.1213385+01:00</StartDateTime>
  <Status>sample string 8</Status>
  <SupplierName>sample string 33</SupplierName>
  <TypeID>14</TypeID>
  <WODescription>sample string 10</WODescription>
  <WODetails>sample string 11</WODetails>
  <WONotes>sample string 12</WONotes>
  <WORef>sample string 9</WORef>
  <WOStatusID>5</WOStatusID>
  <WOtype>sample string 16</WOtype>
  <WorkOrderDocs>sample string 35</WorkOrderDocs>
  <WorkOrderID>4</WorkOrderID>
</DiaryModel.DiaryFields>