Groups


Click here for a complete list of operations.

InviteToGroup

Invites a target user to join the given group.
Target user is not an official member of the group until the invitation is accepted.
Only a groups owner (creator) may invite other users to said group.
This method has no output.

Parameters:
long group_owner : wsid of the owner of the group to which a user is being invited
string pw : Password of said user
long user_wsid : wsid of user who is to be invited to group_id
long group_id : Group identifier (GID) of group to which user_wsid is being invited

Output:
Void

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
group_owner:
group_owner_pw:
user_wsid:
group_id:

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/InviteToGroup"

<?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>
    <InviteToGroup xmlns="http://Services.Cas.jhu.edu">
      <group_owner>long</group_owner>
      <group_owner_pw>string</group_owner_pw>
      <user_wsid>long</user_wsid>
      <group_id>long</group_id>
    </InviteToGroup>
  </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>
    <InviteToGroupResponse xmlns="http://Services.Cas.jhu.edu" />
  </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>
    <InviteToGroup xmlns="http://Services.Cas.jhu.edu">
      <group_owner>long</group_owner>
      <group_owner_pw>string</group_owner_pw>
      <user_wsid>long</user_wsid>
      <group_id>long</group_id>
    </InviteToGroup>
  </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>
    <InviteToGroupResponse xmlns="http://Services.Cas.jhu.edu" />
  </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/InviteToGroup?group_owner=string&group_owner_pw=string&user_wsid=string&group_id=string HTTP/1.1
Host: ps1.pha.jhu.edu

HTTP/1.1 200 OK

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

group_owner=string&group_owner_pw=string&user_wsid=string&group_id=string
HTTP/1.1 200 OK