WebService Web Service

WebService

Click here for a complete list of operations.

GetUser

GetUser *DotNetNuke* |IWEB Core| #IWEB Misc# !Portal!

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 /DesktopModules/IWeb/WebService.asmx HTTP/1.1
Host: c21redwood.coachsimple.ai
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://webservices.DotNetNuke.com/GetUser"

<?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>
    <IWebAuthendicationHeader xmlns="http://webservices.DotNetNuke.com/">
      <PortalID>int</PortalID>
      <UserID>int</UserID>
      <Username>string</Username>
      <Password>string</Password>
      <Encrypted>string</Encrypted>
      <WebPageCall>string</WebPageCall>
      <ModuleId>int</ModuleId>
    </IWebAuthendicationHeader>
  </soap:Header>
  <soap:Body>
    <GetUser xmlns="http://webservices.DotNetNuke.com/">
      <Username>string</Username>
    </GetUser>
  </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>
    <GetUserResponse xmlns="http://webservices.DotNetNuke.com/">
      <GetUserResult>
        <AffiliateID>int</AffiliateID>
        <DisplayName>string</DisplayName>
        <Email>string</Email>
        <FirstName>string</FirstName>
        <IsSuperUser>boolean</IsSuperUser>
        <LastName>string</LastName>
        <Membership>
          <Approved>boolean</Approved>
          <CreatedDate>dateTime</CreatedDate>
          <IsOnLine>boolean</IsOnLine>
          <LastActivityDate>dateTime</LastActivityDate>
          <LastLockoutDate>dateTime</LastLockoutDate>
          <LastLoginDate>dateTime</LastLoginDate>
          <LastPasswordChangeDate>dateTime</LastPasswordChangeDate>
          <LockedOut>boolean</LockedOut>
          <ObjectHydrated>boolean</ObjectHydrated>
          <Password>string</Password>
          <PasswordAnswer>string</PasswordAnswer>
          <PasswordQuestion>string</PasswordQuestion>
          <UpdatePassword>boolean</UpdatePassword>
          <Email>string</Email>
          <Username>string</Username>
        </Membership>
        <PortalID>int</PortalID>
        <Profile>
          <Cell>string</Cell>
          <City>string</City>
          <Country>string</Country>
          <Fax>string</Fax>
          <FirstName>string</FirstName>
          <IM>string</IM>
          <LastName>string</LastName>
          <ObjectHydrated>boolean</ObjectHydrated>
          <PostalCode>string</PostalCode>
          <PreferredLocale>string</PreferredLocale>
          <ProfileProperties>
            <ProfilePropertyDefinition xsi:nil="true" />
            <ProfilePropertyDefinition xsi:nil="true" />
          </ProfileProperties>
          <Region>string</Region>
          <Street>string</Street>
          <Telephone>string</Telephone>
          <TimeZone>int</TimeZone>
          <Unit>string</Unit>
          <Website>string</Website>
        </Profile>
        <Roles>
          <string>string</string>
          <string>string</string>
        </Roles>
        <UserID>int</UserID>
        <Username>string</Username>
      </GetUserResult>
    </GetUserResponse>
  </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 /DesktopModules/IWeb/WebService.asmx HTTP/1.1
Host: c21redwood.coachsimple.ai
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>
    <IWebAuthendicationHeader xmlns="http://webservices.DotNetNuke.com/">
      <PortalID>int</PortalID>
      <UserID>int</UserID>
      <Username>string</Username>
      <Password>string</Password>
      <Encrypted>string</Encrypted>
      <WebPageCall>string</WebPageCall>
      <ModuleId>int</ModuleId>
    </IWebAuthendicationHeader>
  </soap12:Header>
  <soap12:Body>
    <GetUser xmlns="http://webservices.DotNetNuke.com/">
      <Username>string</Username>
    </GetUser>
  </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>
    <GetUserResponse xmlns="http://webservices.DotNetNuke.com/">
      <GetUserResult>
        <AffiliateID>int</AffiliateID>
        <DisplayName>string</DisplayName>
        <Email>string</Email>
        <FirstName>string</FirstName>
        <IsSuperUser>boolean</IsSuperUser>
        <LastName>string</LastName>
        <Membership>
          <Approved>boolean</Approved>
          <CreatedDate>dateTime</CreatedDate>
          <IsOnLine>boolean</IsOnLine>
          <LastActivityDate>dateTime</LastActivityDate>
          <LastLockoutDate>dateTime</LastLockoutDate>
          <LastLoginDate>dateTime</LastLoginDate>
          <LastPasswordChangeDate>dateTime</LastPasswordChangeDate>
          <LockedOut>boolean</LockedOut>
          <ObjectHydrated>boolean</ObjectHydrated>
          <Password>string</Password>
          <PasswordAnswer>string</PasswordAnswer>
          <PasswordQuestion>string</PasswordQuestion>
          <UpdatePassword>boolean</UpdatePassword>
          <Email>string</Email>
          <Username>string</Username>
        </Membership>
        <PortalID>int</PortalID>
        <Profile>
          <Cell>string</Cell>
          <City>string</City>
          <Country>string</Country>
          <Fax>string</Fax>
          <FirstName>string</FirstName>
          <IM>string</IM>
          <LastName>string</LastName>
          <ObjectHydrated>boolean</ObjectHydrated>
          <PostalCode>string</PostalCode>
          <PreferredLocale>string</PreferredLocale>
          <ProfileProperties>
            <ProfilePropertyDefinition xsi:nil="true" />
            <ProfilePropertyDefinition xsi:nil="true" />
          </ProfileProperties>
          <Region>string</Region>
          <Street>string</Street>
          <Telephone>string</Telephone>
          <TimeZone>int</TimeZone>
          <Unit>string</Unit>
          <Website>string</Website>
        </Profile>
        <Roles>
          <string>string</string>
          <string>string</string>
        </Roles>
        <UserID>int</UserID>
        <Username>string</Username>
      </GetUserResult>
    </GetUserResponse>
  </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 /DesktopModules/IWeb/WebService.asmx/GetUser?Username=string HTTP/1.1
