GET api/ServiceTicketNote/{id}

Returns a specific Service Ticket Note record by NoteID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

ServiceTicketNote
NameDescriptionTypeAdditional information
NoteId

Sedona internal autonumber for the SV_Service_Ticket_Notes record (assigned automatically on POST)

integer

None.

ServiceTicketNumber

Ticket_Number from SV_Service_Ticket table

integer

Required

Note

The note text, limited to 1024 characters

string

Required

String length: inclusive between 0 and 1024

AccessLevel

Allowed values: 1 = viewed by all, including customers, 2 = viewed by office users, 3 = highest level of security; defaults to 2 if not supplied

integer

None.

UserCode

The user making this change; defaults to UserCode value from config file if not set explicitly

string

String length: inclusive between 0 and 30

IsResolution

Defaults to False; True if this is the Resolution note; if True, there must be an existing Service Ticket Dispatch record that is resolved

boolean

None.

CreationDate

Date the note was created; only used for GET calls; value set on server when note is created

date

None.

Response Formats

application/json, text/json

Sample:
{
  "NoteId": 1,
  "ServiceTicketNumber": 2,
  "Note": "sample string 3",
  "AccessLevel": 1,
  "UserCode": "sample string 4",
  "IsResolution": true,
  "CreationDate": "2018-07-20T15:56:08.5392599-04:00"
}

application/xml, text/xml

Sample:
<ServiceTicketNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <AccessLevel>1</AccessLevel>
  <CreationDate>2018-07-20T15:56:08.5392599-04:00</CreationDate>
  <IsResolution>true</IsResolution>
  <Note>sample string 3</Note>
  <NoteId>1</NoteId>
  <ServiceTicketNumber>2</ServiceTicketNumber>
  <UserCode>sample string 4</UserCode>
</ServiceTicketNote>