StarterTemplate ASP.NET Host

<back to all web services

RequestRequirementsAllPost

Requirements service

Returns a list of requirements in a projectThe authenticating user must have the Read privilege for Requirements. This method fully equivalent to GET method, but this one allows you to send large filter string.
Parameters:
NameParameterData TypeRequiredDescription
OffsetqueryintNoThe number of requirements to skip before counting the returned requirements
LimitqueryintNoThe maximum number of requirements to return
ProjectIdpathintYesThe ID of the project that contains requirements

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

HTTP + SOAP12

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

POST /soap12 HTTP/1.1 
Host: rest.qacomplete.smartbear.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

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

    </soap12:Body>
</soap12:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<ResponseRequirementsCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Requirements">
  <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.Requirements" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Common">
    <d2p1:ResponseSingleRequirement>
      <d2p1:ActFinish>0001-01-01T00:00:00</d2p1:ActFinish>
      <d2p1:ActHrs>0</d2p1:ActHrs>
      <d2p1:ActStart>0001-01-01T00:00:00</d2p1:ActStart>
      <d2p1:Active>false</d2p1:Active>
      <d2p1:AssignedToName>String</d2p1:AssignedToName>
      <d2p1:AssigneeUserId>0</d2p1:AssigneeUserId>
      <d2p1:BusinessRule>String</d2p1:BusinessRule>
      <d2p1:Comments>String</d2p1:Comments>
      <d2p1:CustomFields i:nil="true" />
      <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
      <d2p1:DateLastEscalated>0001-01-01T00:00:00</d2p1:DateLastEscalated>
      <d2p1:DateOpened>0001-01-01T00:00:00</d2p1:DateOpened>
      <d2p1:DateUpdated>0001-01-01T00:00:00</d2p1:DateUpdated>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:EstFinish>0001-01-01T00:00:00</d2p1:EstFinish>
      <d2p1:EstHrs>0</d2p1:EstHrs>
      <d2p1:EstHrsRemaining>0</d2p1:EstHrsRemaining>
      <d2p1:EstStart>0001-01-01T00:00:00</d2p1:EstStart>
      <d2p1:FolderId>0</d2p1:FolderId>
      <d2p1:FolderName>String</d2p1:FolderName>
      <d2p1:Grouping>String</d2p1:Grouping>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:ImportId>0</d2p1:ImportId>
      <d2p1:Keywords>String</d2p1:Keywords>
      <d2p1:LastEscalationRule>String</d2p1:LastEscalationRule>
      <d2p1:LastEscalationRuleId>0</d2p1:LastEscalationRuleId>
      <d2p1:NbrEscalations>0</d2p1:NbrEscalations>
      <d2p1:NbrEvents>0</d2p1:NbrEvents>
      <d2p1:NbrFiles>0</d2p1:NbrFiles>
      <d2p1:NbrNotes>0</d2p1:NbrNotes>
      <d2p1:NbrTasks>0</d2p1:NbrTasks>
      <d2p1:NotesDescription>String</d2p1:NotesDescription>
      <d2p1:OpenedBy>0</d2p1:OpenedBy>
      <d2p1:OpenedByCompany>String</d2p1:OpenedByCompany>
      <d2p1:OpenedByEmail>String</d2p1:OpenedByEmail>
      <d2p1:OpenedByName>String</d2p1:OpenedByName>
      <d2p1:OriginalId>0</d2p1:OriginalId>
      <d2p1:OwnerName>String</d2p1:OwnerName>
      <d2p1:OwnerUserId>0</d2p1:OwnerUserId>
      <d2p1:PctComplete>0</d2p1:PctComplete>
      <d2p1:ProjectId>0</d2p1:ProjectId>
      <d2p1:Status>String</d2p1:Status>
      <d2p1:SubGrouping>String</d2p1:SubGrouping>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:UpdateUserId>0</d2p1:UpdateUserId>
      <d2p1:UserName>String</d2p1:UserName>
      <d2p1:__permissions>
        <Acl>0</Acl>
      </d2p1:__permissions>
    </d2p1:ResponseSingleRequirement>
  </Results>
</ResponseRequirementsCollection>

    </soap12:Body>
</soap12:Envelope>