Host: c21redwood.coachsimple.ai

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

<?xml version="1.0" encoding="utf-8"?>
<UserInfo xmlns="http://webservices.DotNetNuke.com/">
  <AffiliateID>int</AffiliateID>
  <DisplayName>string</DisplayName>
  <Email>string</Email>
  <FirstName>string</FirstName>
  <IsSuperUser>boolean</IsSuperUser>
  <LastName>string</LastName>
  <Membership>
    <Approved>boolean</Approved>
    <CreatedDate>dateTime</CreatedDate>
    <IsOnLine>boolean</IsOnLine>
    <LastActivityDate>dateTime</LastActivityDate>
    <LastLockoutDate>dateTime</LastLockoutDate>
    <LastLoginDate>dateTime</LastLoginDate>
    <LastPasswordChangeDate>dateTime</LastPasswordChangeDate>
    <LockedOut>boolean</LockedOut>
    <ObjectHydrated>boolean</ObjectHydrated>
    <Password>string</Password>
    <PasswordAnswer>string</PasswordAnswer>
    <PasswordQuestion>string</PasswordQuestion>
    <UpdatePassword>boolean</UpdatePassword>
    <Email>string</Email>
    <Username>string</Username>
  </Membership>
  <PortalID>int</PortalID>
  <Profile>
    <Cell>string</Cell>
    <City>string</City>
    <Country>string</Country>
    <Fax>string</Fax>
    <FirstName>string</FirstName>
    <IM>string</IM>
    <LastName>string</LastName>
    <ObjectHydrated>boolean</ObjectHydrated>
    <PostalCode>string</PostalCode>
    <PreferredLocale>string</PreferredLocale>
    <ProfileProperties>
      <ProfilePropertyDefinition>
        <length>int</length>
        <propertycategory>string</propertycategory>
        <propertyname>string</propertyname>
      </ProfilePropertyDefinition>
      <ProfilePropertyDefinition>
        <length>int</length>
        <propertycategory>string</propertycategory>
        <propertyname>string</propertyname>
      </ProfilePropertyDefinition>
    </ProfileProperties>
    <Region>string</Region>
    <Street>string</Street>
    <Telephone>string</Telephone>
    <TimeZone>int</TimeZone>
    <Unit>string</Unit>
    <Website>string</Website>
  </Profile>
  <Roles>
    <string>string</string>
    <string>string</string>
  </Roles>
  <UserID>int</UserID>
  <Username>string</Username>
</UserInfo>

HTTP POST

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

POST /DesktopModules/IWeb/WebService.asmx/GetUser HTTP/1.1
Host: c21redwood.coachsimple.ai
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"?>
<UserInfo xmlns="http://webservices.DotNetNuke.com/">
  <AffiliateID>int</AffiliateID>
  <DisplayName>string</DisplayName>
  <Email>string</Email>
  <FirstName>string</FirstName>
  <IsSuperUser>boolean</IsSuperUser>
  <LastName>string</LastName>
  <Membership>
    <Approved>boolean</Approved>
    <CreatedDate>dateTime</CreatedDate>
    <IsOnLine>boolean</IsOnLine>
    <LastActivityDate>dateTime</LastActivityDate>
    <LastLockoutDate>dateTime</LastLockoutDate>
    <LastLoginDate>dateTime</LastLoginDate>
    <LastPasswordChangeDate>dateTime</LastPasswordChangeDate>
    <LockedOut>boolean</LockedOut>
    <ObjectHydrated>boolean</ObjectHydrated>
    <Password>string</Password>
    <PasswordAnswer>string</PasswordAnswer>
    <PasswordQuestion>string</PasswordQuestion>
    <UpdatePassword>boolean</UpdatePassword>
    <Email>string</Email>
    <Username>string</Username>
  </Membership>
  <PortalID>int</PortalID>
  <Profile>
    <Cell>string</Cell>
    <City>string</City>
    <Country>string</Country>
    <Fax>string</Fax>
    <FirstName>string</FirstName>
    <IM>string</IM>
    <LastName>string</LastName>
    <ObjectHydrated>boolean</ObjectHydrated>
    <PostalCode>string</PostalCode>
    <PreferredLocale>string</PreferredLocale>
    <ProfileProperties>
      <ProfilePropertyDefinition>
        <length>int</length>
        <propertycategory>string</propertycategory>
        <propertyname>string</propertyname>
      </ProfilePropertyDefinition>
      <ProfilePropertyDefinition>
        <length>int</length>
        <propertycategory>string</propertycategory>
        <propertyname>string</propertyname>
      </ProfilePropertyDefinition>
    </ProfileProperties>
    <Region>string</Region>
    <Street>string</Street>
    <Telephone>string</Telephone>
    <TimeZone>int</TimeZone>
    <Unit>string</Unit>
    <Website>string</Website>
  </Profile>
  <Roles>
    <string>string</string>
    <string>string</string>
  </Roles>
  <UserID>int</UserID>
  <Username>string</Username>
</UserInfo>

Parameter	Value
Username: