CollegeSource_WSAPI_Basic


Click here for a complete list of operations.

GetUsers

Get users.
>> Parameter Guide

Test

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

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 /CollegeSource_WSAPI_Basic.asmx HTTP/1.1
Host: bws.collegesource.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://bws.collegesource.com/GetUsers"

<?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>
    <GetUsers xmlns="https://bws.collegesource.com">
      <AccessKeyID>string</AccessKeyID>
    </GetUsers>
  </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>
    <GetUsersResponse xmlns="https://bws.collegesource.com">
      <GetUsersResult>
        <User>
          <ContactID>string</ContactID>
          <NameFirst>string</NameFirst>
          <NameLast>string</NameLast>
          <JobTitle>string</JobTitle>
          <Administrator>boolean</Administrator>
          <ServiceEvaluation>boolean</ServiceEvaluation>
          <ManageEvaluation>boolean</ManageEvaluation>
          <CreateEquivalency>boolean</CreateEquivalency>
        </User>
        <User>
          <ContactID>string</ContactID>
          <NameFirst>string</NameFirst>
          <NameLast>string</NameLast>
          <JobTitle>string</JobTitle>
          <Administrator>boolean</Administrator>
          <ServiceEvaluation>boolean</ServiceEvaluation>
          <ManageEvaluation>boolean</ManageEvaluation>
          <CreateEquivalency>boolean</CreateEquivalency>
        </User>
      </GetUsersResult>
    </GetUsersResponse>
  </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 /CollegeSource_WSAPI_Basic.asmx HTTP/1.1
Host: bws.collegesource.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:Body>
    <GetUsers xmlns="https://bws.collegesource.com">
      <AccessKeyID>string</AccessKeyID>
    </GetUsers>
  </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>
    <GetUsersResponse xmlns="https://bws.collegesource.com">
      <GetUsersResult>
        <User>
          <ContactID>string</ContactID>
          <NameFirst>string</NameFirst>
          <NameLast>string</NameLast>
          <JobTitle>string</JobTitle>
          <Administrator>boolean</Administrator>
          <ServiceEvaluation>boolean</ServiceEvaluation>
          <ManageEvaluation>boolean</ManageEvaluation>
          <CreateEquivalency>boolean</CreateEquivalency>
        </User>
        <User>
          <ContactID>string</ContactID>
          <NameFirst>string</NameFirst>
          <NameLast>string</NameLast>
          <JobTitle>string</JobTitle>
          <Administrator>boolean</Administrator>
          <ServiceEvaluation>boolean</ServiceEvaluation>
          <ManageEvaluation>boolean</ManageEvaluation>
          <CreateEquivalency>boolean</CreateEquivalency>
        </User>
      </GetUsersResult>
    </GetUsersResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP POST

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

POST /CollegeSource_WSAPI_Basic.asmx/GetUsers HTTP/1.1
Host: bws.collegesource.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfUser xmlns="https://bws.collegesource.com">
  <User>
    <ContactID>string</ContactID>
    <NameFirst>string</NameFirst>
    <NameLast>string</NameLast>
    <JobTitle>string</JobTitle>
    <Administrator>boolean</Administrator>
    <ServiceEvaluation>boolean</ServiceEvaluation>
    <ManageEvaluation>boolean</ManageEvaluation>
    <CreateEquivalency>boolean</CreateEquivalency>
  </User>
  <User>
    <ContactID>string</ContactID>
    <NameFirst>string</NameFirst>
    <NameLast>string</NameLast>
    <JobTitle>string</JobTitle>
    <Administrator>boolean</Administrator>
    <ServiceEvaluation>boolean</ServiceEvaluation>
    <ManageEvaluation>boolean</ManageEvaluation>
    <CreateEquivalency>boolean</CreateEquivalency>
  </User>
</ArrayOfUser>