PUT api/UserProfile

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
NameIdentifier	string	None.
Name	string	None.
Email	string	None.
AvatarUri	URI	None.
InstitutionIdentity	globally unique identifier	None.
InstitutionName	string	None.
ResourceIdentities	Collection of globally unique identifier	None.
Roles	Collection of string	None.
Groups	Collection of string	None.
UserGroups	Collection of NamedObject	None.
UserLanguage	string	None.
UserTimeZone	string	None.
NotificationsEnabled	boolean	None.
NotificationsEmail	string	None.
Scopes	Collection of string	None.
VisibleStatuses	Collection of ActivityManagerStatus	None.
ActivityManagerIncludeOccurrencesOutsideDateFilter	boolean	None.
ActivityManagerIsTableCompact	boolean	None.
ActivityManagerIsTableExpanded	boolean	None.
ActivityManagerIsManageStatusesCompact	boolean	None.
ImportExportPermissions	ImportExportPermissions	None.
CanViewMyPermissions	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "NameIdentifier": "sample string 1",
  "Name": "sample string 2",
  "Email": "sample string 3",
  "AvatarUri": "http://webapihelppage4.com",
  "InstitutionIdentity": "ce484f22-68a6-407a-91da-11e038f4a41d",
  "InstitutionName": "sample string 6",
  "ResourceIdentities": [
    "0c23f985-368f-4be9-8286-b00d9b37692e",
    "4dc25c03-d071-472a-93b5-41e241342770"
  ],
  "Roles": [
    "sample string 1",
    "sample string 2"
  ],
  "Groups": [
    "sample string 1",
    "sample string 2"
  ],
  "UserGroups": [
    {
      "Identity": "dd9cf6a5-7ac8-44e9-af41-63645b81ee27",
      "Name": "sample string 2"
    },
    {
      "Identity": "dd9cf6a5-7ac8-44e9-af41-63645b81ee27",
      "Name": "sample string 2"
    }
  ],
  "UserLanguage": "sample string 7",
  "UserTimeZone": "sample string 8",
  "NotificationsEnabled": true,
  "NotificationsEmail": "sample string 10",
  "Scopes": [
    "sample string 1",
    "sample string 2"
  ],
  "VisibleStatuses": [
    {
      "Identity": "15dccbb1-d208-41b0-b12d-cb83a6ff0fce",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "SendNotifications": true,
      "BackgroundColor": "sample string 5",
      "TextColor": "sample string 6",
      "UseColor": true,
      "Rank": 8,
      "IsReadOnly": true
    },
    {
      "Identity": "15dccbb1-d208-41b0-b12d-cb83a6ff0fce",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "SendNotifications": true,
      "BackgroundColor": "sample string 5",
      "TextColor": "sample string 6",
      "UseColor": true,
      "Rank": 8,
      "IsReadOnly": true
    }
  ],
  "ActivityManagerIncludeOccurrencesOutsideDateFilter": true,
  "ActivityManagerIsTableCompact": true,
  "ActivityManagerIsTableExpanded": true,
  "ActivityManagerIsManageStatusesCompact": true,
  "ImportExportPermissions": {
    "ResourcePermissions": true,
    "ResourceCustomFields": true,
    "UserGroups": true,
    "Bookings": true
  },
  "CanViewMyPermissions": true
}

application/xml, text/xml

Sample:

<UserProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model.ToDoModels">
  <ActivityManagerIncludeOccurrencesOutsideDateFilter>true</ActivityManagerIncludeOccurrencesOutsideDateFilter>
  <ActivityManagerIsManageStatusesCompact>true</ActivityManagerIsManageStatusesCompact>
  <ActivityManagerIsTableCompact>true</ActivityManagerIsTableCompact>
  <ActivityManagerIsTableExpanded>true</ActivityManagerIsTableExpanded>
  <AvatarUri>http://webapihelppage4.com/</AvatarUri>
  <CanViewMyPermissions>true</CanViewMyPermissions>
  <Email>sample string 3</Email>
  <Groups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Groups>
  <ImportExportPermissions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
    <d2p1:Bookings>true</d2p1:Bookings>
    <d2p1:ResourceCustomFields>true</d2p1:ResourceCustomFields>
    <d2p1:ResourcePermissions>true</d2p1:ResourcePermissions>
    <d2p1:UserGroups>true</d2p1:UserGroups>
  </ImportExportPermissions>
  <InstitutionIdentity>ce484f22-68a6-407a-91da-11e038f4a41d</InstitutionIdentity>
  <InstitutionName>sample string 6</InstitutionName>
  <Name>sample string 2</Name>
  <NameIdentifier>sample string 1</NameIdentifier>
  <NotificationsEmail>sample string 10</NotificationsEmail>
  <NotificationsEnabled>true</NotificationsEnabled>
  <ResourceIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>0c23f985-368f-4be9-8286-b00d9b37692e</d2p1:guid>
    <d2p1:guid>4dc25c03-d071-472a-93b5-41e241342770</d2p1:guid>
  </ResourceIdentities>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Roles>
  <Scopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Scopes>
  <UserGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
    <d2p1:NamedObject>
      <d2p1:Identity>dd9cf6a5-7ac8-44e9-af41-63645b81ee27</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
    <d2p1:NamedObject>
      <d2p1:Identity>dd9cf6a5-7ac8-44e9-af41-63645b81ee27</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
  </UserGroups>
  <UserLanguage>sample string 7</UserLanguage>
  <UserTimeZone>sample string 8</UserTimeZone>
  <VisibleStatuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
    <d2p1:ActivityManagerStatus>
      <d2p1:BackgroundColor>sample string 5</d2p1:BackgroundColor>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Identity>15dccbb1-d208-41b0-b12d-cb83a6ff0fce</d2p1:Identity>
      <d2p1:IsReadOnly>true</d2p1:IsReadOnly>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Rank>8</d2p1:Rank>
      <d2p1:SendNotifications>true</d2p1:SendNotifications>
      <d2p1:TextColor>sample string 6</d2p1:TextColor>
      <d2p1:UseColor>true</d2p1:UseColor>
    </d2p1:ActivityManagerStatus>
    <d2p1:ActivityManagerStatus>
      <d2p1:BackgroundColor>sample string 5</d2p1:BackgroundColor>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Identity>15dccbb1-d208-41b0-b12d-cb83a6ff0fce</d2p1:Identity>
      <d2p1:IsReadOnly>true</d2p1:IsReadOnly>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Rank>8</d2p1:Rank>
      <d2p1:SendNotifications>true</d2p1:SendNotifications>
      <d2p1:TextColor>sample string 6</d2p1:TextColor>
      <d2p1:UseColor>true</d2p1:UseColor>
    </d2p1:ActivityManagerStatus>
  </VisibleStatuses>
</UserProfile>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UserProfile

Name	Type	Additional information
NameIdentifier	string	None.
Name	string	None.
Email	string	None.
AvatarUri	URI	None.
InstitutionIdentity	globally unique identifier	None.
InstitutionName	string	None.
ResourceIdentities	Collection of globally unique identifier	None.
Roles	Collection of string	None.
Groups	Collection of string	None.
UserGroups	Collection of NamedObject	None.
UserLanguage	string	None.
UserTimeZone	string	None.
NotificationsEnabled	boolean	None.
NotificationsEmail	string	None.
Scopes	Collection of string	None.
VisibleStatuses	Collection of ActivityManagerStatus	None.
ActivityManagerIncludeOccurrencesOutsideDateFilter	boolean	None.
ActivityManagerIsTableCompact	boolean	None.
ActivityManagerIsTableExpanded	boolean	None.
ActivityManagerIsManageStatusesCompact	boolean	None.
ImportExportPermissions	ImportExportPermissions	None.
CanViewMyPermissions	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "NameIdentifier": "sample string 1",
  "Name": "sample string 2",
  "Email": "sample string 3",
  "AvatarUri": "http://webapihelppage4.com",
  "InstitutionIdentity": "c5c28623-2739-4107-a3d6-f97be691066d",
  "InstitutionName": "sample string 6",
  "ResourceIdentities": [
    "80f7db46-93dc-46db-9e91-0d2800965ac4",
    "9fd3ce3e-e219-46d5-83cc-15099f3d0d73"
  ],
  "Roles": [
    "sample string 1",
    "sample string 2"
  ],
  "Groups": [
    "sample string 1",
    "sample string 2"
  ],
  "UserGroups": [
    {
      "Identity": "fb537c43-1878-4c9d-bea9-b3fb2bab08d8",
      "Name": "sample string 2"
    },
    {
      "Identity": "fb537c43-1878-4c9d-bea9-b3fb2bab08d8",
      "Name": "sample string 2"
    }
  ],
  "UserLanguage": "sample string 7",
  "UserTimeZone": "sample string 8",
  "NotificationsEnabled": true,
  "NotificationsEmail": "sample string 10",
  "Scopes": [
    "sample string 1",
    "sample string 2"
  ],
  "VisibleStatuses": [
    {
      "Identity": "1ace561e-bb09-40da-a13e-9bb9b986e5e4",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "SendNotifications": true,
      "BackgroundColor": "sample string 5",
      "TextColor": "sample string 6",
      "UseColor": true,
      "Rank": 8,
      "IsReadOnly": true
    },
    {
      "Identity": "1ace561e-bb09-40da-a13e-9bb9b986e5e4",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "SendNotifications": true,
      "BackgroundColor": "sample string 5",
      "TextColor": "sample string 6",
      "UseColor": true,
      "Rank": 8,
      "IsReadOnly": true
    }
  ],
  "ActivityManagerIncludeOccurrencesOutsideDateFilter": true,
  "ActivityManagerIsTableCompact": true,
  "ActivityManagerIsTableExpanded": true,
  "ActivityManagerIsManageStatusesCompact": true,
  "ImportExportPermissions": {
    "ResourcePermissions": true,
    "ResourceCustomFields": true,
    "UserGroups": true,
    "Bookings": true
  },
  "CanViewMyPermissions": true
}

