UserProfileService Web Service

UserProfileService

Click here for a complete list of operations.

GetUserProfileSchema

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 /_vti_bin/userprofileservice.asmx HTTP/1.1
Host: www.unipolsai.it
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://microsoft.com/webservices/SharePointPortalServer/UserProfileService/GetUserProfileSchema"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetUserProfileSchema xmlns="https://microsoft.com/webservices/SharePointPortalServer/UserProfileService" />
  </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="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetUserProfileSchemaResponse xmlns="https://microsoft.com/webservices/SharePointPortalServer/UserProfileService">
      <GetUserProfileSchemaResult>
        <PropertyInfo>
          <Name>string</Name>
          <Description>string</Description>
          <DisplayOrder>int</DisplayOrder>
          <MaximumShown>int</MaximumShown>
          <IsAdminEditable>boolean</IsAdminEditable>
          <IsSearchable>boolean</IsSearchable>
          <IsSystem>boolean</IsSystem>
          <ManagedPropertyName>string</ManagedPropertyName>
          <DisplayName>string</DisplayName>
          <Type>string</Type>
          <AllowPolicyOverride>boolean</AllowPolicyOverride>
          <DefaultPrivacy>Public or Contacts or Organization or Manager or Private or NotSet</DefaultPrivacy>
          <IsAlias>boolean</IsAlias>
          <IsColleagueEventLog>boolean</IsColleagueEventLog>
          <IsRequired>boolean</IsRequired>
          <IsUserEditable>boolean</IsUserEditable>
          <IsVisibleOnEditor>boolean</IsVisibleOnEditor>
          <IsVisibleOnViewer>boolean</IsVisibleOnViewer>
          <IsReplicable>boolean</IsReplicable>
          <UserOverridePrivacy>boolean</UserOverridePrivacy>
          <Length>int</Length>
          <IsImported>boolean</IsImported>
          <IsMultiValue>boolean</IsMultiValue>
          <ChoiceType>Off or None or Open or Closed</ChoiceType>
          <TermSetId>guid</TermSetId>
        </PropertyInfo>
        <PropertyInfo>
          <Name>string</Name>
          <Description>string</Description>
          <DisplayOrder>int</DisplayOrder>
          <MaximumShown>int</MaximumShown>
          <IsAdminEditable>boolean</IsAdminEditable>
          <IsSearchable>boolean</IsSearchable>
          <IsSystem>boolean</IsSystem>
          <ManagedPropertyName>string</ManagedPropertyName>
          <DisplayName>string</DisplayName>
          <Type>string</Type>
          <AllowPolicyOverride>boolean</AllowPolicyOverride>
          <DefaultPrivacy>Public or Contacts or Organization or Manager or Private or NotSet</DefaultPrivacy>
          <IsAlias>boolean</IsAlias>
          <IsColleagueEventLog>boolean</IsColleagueEventLog>
          <IsRequired>boolean</IsRequired>
          <IsUserEditable>boolean</IsUserEditable>
          <IsVisibleOnEditor>boolean</IsVisibleOnEditor>
          <IsVisibleOnViewer>boolean</IsVisibleOnViewer>
          <IsReplicable>boolean</IsReplicable>
          <UserOverridePrivacy>boolean</UserOverridePrivacy>
          <Length>int</Length>
          <IsImported>boolean</IsImported>
          <IsMultiValue>boolean</IsMultiValue>
          <ChoiceType>Off or None or Open or Closed</ChoiceType>
          <TermSetId>guid</TermSetId>
        </PropertyInfo>
      </GetUserProfileSchemaResult>
    </GetUserProfileSchemaResponse>
  </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 /_vti_bin/userprofileservice.asmx HTTP/1.1
Host: www.unipolsai.it
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:soap12="https://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetUserProfileSchema xmlns="https://microsoft.com/webservices/SharePointPortalServer/UserProfileService" />
  </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="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:soap12="https://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetUserProfileSchemaResponse xmlns="https://microsoft.com/webservices/SharePointPortalServer/UserProfileService">
      <GetUserProfileSchemaResult>
        <PropertyInfo>
          <Name>string</Name>
          <Description>string</Description>
          <DisplayOrder>int</DisplayOrder>
          <MaximumShown>int</MaximumShown>
          <IsAdminEditable>boolean</IsAdminEditable>
          <IsSearchable>boolean</IsSearchable>
          <IsSystem>boolean</IsSystem>
          <ManagedPropertyName>string</ManagedPropertyName>
          <DisplayName>string</DisplayName>
          <Type>string</Type>
          <AllowPolicyOverride>boolean</AllowPolicyOverride>
          <DefaultPrivacy>Public or Contacts or Organization or Manager or Private or NotSet</DefaultPrivacy>
          <IsAlias>boolean</IsAlias>
          <IsColleagueEventLog>boolean</IsColleagueEventLog>
          <IsRequired>boolean</IsRequired>
          <IsUserEditable>boolean</IsUserEditable>
          <IsVisibleOnEditor>boolean</IsVisibleOnEditor>
          <IsVisibleOnViewer>boolean</IsVisibleOnViewer>
          <IsReplicable>boolean</IsReplicable>
          <UserOverridePrivacy>boolean</UserOverridePrivacy>
          <Length>int</Length>
          <IsImported>boolean</IsImported>
          <IsMultiValue>boolean</IsMultiValue>
          <ChoiceType>Off or None or Open or Closed</ChoiceType>
          <TermSetId>guid</TermSetId>
        </PropertyInfo>
        <PropertyInfo>
          <Name>string</Name>
          <Description>string</Description>
          <DisplayOrder>int</DisplayOrder>
          <MaximumShown>int</MaximumShown>
          <IsAdminEditable>boolean</IsAdminEditable>
          <IsSearchable>boolean</IsSearchable>
          <IsSystem>boolean</IsSystem>
          <ManagedPropertyName>string</ManagedPropertyName>
          <DisplayName>string</DisplayName>
          <Type>string</Type>
          <AllowPolicyOverride>boolean</AllowPolicyOverride>
          <DefaultPrivacy>Public or Contacts or Organization or Manager or Private or NotSet</DefaultPrivacy>
          <IsAlias>boolean</IsAlias>
          <IsColleagueEventLog>boolean</IsColleagueEventLog>
          <IsRequired>boolean</IsRequired>
          <IsUserEditable>boolean</IsUserEditable>
          <IsVisibleOnEditor>boolean</IsVisibleOnEditor>
          <IsVisibleOnViewer>boolean</IsVisibleOnViewer>
          <IsReplicable>boolean</IsReplicable>
          <UserOverridePrivacy>boolean</UserOverridePrivacy>
          <Length>int</Length>
          <IsImported>boolean</IsImported>
          <IsMultiValue>boolean</IsMultiValue>
          <ChoiceType>Off or None or Open or Closed</ChoiceType>
          <TermSetId>guid</TermSetId>
        </PropertyInfo>
      </GetUserProfileSchemaResult>
    </GetUserProfileSchemaResponse>
  </soap12:Body>
</soap12:Envelope>