Trendsic Platform Service

<back to all web services

UserNotificationsRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/UserNotifications/{AgentId}
DELETE,OPTIONS/v1/UserNotifications/{NotificationId}

export class UserNotification
{
    public NotificationId: number;
    public AgentId: number;
    public Description: string;
    public From: string;
    public CreatedDate: string;
    public Type: string;
    public URL: string;
    public RefId: string;
    public IsDeleted: boolean;

    public constructor(init?: Partial<UserNotification>) { (Object as any).assign(this, init); }
}

export class UserNotificationsResponse
{
    public ResponseStatus: ResponseStatus;
    public Notifications: UserNotification[] = [];
    public Deleted: boolean;

    public constructor(init?: Partial<UserNotificationsResponse>) { (Object as any).assign(this, init); }
}

export class UserNotificationsRequest
{
    public AgentId: number;
    public NotificationId: number;
    public ShowDeleted: boolean;

    public constructor(init?: Partial<UserNotificationsRequest>) { (Object as any).assign(this, init); }
}

TypeScript UserNotificationsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/UserNotifications/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserNotificationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Deleted>false</Deleted>
  <Notifications>
    <UserNotification>
      <AgentId>0</AgentId>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <Description>String</Description>
      <From>String</From>
      <IsDeleted>false</IsDeleted>
      <NotificationId>0</NotificationId>
      <RefId>String</RefId>
      <Type>String</Type>
      <URL>String</URL>
    </UserNotification>
  </Notifications>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</UserNotificationsResponse>