UserInformationLight Web Service

UserInformationLight

Click here for a complete list of operations.

GetUserByPortalID

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /UserInformationLight.asmx HTTP/1.1
Host: vle-web-services-pre.azurewebsites.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.doe.edu.au/ls/vle/webservices/GetUserByPortalID"

<?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>
    <GetUserByPortalID xmlns="http://www.doe.edu.au/ls/vle/webservices/">
      <username>string</username>
    </GetUserByPortalID>
  </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>
    <GetUserByPortalIDResponse xmlns="http://www.doe.edu.au/ls/vle/webservices/">
      <GetUserByPortalIDResult>
        <UserName>string</UserName>
        <GivenName>string</GivenName>
        <SurName>string</SurName>
        <Email>string</Email>
        <Title>string</Title>
        <DisplayName>string</DisplayName>
        <LocationCode>string</LocationCode>
        <Roles>
          <string>string</string>
          <string>string</string>
        </Roles>
        <Information>string</Information>
        <NetUserId>string</NetUserId>
      </GetUserByPortalIDResult>
    </GetUserByPortalIDResponse>
  </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 /UserInformationLight.asmx HTTP/1.1
Host: vle-web-services-pre.azurewebsites.net
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>
    <GetUserByPortalID xmlns="http://www.doe.edu.au/ls/vle/webservices/">
      <username>string</username>
    </GetUserByPortalID>
  </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>
    <GetUserByPortalIDResponse xmlns="http://www.doe.edu.au/ls/vle/webservices/">
      <GetUserByPortalIDResult>
        <UserName>string</UserName>
        <GivenName>string</GivenName>
        <SurName>string</SurName>
        <Email>string</Email>
        <Title>string</Title>
        <DisplayName>string</DisplayName>
        <LocationCode>string</LocationCode>
        <Roles>
          <string>string</string>
          <string>string</string>
        </Roles>
        <Information>string</Information>
        <NetUserId>string</NetUserId>
      </GetUserByPortalIDResult>
    </GetUserByPortalIDResponse>
  </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 /UserInformationLight.asmx/GetUserByPortalID?username=string HTTP/1.1
Host: vle-web-services-pre.azurewebsites.net

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

<?xml version="1.0" encoding="utf-8"?>
<PortalUser xmlns="http://www.doe.edu.au/ls/vle/webservices/">
  <UserName>string</UserName>
  <GivenName>string</GivenName>
  <SurName>string</SurName>
  <Email>string</Email>
  <Title>string</Title>
  <DisplayName>string</DisplayName>
  <LocationCode>string</LocationCode>
  <Roles>
    <string>string</string>
    <string>string</string>
  </Roles>
  <Information>string</Information>
  <NetUserId>string</NetUserId>
</PortalUser>

HTTP POST

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

POST /UserInformationLight.asmx/GetUserByPortalID HTTP/1.1
Host: vle-web-services-pre.azurewebsites.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

username=string

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

<?xml version="1.0" encoding="utf-8"?>
<PortalUser xmlns="http://www.doe.edu.au/ls/vle/webservices/">
  <UserName>string</UserName>
  <GivenName>string</GivenName>
  <SurName>string</SurName>
  <Email>string</Email>
  <Title>string</Title>
  <DisplayName>string</DisplayName>
  <LocationCode>string</LocationCode>
  <Roles>
    <string>string</string>
    <string>string</string>
  </Roles>
  <Information>string</Information>
  <NetUserId>string</NetUserId>
</PortalUser>

Parameter	Value
username: