GET api/v3/Notes/GetNote?noteId={noteId}

Gets a specific note by it's Id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
noteId

Integer note Identifier

integer

Required

Body Parameters

None.

Response Information

Resource Description

NotesResult object populated with note information from the system.

NotesResultV3
NameDescriptionTypeAdditional information
Nid

Note Identificaiton number

integer

None.

Uid

UserId of the user who added the note

string

None.

Ttl

The Title of the note

string

None.

Bdy

The Body of the Note (may contain HTML)

string

None.

Clr

The category color of the note

string

None.

Cat

The notes category

string

None.

Exp

When the note may expire

date

None.

Adn

When the note was added on

date

None.

Response Formats

application/json

Sample:
{
  "Nid": 1,
  "Uid": "sample string 2",
  "Ttl": "sample string 3",
  "Bdy": "sample string 4",
  "Clr": "sample string 5",
  "Cat": "sample string 6",
  "Exp": "2017-12-14T00:24:44.4771829+00:00",
  "Adn": "2017-12-14T00:24:44.4771829+00:00"
}

application/xml, text/xml

Sample:
<NotesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Notes">
  <Adn>2017-12-14T00:24:44.4771829+00:00</Adn>
  <Bdy>sample string 4</Bdy>
  <Cat>sample string 6</Cat>
  <Clr>sample string 5</Clr>
  <Exp>2017-12-14T00:24:44.4771829+00:00</Exp>
  <Nid>1</Nid>
  <Ttl>sample string 3</Ttl>
  <Uid>sample string 2</Uid>
</NotesResult>