api_auth

<back to all web services

AccountGroupsRequest

AccountGroupsRequest Parameters:
NameParameterData TypeRequiredDescription
SiteIDquerylong?No
FiltersqueryIList<Filter>No
StartIndexqueryintNo
PerPagequeryintNo
OrderByquerystringNo
IncludeCountqueryboolNo
IncludeDataqueryboolNo
Filter Parameters:
NameParameterData TypeRequiredDescription
IsCustomformboolNo
AccountGroupsResponse Parameters:
NameParameterData TypeRequiredDescription
ItemsformAccountGroupOverview[]No
TotalCountformintNo
AccountGroupOverview Parameters:
NameParameterData TypeRequiredDescription
SiteIDformlongNo
GroupIDformlongNo
NameformstringNo
MailNameformstringNo

To override the Content-type in your clients, use the 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/AccountGroupsRequest HTTP/1.1 
Host: 1.hyper.id 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AccountGroupsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <Filters xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bitpub.Api.Common.Filters" i:nil="true" />
  <IncludeCount>false</IncludeCount>
  <IncludeData>false</IncludeData>
  <OrderBy>String</OrderBy>
  <PerPage>0</PerPage>
  <SiteID>0</SiteID>
  <StartIndex>0</StartIndex>
</AccountGroupsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AccountGroupsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <Items>
    <AccountGroupOverview>
      <GroupID>0</GroupID>
      <MailName>String</MailName>
      <Name>String</Name>
      <SiteID>0</SiteID>
    </AccountGroupOverview>
  </Items>
  <TotalCount>0</TotalCount>
</AccountGroupsResponse>