Users Web Service

Users

Click here for a complete list of operations.

AddAndRegisterStudent_Portal

Adds AND Registers a student to Foliotek. Use this overload if you have a portal you will be logging students in with. Returns a string array, [0] is the userid for the student, [1] is an access key that can be used to log them in immediately. Requires WSE 3.0 Authentication.

Test

The test form is only available for requests from the local machine.

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 /Version1/Users.asmx HTTP/1.1
Host: webservices.foliotek.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://wsdev.foliotek.com/Version1/AddAndRegisterStudent_Portal"

<?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>
    <AddAndRegisterStudent_Portal xmlns="http://wsdev.foliotek.com/Version1/">
      <StudentNumber>string</StudentNumber>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <MiddleName>string</MiddleName>
      <Email>string</Email>
      <AltEmail>string</AltEmail>
      <ExternalUserName>string</ExternalUserName>
      <Length>int</Length>
      <GroupCode>string</GroupCode>
      <StorageLimitMB>int</StorageLimitMB>
      <TimeZone>string</TimeZone>
    </AddAndRegisterStudent_Portal>
  </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>
    <AddAndRegisterStudent_PortalResponse xmlns="http://wsdev.foliotek.com/Version1/">
      <AddAndRegisterStudent_PortalResult>
        <string>string</string>
        <string>string</string>
      </AddAndRegisterStudent_PortalResult>
    </AddAndRegisterStudent_PortalResponse>
  </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 /Version1/Users.asmx HTTP/1.1
Host: webservices.foliotek.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>
    <AddAndRegisterStudent_Portal xmlns="http://wsdev.foliotek.com/Version1/">
      <StudentNumber>string</StudentNumber>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <MiddleName>string</MiddleName>
      <Email>string</Email>
      <AltEmail>string</AltEmail>
      <ExternalUserName>string</ExternalUserName>
      <Length>int</Length>
      <GroupCode>string</GroupCode>
      <StorageLimitMB>int</StorageLimitMB>
      <TimeZone>string</TimeZone>
    </AddAndRegisterStudent_Portal>
  </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>
    <AddAndRegisterStudent_PortalResponse xmlns="http://wsdev.foliotek.com/Version1/">
      <AddAndRegisterStudent_PortalResult>
        <string>string</string>
        <string>string</string>
      </AddAndRegisterStudent_PortalResult>
    </AddAndRegisterStudent_PortalResponse>
  </soap12:Body>
</soap12:Envelope>