GET api/Tickets/GetTicketUserMessage/{id}?plainTextOnly={plainTextOnly}

Gets the Ticket User Message.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Id of the message	integer	Required
plainTextOnly	If true, the message's .Body attribute will contain plaintext format even if .Html attribute is true	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

TicketUserMessage

Name	Description	Type	Additional information
Id	The message Id	integer	None.
CreatedUTC	The creation time of the message in UTC	date	None.
FirstMessage	If true, the message is the first (typed in the new ticket form)	boolean	None.
UserFullName	DEPRECATED. The fullname of the author of the message	string	None.
UserProviderKey	DEPRECATED. User Id of the author of the message	string	None.
UserNoteBesideName	DEPRECATED. The note beside the name of the author	string	None.
Html	If true, the message contains HTML	boolean	None.
Body	The message in plaintext or HTML	string	None.
Edited	If true, the message has been edited	boolean	None.
EditedTimeUTC	The editing time of the message in UTC	date	None.
BodyOriginal	The original message before editing in plain text	string	None.
BodyHtmlOriginal	The original message before editing in HTML	string	None.
Deleted	If true, the message has been deleted	boolean	None.
Private	If true, the message is private and should not be seen by the ticket's requester	boolean	None.
IsMobileDevice	If true, the message has been sent using mobile device	boolean	None.
Attachments	The list of attachments in the message	Collection of Attachment	None.
HtmlBodyContainsMedia	If true, the media (image, video, audio) is detected inside the html body	boolean	None.
CanEdit	If true user can edit the message	boolean	None.
CanDelete	If false user can delete the message	boolean	None.
CanSplit	If true user can split the ticket	boolean	None.
User	User who created the ticket message	UserData	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 6254,
  "CreatedUTC": "2024-12-22T00:30:08.4307421Z",
  "FirstMessage": false,
  "UserFullName": "Jane Doe",
  "UserProviderKey": "85d31f0a-377d-4b70-9cb5-b6a3c023c6f6",
  "UserNoteBesideName": "secretary director",
  "Html": true,
  "Body": "<p>Hello, I have one snapshot related to my problem, here it is:</p><p><img src=\"data:image/png;base64,.........\"/></p>",
  "Edited": false,
  "EditedTimeUTC": null,
  "BodyOriginal": null,
  "BodyHtmlOriginal": null,
  "Deleted": false,
  "Private": false,
  "IsMobileDevice": false,
  "Attachments": null,
  "HtmlBodyContainsMedia": true,
  "CanEdit": true,
  "CanDelete": true,
  "CanSplit": false,
  "User": {
    "Color": "#8D6CAB",
    "Initials": "JD",
    "PhotoLastUpdatedUtc": null,
    "FullName": "Jane Doe",
    "UserProviderKey": "80dea6c5-173b-4922-acd5-915bb772e1a9",
    "NoteBesideName": "secretary director"
  }
}

application/xml, text/xml

Sample:

<GetTicketResult.TicketUserMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <Attachments i:nil="true" />
  <Body>&lt;p&gt;Hello, I have one snapshot related to my problem, here it is:&lt;/p&gt;&lt;p&gt;&lt;img src="data:image/png;base64,........."/&gt;&lt;/p&gt;</Body>
  <BodyHtmlOriginal i:nil="true" />
  <BodyOriginal i:nil="true" />
  <CanDelete>true</CanDelete>
  <CanEdit>true</CanEdit>
  <CanSplit>false</CanSplit>
  <CreatedUTC>2024-12-22T00:30:08.4307421Z</CreatedUTC>
  <Deleted>false</Deleted>
  <Edited>false</Edited>
  <EditedTimeUTC i:nil="true" />
  <FirstMessage>false</FirstMessage>
  <Html>true</Html>
  <HtmlBodyContainsMedia>true</HtmlBodyContainsMedia>
  <Id>6254</Id>
  <IsMobileDevice>false</IsMobileDevice>
  <Private>false</Private>
  <User>
    <Color>#8D6CAB</Color>
    <FullName>Jane Doe</FullName>
    <Initials>JD</Initials>
    <NoteBesideName>secretary director</NoteBesideName>
    <PhotoLastUpdatedUtc i:nil="true" />
    <UserProviderKey>80dea6c5-173b-4922-acd5-915bb772e1a9</UserProviderKey>
  </User>
  <UserFullName>Jane Doe</UserFullName>
  <UserNoteBesideName>secretary director</UserNoteBesideName>
  <UserProviderKey>85d31f0a-377d-4b70-9cb5-b6a3c023c6f6</UserProviderKey>
</GetTicketResult.TicketUserMessage>