StarterTemplate ASP.NET Host

<back to all web services

RequestSecurityGroupsAll

Security groups service

The following routes are available for this service:
GET/service/api/v1/depts/{DeptId}/securitygroupsReturns list with names of security groups in the specified department
Parameters:
NameParameterData TypeRequiredDescription
OffsetqueryintNoThe number of security groups to skip before counting the returned security groups
LimitqueryintNoThe maximum number of security groups to return
DeptIdpathintYesThe ID of the department that includes security groups
FilterquerystringNoThe filter expression to apply to the list of security groups

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

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

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

<ResponseSecurityGroupsNamesCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.SecurityGroup">
  <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.SecurityGroup" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Common">
    <d2p1:ResponseSingleSecurityGroupName>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:ResponseSingleSecurityGroupName>
  </Results>
</ResponseSecurityGroupsNamesCollection>