UserInformationLight Web Service

UserInformationLight

Click here for a complete list of operations.

GetDECNSWUserByPortalID

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

<?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>
    <GetDECNSWUserByPortalID xmlns="http://www.doe.edu.au/ls/vle/webservices/">
      <username>string</username>
    </GetDECNSWUserByPortalID>
  </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>
    <GetDECNSWUserByPortalIDResponse xmlns="http://www.doe.edu.au/ls/vle/webservices/">
      <GetDECNSWUserByPortalIDResult>
        <DECUserName>string</DECUserName>
        <NetworkLogin>string</NetworkLogin>
        <GivenName>string</GivenName>
        <Surname>string</Surname>
        <Email>string</Email>
        <Title>string</Title>
        <DisplayName>string</DisplayName>
        <PhoneNumber>string</PhoneNumber>
        <PostCode>string</PostCode>
        <Address>string</Address>
        <IsTeacher>boolean</IsTeacher>
        <IsSchoolBased>boolean</IsSchoolBased>
        <IsStudent>boolean</IsStudent>
        <StaffId>string</StaffId>
        <SchoolId>int</SchoolId>
        <SchoolName>string</SchoolName>
        <DeptId>string</DeptId>
        <DepatName>string</DepatName>
        <IsPrincipal>boolean</IsPrincipal>
        <SimpleDisplayName>string</SimpleDisplayName>
        <SimpleDECUserName>string</SimpleDECUserName>
        <Roles>
          <string>string</string>
          <string>string</string>
        </Roles>
        <Path>string</Path>
        <Groups>
          <string>string</string>
          <string>string</string>
        </Groups>
        <MemberOf>
          <string>string</string>
          <string>string</string>
        </MemberOf>
        <AdditionalInfo>string</AdditionalInfo>
        <IsInvalid>boolean</IsInvalid>
      </GetDECNSWUserByPortalIDResult>
    </GetDECNSWUserByPortalIDResponse>
  </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>
    <GetDECNSWUserByPortalID xmlns="http://www.doe.edu.au/ls/vle/webservices/">
      <username>string</username>
    </GetDECNSWUserByPortalID>
  </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>
    <GetDECNSWUserByPortalIDResponse xmlns="http://www.doe.edu.au/ls/vle/webservices/">
      <GetDECNSWUserByPortalIDResult>
        <DECUserName>string</DECUserName>
        <NetworkLogin>string</NetworkLogin>
        <GivenName>string</GivenName>
        <Surname>string</Surname>
        <Email>string</Email>
        <Title>string</Title>
        <DisplayName>string</DisplayName>
        <PhoneNumber>string</PhoneNumber>
        <PostCode>string</PostCode>
        <Address>string</Address>
        <IsTeacher>boolean</IsTeacher>
        <IsSchoolBased>boolean</IsSchoolBased>
        <IsStudent>boolean</IsStudent>
        <StaffId>string</StaffId>
        <SchoolId>int</SchoolId>
        <SchoolName>string</SchoolName>
        <DeptId>string</DeptId>
        <DepatName>string</DepatName>
        <IsPrincipal>boolean</IsPrincipal>
        <SimpleDisplayName>string</SimpleDisplayName>
        <SimpleDECUserName>string</SimpleDECUserName>
        <Roles>
          <string>string</string>
          <string>string</string>
        </Roles>
        <Path>string</Path>
        <Groups>
          <string>string</string>
          <string>string</string>
        </Groups>
        <MemberOf>
          <string>string</string>
          <string>string</string>
        </MemberOf>
        <AdditionalInfo>string</AdditionalInfo>
        <IsInvalid>boolean</IsInvalid>
      </GetDECNSWUserByPortalIDResult>
    </GetDECNSWUserByPortalIDResponse>
  </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/GetDECNSWUserByPortalID?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"?>
<DECUser xmlns="http://www.doe.edu.au/ls/vle/webservices/">
  <DECUserName>string</DECUserName>
  <NetworkLogin>string</NetworkLogin>
  <GivenName>string</GivenName>
  <Surname>string</Surname>
  <Email>string</Email>
  <Title>string</Title>
  <DisplayName>string</DisplayName>
  <PhoneNumber>string</PhoneNumber>
  <PostCode>string</PostCode>
  <Address>string</Address>
  <IsTeacher>boolean</IsTeacher>
  <IsSchoolBased>boolean</IsSchoolBased>
  <IsStudent>boolean</IsStudent>
  <StaffId>string</StaffId>
  <SchoolId>int</SchoolId>
  <SchoolName>string</SchoolName>
  <DeptId>string</DeptId>
  <DepatName>string</DepatName>
  <IsPrincipal>boolean</IsPrincipal>
  <SimpleDisplayName>string</SimpleDisplayName>
  <SimpleDECUserName>string</SimpleDECUserName>
  <Roles>
    <string>string</string>
    <string>string</string>
  </Roles>
  <Path>string</Path>
  <Groups>
    <string>string</string>
    <string>string</string>
  </Groups>
  <MemberOf>
    <string>string</string>
    <string>string</string>
  </MemberOf>
  <AdditionalInfo>string</AdditionalInfo>
  <IsInvalid>boolean</IsInvalid>
</DECUser>

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/GetDECNSWUserByPortalID 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"?>
<DECUser xmlns="http://www.doe.edu.au/ls/vle/webservices/">
  <DECUserName>string</DECUserName>
  <NetworkLogin>string</NetworkLogin>
  <GivenName>string</GivenName>
  <Surname>string</Surname>
  <Email>string</Email>
  <Title>string</Title>
  <DisplayName>string</DisplayName>
  <PhoneNumber>string</PhoneNumber>
  <PostCode>string</PostCode>
  <Address>string</Address>
  <IsTeacher>boolean</IsTeacher>
  <IsSchoolBased>boolean</IsSchoolBased>
  <IsStudent>boolean</IsStudent>
  <StaffId>string</StaffId>
  <SchoolId>int</SchoolId>
  <SchoolName>string</SchoolName>
  <DeptId>string</DeptId>
  <DepatName>string</DepatName>
  <IsPrincipal>boolean</IsPrincipal>
  <SimpleDisplayName>string</SimpleDisplayName>
  <SimpleDECUserName>string</SimpleDECUserName>
  <Roles>
    <string>string</string>
    <string>string</string>
  </Roles>
  <Path>string</Path>
  <Groups>
    <string>string</string>
    <string>string</string>
  </Groups>
  <MemberOf>
    <string>string</string>
    <string>string</string>
  </MemberOf>
  <AdditionalInfo>string</AdditionalInfo>
  <IsInvalid>boolean</IsInvalid>
</DECUser>

Parameter	Value
username: