WhippleHillService


Click here for a complete list of operations.

roleGet

Returns a cRole object. Requires a rid.

Test

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

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 /api/whipplehillservice.asmx HTTP/1.1
Host: webservice.whipplehill.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://webservice.whipplehill.com/api/roleGet"

<?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:Header>
    <AuthHeader xmlns="http://webservice.whipplehill.com/api/">
      <Schoolname>string</Schoolname>
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <roleGet xmlns="http://webservice.whipplehill.com/api/">
      <rid>int</rid>
    </roleGet>
  </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>
    <roleGetResponse xmlns="http://webservice.whipplehill.com/api/">
      <roleGetResult>
        <_status>
          <detail>
            <ErrorDetail xsi:nil="true" />
            <ErrorDetail xsi:nil="true" />
          </detail>
          <bln_Success>boolean</bln_Success>
        </_status>
        <_data>
          <anyType />
          <anyType />
        </_data>
      </roleGetResult>
    </roleGetResponse>
  </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 /api/whipplehillservice.asmx HTTP/1.1
Host: webservice.whipplehill.com
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:Header>
    <AuthHeader xmlns="http://webservice.whipplehill.com/api/">
      <Schoolname>string</Schoolname>
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <roleGet xmlns="http://webservice.whipplehill.com/api/">
      <rid>int</rid>
    </roleGet>
  </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>
    <roleGetResponse xmlns="http://webservice.whipplehill.com/api/">
      <roleGetResult>
        <_status>
          <detail>
            <ErrorDetail xsi:nil="true" />
            <ErrorDetail xsi:nil="true" />
          </detail>
          <bln_Success>boolean</bln_Success>
        </_status>
        <_data>
          <anyType />
          <anyType />
        </_data>
      </roleGetResult>
    </roleGetResponse>
  </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 /api/whipplehillservice.asmx/roleGet?rid=string HTTP/1.1
Host: webservice.whipplehill.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<rtnObject xmlns="http://webservice.whipplehill.com/api/">
  <_status>
    <detail>
      <ErrorDetail>
        <code>string</code>
        <desc>string</desc>
      </ErrorDetail>
      <ErrorDetail>
        <code>string</code>
        <desc>string</desc>
      </ErrorDetail>
    </detail>
    <bln_Success>boolean</bln_Success>
  </_status>
  <_data>
    <anyType />
    <anyType />
  </_data>
</rtnObject>

HTTP POST

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

POST /api/whipplehillservice.asmx/roleGet HTTP/1.1
Host: webservice.whipplehill.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<rtnObject xmlns="http://webservice.whipplehill.com/api/">
  <_status>
    <detail>
      <ErrorDetail>
        <code>string</code>
        <desc>string</desc>
      </ErrorDetail>
      <ErrorDetail>
        <code>string</code>
        <desc>string</desc>
      </ErrorDetail>
    </detail>
    <bln_Success>boolean</bln_Success>
  </_status>
  <_data>
    <anyType />
    <anyType />
  </_data>
</rtnObject>