application/xml, text/xml

Sample:

<UserProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model.ToDoModels">
  <ActivityManagerIncludeOccurrencesOutsideDateFilter>true</ActivityManagerIncludeOccurrencesOutsideDateFilter>
  <ActivityManagerIsManageStatusesCompact>true</ActivityManagerIsManageStatusesCompact>
  <ActivityManagerIsTableCompact>true</ActivityManagerIsTableCompact>
  <ActivityManagerIsTableExpanded>true</ActivityManagerIsTableExpanded>
  <AvatarUri>http://webapihelppage4.com/</AvatarUri>
  <CanViewMyPermissions>true</CanViewMyPermissions>
  <Email>sample string 3</Email>
  <Groups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Groups>
  <ImportExportPermissions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
    <d2p1:Bookings>true</d2p1:Bookings>
    <d2p1:ResourceCustomFields>true</d2p1:ResourceCustomFields>
    <d2p1:ResourcePermissions>true</d2p1:ResourcePermissions>
    <d2p1:UserGroups>true</d2p1:UserGroups>
  </ImportExportPermissions>
  <InstitutionIdentity>c5c28623-2739-4107-a3d6-f97be691066d</InstitutionIdentity>
  <InstitutionName>sample string 6</InstitutionName>
  <Name>sample string 2</Name>
  <NameIdentifier>sample string 1</NameIdentifier>
  <NotificationsEmail>sample string 10</NotificationsEmail>
  <NotificationsEnabled>true</NotificationsEnabled>
  <ResourceIdentities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>80f7db46-93dc-46db-9e91-0d2800965ac4</d2p1:guid>
    <d2p1:guid>9fd3ce3e-e219-46d5-83cc-15099f3d0d73</d2p1:guid>
  </ResourceIdentities>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Roles>
  <Scopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Scopes>
  <UserGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
    <d2p1:NamedObject>
      <d2p1:Identity>fb537c43-1878-4c9d-bea9-b3fb2bab08d8</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
    <d2p1:NamedObject>
      <d2p1:Identity>fb537c43-1878-4c9d-bea9-b3fb2bab08d8</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
  </UserGroups>
  <UserLanguage>sample string 7</UserLanguage>
  <UserTimeZone>sample string 8</UserTimeZone>
  <VisibleStatuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
    <d2p1:ActivityManagerStatus>
      <d2p1:BackgroundColor>sample string 5</d2p1:BackgroundColor>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Identity>1ace561e-bb09-40da-a13e-9bb9b986e5e4</d2p1:Identity>
      <d2p1:IsReadOnly>true</d2p1:IsReadOnly>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Rank>8</d2p1:Rank>
      <d2p1:SendNotifications>true</d2p1:SendNotifications>
      <d2p1:TextColor>sample string 6</d2p1:TextColor>
      <d2p1:UseColor>true</d2p1:UseColor>
    </d2p1:ActivityManagerStatus>
    <d2p1:ActivityManagerStatus>
      <d2p1:BackgroundColor>sample string 5</d2p1:BackgroundColor>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Identity>1ace561e-bb09-40da-a13e-9bb9b986e5e4</d2p1:Identity>
      <d2p1:IsReadOnly>true</d2p1:IsReadOnly>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Rank>8</d2p1:Rank>
      <d2p1:SendNotifications>true</d2p1:SendNotifications>
      <d2p1:TextColor>sample string 6</d2p1:TextColor>
      <d2p1:UseColor>true</d2p1:UseColor>
    </d2p1:ActivityManagerStatus>
  </VisibleStatuses>
</UserProfile>