Groups


Click here for a complete list of operations.

CreateGroup

Creates a new group and returns the groupID of said group.

Parameters:
long wsid : Creator (and future owner) of a new group
string pw : Password of said user
string groupName : Unique name of group. A-Z0-9 only please.
string description : Optional description of the new group.

Output:
long : A unique identifier for the newly created group, also known as GroupID or just gid.

Test

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

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: ps1.pha.jhu.edu
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://Services.Cas.jhu.edu/CreateGroup"

<?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>
    <CreateGroup xmlns="http://Services.Cas.jhu.edu">
      <wsid>long</wsid>
      <pw>string</pw>
      <groupName>string</groupName>
      <description>string</description>
    </CreateGroup>
  </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>
    <CreateGroupResponse xmlns="http://Services.Cas.jhu.edu">
      <CreateGroupResult>long</CreateGroupResult>
    </CreateGroupResponse>
  </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: ps1.pha.jhu.edu
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>
    <CreateGroup xmlns="http://Services.Cas.jhu.edu">
      <wsid>long</wsid>
      <pw>string</pw>
      <groupName>string</groupName>
      <description>string</description>
    </CreateGroup>
  </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>
    <CreateGroupResponse xmlns="http://Services.Cas.jhu.edu">
      <CreateGroupResult>long</CreateGroupResult>
    </CreateGroupResponse>
  </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/CreateGroup?wsid=string&pw=string&groupName=string&description=string HTTP/1.1
Host: ps1.pha.jhu.edu

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

<?xml version="1.0" encoding="utf-8"?>
<long xmlns="http://Services.Cas.jhu.edu">long</long>

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/CreateGroup HTTP/1.1
Host: ps1.pha.jhu.edu
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<long xmlns="http://Services.Cas.jhu.edu">long</long>