GET api/Users/Settings

Retrieves user settings for the current user.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

WorkPoint.Core.Models.UserSettings.UserSettings

Name	Type	Additional information
NotificationProfile	WorkPoint.Core.Models.UserSettings.NotificationProfile	None.
AdminFavorites	Collection of string	None.
MyProcessSettings	WorkPoint.Core.Models.ProcessManagement.MyProcessSettings	None.

Response Formats

application/json, text/json

Sample:

{
  "NotificationProfile": {
    "NotificationTypes": [
      {
        "ManagedMetadataName": "sample string 1",
        "ParentManagedMetadataName": "sample string 2",
        "ManagedMetadataId": "60d07c53-cd9f-4694-bc90-2c723381ba85",
        "ParentManagedMetadataId": "f9ff2e6e-d45b-472f-84f9-b381e7c83af8",
        "Enable": true,
        "EnableEmail": true,
        "EnableTeams": true,
        "IsLocked": true
      },
      {
        "ManagedMetadataName": "sample string 1",
        "ParentManagedMetadataName": "sample string 2",
        "ManagedMetadataId": "60d07c53-cd9f-4694-bc90-2c723381ba85",
        "ParentManagedMetadataId": "f9ff2e6e-d45b-472f-84f9-b381e7c83af8",
        "Enable": true,
        "EnableEmail": true,
        "EnableTeams": true,
        "IsLocked": true
      }
    ]
  },
  "AdminFavorites": [
    "sample string 1",
    "sample string 2"
  ],
  "MyProcessSettings": {
    "PushNotificationSettings": {
      "Completed": true,
      "AwaitingInput": true,
      "Failed": true
    },
    "ProcessDateRange": 1
  }
}

application/xml, text/xml

Sample:

<UserSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint.Core.Models.UserSettings">
  <AdminFavorites xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AdminFavorites>
  <MyProcessSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/WorkPoint.Core.Models.ProcessManagement">
    <d2p1:ProcessDateRange>1</d2p1:ProcessDateRange>
    <d2p1:PushNotificationSettings>
      <d2p1:AwaitingInput>true</d2p1:AwaitingInput>
      <d2p1:Completed>true</d2p1:Completed>
      <d2p1:Failed>true</d2p1:Failed>
    </d2p1:PushNotificationSettings>
  </MyProcessSettings>
  <NotificationProfile>
    <NotificationTypes xmlns:d3p1="http://schemas.datacontract.org/2004/07/WorkPoint.Core.Models.Notification">
      <d3p1:NotificationSettings.NotificationProfileNotificationTypes>
        <d3p1:Enable>true</d3p1:Enable>
        <d3p1:EnableEmail>true</d3p1:EnableEmail>
        <d3p1:EnableTeams>true</d3p1:EnableTeams>
        <d3p1:IsLocked>true</d3p1:IsLocked>
        <d3p1:ManagedMetadataId>60d07c53-cd9f-4694-bc90-2c723381ba85</d3p1:ManagedMetadataId>
        <d3p1:ManagedMetadataName>sample string 1</d3p1:ManagedMetadataName>
        <d3p1:ParentManagedMetadataId>f9ff2e6e-d45b-472f-84f9-b381e7c83af8</d3p1:ParentManagedMetadataId>
        <d3p1:ParentManagedMetadataName>sample string 2</d3p1:ParentManagedMetadataName>
      </d3p1:NotificationSettings.NotificationProfileNotificationTypes>
      <d3p1:NotificationSettings.NotificationProfileNotificationTypes>
        <d3p1:Enable>true</d3p1:Enable>
        <d3p1:EnableEmail>true</d3p1:EnableEmail>
        <d3p1:EnableTeams>true</d3p1:EnableTeams>
        <d3p1:IsLocked>true</d3p1:IsLocked>
        <d3p1:ManagedMetadataId>60d07c53-cd9f-4694-bc90-2c723381ba85</d3p1:ManagedMetadataId>
        <d3p1:ManagedMetadataName>sample string 1</d3p1:ManagedMetadataName>
        <d3p1:ParentManagedMetadataId>f9ff2e6e-d45b-472f-84f9-b381e7c83af8</d3p1:ParentManagedMetadataId>
        <d3p1:ParentManagedMetadataName>sample string 2</d3p1:ParentManagedMetadataName>
      </d3p1:NotificationSettings.NotificationProfileNotificationTypes>
    </NotificationTypes>
  </NotificationProfile>
</UserSettings>