Groups


Click here for a complete list of operations.

GetGroups

Returns a list of all groups 'wsid' is a member of.
If 'wsid' has the admin priv, returns a list of all groups.

Parameters:
long wsid : User who is calling this method.
string pw : Password of said user.

Output:
Group[] : An array of relevant groups.

A Group object contains:
string Name : The name of the group.
string Description : A description of the group.
long Owner : The owner of this group.
long GID : A unique identifier for this group.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
wsid:
pw:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /casjobs/services/groups.asmx HTTP/1.1
Host: nadc.china-vo.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://Services.Cas.jhu.edu/GetGroups"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetGroups xmlns="http://Services.Cas.jhu.edu">
      <wsid>long</wsid>
      <pw>string</pw>
    </GetGroups>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetGroupsResponse xmlns="http://Services.Cas.jhu.edu">
      <GetGroupsResult>
        <Group>
          <Name>string</Name>
          <Description>string</Description>
          <AdminID>string</AdminID>
          <Owner>long</Owner>
          <GID>long</GID>
          <UserIsMember>boolean</UserIsMember>
        </Group>
        <Group>
          <Name>string</Name>
          <Description>string</Description>
          <AdminID>string</AdminID>
          <Owner>long</Owner>
          <GID>long</GID>
          <UserIsMember>boolean</UserIsMember>
        </Group>
      </GetGroupsResult>
    </GetGroupsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /casjobs/services/groups.asmx HTTP/1.1
Host: nadc.china-vo.org
Content-Type: application/soap+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>
    <GetGroups xmlns="http://Services.Cas.jhu.edu">
      <wsid>long</wsid>
      <pw>string</pw>
    </GetGroups>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+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>
    <GetGroupsResponse xmlns="http://Services.Cas.jhu.edu">
      <GetGroupsResult>
        <Group>
          <Name>string</Name>
          <Description>string</Description>
          <AdminID>string</AdminID>
          <Owner>long</Owner>
          <GID>long</GID>
          <UserIsMember>boolean</UserIsMember>
        </Group>
        <Group>
          <Name>string</Name>
          <Description>string</Description>
          <AdminID>string</AdminID>
          <Owner>long</Owner>
          <GID>long</GID>
          <UserIsMember>boolean</UserIsMember>
        </Group>
      </GetGroupsResult>
    </GetGroupsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /casjobs/services/groups.asmx/GetGroups?wsid=string&pw=string HTTP/1.1
Host: nadc.china-vo.org
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfGroup xmlns="http://Services.Cas.jhu.edu">
  <Group>
    <Name>string</Name>
    <Description>string</Description>
    <AdminID>string</AdminID>
    <Owner>long</Owner>
    <GID>long</GID>
    <UserIsMember>boolean</UserIsMember>
  </Group>
  <Group>
    <Name>string</Name>
    <Description>string</Description>
    <AdminID>string</AdminID>
    <Owner>long</Owner>
    <GID>long</GID>
    <UserIsMember>boolean</UserIsMember>
  </Group>
</ArrayOfGroup>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /casjobs/services/groups.asmx/GetGroups HTTP/1.1
Host: nadc.china-vo.org
Content-Type: application/x-www-form-urlencoded
Content-Length: length

wsid=string&pw=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfGroup xmlns="http://Services.Cas.jhu.edu">
  <Group>
    <Name>string</Name>
    <Description>string</Description>
    <AdminID>string</AdminID>
    <Owner>long</Owner>
    <GID>long</GID>
    <UserIsMember>boolean</UserIsMember>
  </Group>
  <Group>
    <Name>string</Name>
    <Description>string</Description>
    <AdminID>string</AdminID>
    <Owner>long</Owner>
    <GID>long</GID>
    <UserIsMember>boolean</UserIsMember>
  </Group>
</ArrayOfGroup>