Trendsic Platform Service

<back to all web services

NotificationsRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Notifications

export class NotificationHeader
{
    public NotificationHeaderId: number;
    public Subject: string;
    public Status: string;
    public NeedsCloseApproval: boolean;
    public IsDeleted: boolean;
    public CreatedBy: number;
    public DateCreated: string;

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

export class Notification extends NotificationHeader
{

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

export class NotificationsResponse
{
    public ResponseStatus: ResponseStatus;
    public Notifications: Notification[] = [];

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

export class NotificationsRequest
{

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

TypeScript NotificationsRequest 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/Notifications HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NotificationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Notifications>
    <Notification>
      <CreatedBy>0</CreatedBy>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <IsDeleted>false</IsDeleted>
      <NeedsCloseApproval>false</NeedsCloseApproval>
      <NotificationHeaderId>0</NotificationHeaderId>
      <Status>String</Status>
      <Subject>String</Subject>
      <LastMessage>
        <DateCreated>0001-01-01T00:00:00</DateCreated>
        <Message>String</Message>
        <NotificationHeaderId>0</NotificationHeaderId>
        <NotificationMessageId>0</NotificationMessageId>
        <SenderId>0</SenderId>
        <SenderName>String</SenderName>
        <Subject>String</Subject>
      </LastMessage>
    </Notification>
  </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>
</NotificationsResponse>