POST api/Note

Get a note based on task id and note id

Request Information

URI Parameters

None.

Body Parameters

NoteBinder
NameDescriptionTypeAdditional information
NoteId

integer

None.

ProjectId

integer

None.

TaskId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "NoteId": 1,
  "ProjectId": 2,
  "TaskId": 3
}

application/xml, text/xml

Sample:
<NoteBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <ProjectId>2</ProjectId>
  <TaskId>3</TaskId>
  <NoteId>1</NoteId>
</NoteBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Get a note based on task id and note id

API_Data_NoteModel
NameDescriptionTypeAdditional information
Success

boolean

None.

Error

ErrorInfo

None.

Data

NoteModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": {
    "ProjectID": 1,
    "BugID": 2,
    "NoteID": 3,
    "ProblemID": "sample string 4",
    "NoteType": "sample string 5",
    "DateCreated": "2020-12-03 18:41:48",
    "CreatedByPersonID": 1,
    "AttachedFileName": "sample string 6",
    "EMailStatusID": 1,
    "IsPublished": true,
    "NoteTitle": "sample string 8",
    "AttachType": 1,
    "CategoryID": 1,
    "AttachFileID": 1,
    "AttachedProjectID": 1,
    "AvailableToWeb": 1,
    "NoteTypeID": 1,
    "AttachedVersionNo": 1,
    "IfClosed": 1,
    "DateModified": "2020-12-03 18:41:48",
    "ModifiedByPersonID": 1,
    "BugNotesUcd": "sample string 9",
    "BugNotes": "sample string 10",
    "ParentID": 1,
    "ReplyUserID": 1,
    "ReferredByKWLink": 1,
    "CreatedByPersonName": "sample string 11",
    "ModifiedByPersonName": "sample string 12",
    "ReplyUserName": "sample string 13",
    "BugNoteHtml": "sample string 14"
  }
}

application/xml, text/xml

Sample:
<API_Data_NoteModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Entities">
    <d2p1:AttachFileID>1</d2p1:AttachFileID>
    <d2p1:AttachType>1</d2p1:AttachType>
    <d2p1:AttachedFileName>sample string 6</d2p1:AttachedFileName>
    <d2p1:AttachedProjectID>1</d2p1:AttachedProjectID>
    <d2p1:AttachedVersionNo>1</d2p1:AttachedVersionNo>
    <d2p1:AvailableToWeb>1</d2p1:AvailableToWeb>
    <d2p1:BugID>2</d2p1:BugID>
    <d2p1:BugNoteHtml>sample string 14</d2p1:BugNoteHtml>
    <d2p1:BugNotes>sample string 10</d2p1:BugNotes>
    <d2p1:BugNotesUcd>sample string 9</d2p1:BugNotesUcd>
    <d2p1:CategoryID>1</d2p1:CategoryID>
    <d2p1:CreatedByPersonID>1</d2p1:CreatedByPersonID>
    <d2p1:CreatedByPersonName>sample string 11</d2p1:CreatedByPersonName>
    <d2p1:DateCreated>2020-12-03T18:41:48.4665445-08:00</d2p1:DateCreated>
    <d2p1:DateModified>2020-12-03T18:41:48.4665445-08:00</d2p1:DateModified>
    <d2p1:EMailStatusID>1</d2p1:EMailStatusID>
    <d2p1:IfClosed>1</d2p1:IfClosed>
    <d2p1:IsPublished>true</d2p1:IsPublished>
    <d2p1:ModifiedByPersonID>1</d2p1:ModifiedByPersonID>
    <d2p1:ModifiedByPersonName>sample string 12</d2p1:ModifiedByPersonName>
    <d2p1:NoteID>3</d2p1:NoteID>
    <d2p1:NoteTitle>sample string 8</d2p1:NoteTitle>
    <d2p1:NoteType>sample string 5</d2p1:NoteType>
    <d2p1:NoteTypeID>1</d2p1:NoteTypeID>
    <d2p1:ParentID>1</d2p1:ParentID>
    <d2p1:ProblemID>sample string 4</d2p1:ProblemID>
    <d2p1:ProjectID>1</d2p1:ProjectID>
    <d2p1:ReferredByKWLink>1</d2p1:ReferredByKWLink>
    <d2p1:ReplyUserID>1</d2p1:ReplyUserID>
    <d2p1:ReplyUserName>sample string 13</d2p1:ReplyUserName>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_NoteModel>