StarterTemplate ASP.NET Host

<back to all web services

RequestProjectUserAll

User service

The following routes are available for this service:
GET/service/api/v1/projects/{ProjectId}/usersGet all users from specified project
Parameters:
NameParameterData TypeRequiredDescription
OffsetqueryintNoThe number of user profiles to skip before counting the returned user profiles
LimitqueryintNoThe maximum number of user profiles to return
FilterquerystringNoThe filter expression to apply to the list of user profiles
ProjectIdpathintYesThe ID of the project that includes user profiles

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/RequestProjectUserAll HTTP/1.1 
Host: rest.qacomplete.smartbear.com 
Content-Type: application/xml
Content-Length: length

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

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

<ResponsePersonsCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Users">
  <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.Users" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Common">
    <d2p1:ResponseSingleUser>
      <d2p1:CellPhone>String</d2p1:CellPhone>
      <d2p1:Comments>String</d2p1:Comments>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
      <d2p1:DateFirstLogon>0001-01-01T00:00:00</d2p1:DateFirstLogon>
      <d2p1:DateLastLogon>0001-01-01T00:00:00</d2p1:DateLastLogon>
      <d2p1:DateUpdated>0001-01-01T00:00:00</d2p1:DateUpdated>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:Fax>String</d2p1:Fax>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Grouping>String</d2p1:Grouping>
      <d2p1:HomePhone>String</d2p1:HomePhone>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:ImportId>0</d2p1:ImportId>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:IsLoggedOn>false</d2p1:IsLoggedOn>
      <d2p1:IsSecurityAdmin>false</d2p1:IsSecurityAdmin>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:MiddleName>String</d2p1:MiddleName>
      <d2p1:NbrTimesLogon>0</d2p1:NbrTimesLogon>
      <d2p1:OtherPhone>String</d2p1:OtherPhone>
      <d2p1:Pager>String</d2p1:Pager>
      <d2p1:PrimaryDeptId>0</d2p1:PrimaryDeptId>
      <d2p1:RemoteUserId>String</d2p1:RemoteUserId>
      <d2p1:SubGrouping>String</d2p1:SubGrouping>
      <d2p1:TimeZoneCode>String</d2p1:TimeZoneCode>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:UpdateUserId>0</d2p1:UpdateUserId>
      <d2p1:UpdateUserName>String</d2p1:UpdateUserName>
      <d2p1:WebSite>String</d2p1:WebSite>
      <d2p1:WorkPhone>String</d2p1:WorkPhone>
    </d2p1:ResponseSingleUser>
  </Results>
</ResponsePersonsCollection>