PUT api/UserProfile
Request Information
URI Parameters
None.
Body Parameters
UserProfileName | Description | Type | Additional information |
---|---|---|---|
NameIdentifier | string |
None. |
|
Name | string |
None. |
|
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": "d94ac25e-68ef-4888-918d-51a9a0b09d02", "InstitutionName": "sample string 6", "ResourceIdentities": [ "d4c6fe9d-c072-4c1e-831b-7658cc2535d8", "f091d808-4f8d-4bd6-81fd-bf95b864ee97" ], "Roles": [ "sample string 1", "sample string 2" ], "Groups": [ "sample string 1", "sample string 2" ], "UserGroups": [ { "Identity": "a7e52e60-2c8a-473f-837c-1ddb5f630b19", "Name": "sample string 2" }, { "Identity": "a7e52e60-2c8a-473f-837c-1ddb5f630b19", "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": "8e1d384c-ecd3-4b93-b8d9-ee1b048f1d29", "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": "8e1d384c-ecd3-4b93-b8d9-ee1b048f1d29", "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>d94ac25e-68ef-4888-918d-51a9a0b09d02</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>d4c6fe9d-c072-4c1e-831b-7658cc2535d8</d2p1:guid> <d2p1:guid>f091d808-4f8d-4bd6-81fd-bf95b864ee97</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>a7e52e60-2c8a-473f-837c-1ddb5f630b19</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>a7e52e60-2c8a-473f-837c-1ddb5f630b19</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>8e1d384c-ecd3-4b93-b8d9-ee1b048f1d29</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>8e1d384c-ecd3-4b93-b8d9-ee1b048f1d29</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
UserProfileName | Description | Type | Additional information |
---|---|---|---|
NameIdentifier | string |
None. |
|
Name | string |
None. |
|
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": "b0c1b181-aea2-4ef7-a966-ecf891a26f61", "InstitutionName": "sample string 6", "ResourceIdentities": [ "97d63c4a-08de-4fa1-b1be-2910beb707fb", "8418516b-cfc6-4ba5-9f4c-77984610078c" ], "Roles": [ "sample string 1", "sample string 2" ], "Groups": [ "sample string 1", "sample string 2" ], "UserGroups": [ { "Identity": "33941208-7ff8-4c6a-9c03-ef28e1ce888c", "Name": "sample string 2" }, { "Identity": "33941208-7ff8-4c6a-9c03-ef28e1ce888c", "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": "a3f97452-cc6c-4a2a-995f-423107929d0d", "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": "a3f97452-cc6c-4a2a-995f-423107929d0d", "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>b0c1b181-aea2-4ef7-a966-ecf891a26f61</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>97d63c4a-08de-4fa1-b1be-2910beb707fb</d2p1:guid> <d2p1:guid>8418516b-cfc6-4ba5-9f4c-77984610078c</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>33941208-7ff8-4c6a-9c03-ef28e1ce888c</d2p1:Identity> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:NamedObject> <d2p1:NamedObject> <d2p1:Identity>33941208-7ff8-4c6a-9c03-ef28e1ce888c</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>a3f97452-cc6c-4a2a-995f-423107929d0d</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>a3f97452-cc6c-4a2a-995f-423107929d0d</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>