StarterTemplate ASP.NET Host

RequestNotesAll

The following routes are available for this service:
GET	/service/api/v1/projects/{ProjectId}/{EntityCode}/{EntityId}/notes	Returns the list of notes (comments) added to an item	This operation returns notes associated with an entity (item) in QAComplete. The authenticating user must have the Read privilege for the item to which notes belong

Parameters:
Name	Parameter	Data Type	Required	Description
ProjectId	path	int	Yes	The ID of the project that contains the item
EntityCode	path	string	Yes	The type of the item that has notes
EntityId	path	int	Yes	The ID of the item that has notes
Offset	query	int	No	The number of notes to skip before counting the returned notes
Limit	query	int	No	The maximum number of notes to return

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/RequestNotesAll HTTP/1.1 
Host: rest.qacomplete.smartbear.com 
Content-Type: application/xml
Content-Length: length

<RequestNotesAll xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Notes">
  <EntityCode>String</EntityCode>
  <EntityId>0</EntityId>
  <Limit>0</Limit>
  <Offset>0</Offset>
  <ProjectId>0</ProjectId>
</RequestNotesAll>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReponseNotesCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Notes">
  <Metadata i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Common" />
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Notes" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Common">
    <d2p1:ResponseNoteSingle>
      <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
      <d2p1:DateUpdated>0001-01-01T00:00:00</d2p1:DateUpdated>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:EntityCode>String</d2p1:EntityCode>
      <d2p1:EntityId>0</d2p1:EntityId>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:OriginalId>0</d2p1:OriginalId>
      <d2p1:Seq>0</d2p1:Seq>
      <d2p1:UpdateUserId>0</d2p1:UpdateUserId>
      <d2p1:UserName>String</d2p1:UserName>
    </d2p1:ResponseNoteSingle>
  </Results>
</ReponseNotesCollection>