Service Provider API-Guide

Download As PDF

Gets the list of comments associated with a workorder

WorkOrder comments can be pulled sending either WorkOrder Number or WorkOrder ID. Multiple WorkOrders cannot be requested with this.

GET api/WorkOrders/{id}/Comments

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

None

Response Information

Resource Description

Collection of CommentFragment
NameDescriptionTypeAdditional information
Id

integer None.
Subject

string None.
Body

string None.
WorkOrderNumber

string None.
OwnerUserId

integer None.
CreateUser

string None.
CreateDateTime

date None.
AllowInternal

boolean None.
AllowClient

boolean None.
AllowVendor

boolean None.
AllowCorporate

boolean None.
WorkOrderStatusID

integer None.
CommentTypeID

integer None.
IsEmailHighImportance

boolean None.
RequestCodeID

integer None.
User

string None.
Role

string None.
Company

string None.
FirstName

string None.
LastName

string None.
ChildWorkOrderID

integer None.
WorkOrderID

integer None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": 1,
    "Subject": "sample string 2",
    "Body": "sample string 3",
    "WorkOrderNumber": "sample string 4",
    "OwnerUserId": 1,
    "CreateUser": "sample string 5",
    "CreateDateTime": "2025-04-30T02:05:27.147524Z",
    "AllowInternal": true,
    "AllowClient": true,
    "AllowVendor": true,
    "AllowCorporate": true,
    "WorkOrderStatusID": 1,
    "CommentTypeID": 1,
    "IsEmailHighImportance": true,
    "RequestCodeID": 1,
    "User": "sample string 8",
    "Role": "sample string 9",
    "Company": "sample string 10",
    "FirstName": "sample",
    "LastName": "string",
    "ChildWorkOrderID": 1,
    "WorkOrderID": 13
  },
  {
    "Id": 1,
    "Subject": "sample string 2",
    "Body": "sample string 3",
    "WorkOrderNumber": "sample string 4",
    "OwnerUserId": 1,
    "CreateUser": "sample string 5",
    "CreateDateTime": "2025-04-30T02:05:27.147524Z",
    "AllowInternal": true,
    "AllowClient": true,
    "AllowVendor": true,
    "AllowCorporate": true,
    "WorkOrderStatusID": 1,
    "CommentTypeID": 1,
    "IsEmailHighImportance": true,
    "RequestCodeID": 1,
    "User": "sample string 8",
    "Role": "sample string 9",
    "Company": "sample string 10",
    "FirstName": "sample",
    "LastName": "string",
    "ChildWorkOrderID": 1,
    "WorkOrderID": 13
  }
]

application/xml, text/xml

Sample: 
<ArrayOfCommentFragment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlESI.FMPilot.Core.BE.Entities.WorkOrder">
  <CommentFragment>
    <AllowClient>true</AllowClient>
    <AllowCorporate>true</AllowCorporate>
    <AllowInternal>true</AllowInternal>
    <AllowVendor>true</AllowVendor>
    <Body>sample string 3</Body>
    <ChildWorkOrderID>1</ChildWorkOrderID>
    <CommentTypeID>1</CommentTypeID>
    <Company>sample string 10</Company>
    <CreateDateTime>2025-04-30T02:05:27.147524+00:00</CreateDateTime>
    <CreateUser>sample string 5</CreateUser>
    <FirstName>sample</FirstName>
    <Id>1</Id>
    <IsEmailHighImportance>true</IsEmailHighImportance>
    <LastName>string</LastName>
    <OwnerUserId>1</OwnerUserId>
    <RequestCodeID>1</RequestCodeID>
    <Role>sample string 9</Role>
    <Subject>sample string 2</Subject>
    <User>sample string 8</User>
    <WorkOrderID>13</WorkOrderID>
    <WorkOrderNumber>sample string 4</WorkOrderNumber>
    <WorkOrderStatusID>1</WorkOrderStatusID>
  </CommentFragment>
  <CommentFragment>
    <AllowClient>true</AllowClient>
    <AllowCorporate>true</AllowCorporate>
    <AllowInternal>true</AllowInternal>
    <AllowVendor>true</AllowVendor>
    <Body>sample string 3</Body>
    <ChildWorkOrderID>1</ChildWorkOrderID>
    <CommentTypeID>1</CommentTypeID>
    <Company>sample string 10</Company>
    <CreateDateTime>2025-04-30T02:05:27.147524+00:00</CreateDateTime>
    <CreateUser>sample string 5</CreateUser>
    <FirstName>sample</FirstName>
    <Id>1</Id>
    <IsEmailHighImportance>true</IsEmailHighImportance>
    <LastName>string</LastName>
    <OwnerUserId>1</OwnerUserId>
    <RequestCodeID>1</RequestCodeID>
    <Role>sample string 9</Role>
    <Subject>sample string 2</Subject>
    <User>sample string 8</User>
    <WorkOrderID>13</WorkOrderID>
    <WorkOrderNumber>sample string 4</WorkOrderNumber>
    <WorkOrderStatusID>1</WorkOrderStatusID>
  </CommentFragment>
</ArrayOfCommentFragment>