Trendsic Platform Service

<back to all web services

IncomingNotifications

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/IncomingNotifications/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/IncomingNotifications

export class IncomingNotificationObject
{
    public Id: string;
    public CustomerId: string;
    public Message: string;
    public NotificationMethod: string;
    public DateReceived: string;

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

export class IncomingNotificationsResponse
{
    public ResponseStatus: ResponseStatus;
    public IncomingNotifications: IncomingNotificationObject[] = [];

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

export class IncomingNotifications extends IncomingNotificationObject
{
    public ApiKey: string;

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

TypeScript IncomingNotifications 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.

POST /v1/IncomingNotifications/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<IncomingNotifications xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <DateReceived>0001-01-01T00:00:00</DateReceived>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Message>String</Message>
  <NotificationMethod>00000000-0000-0000-0000-000000000000</NotificationMethod>
  <ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
</IncomingNotifications>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IncomingNotificationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <IncomingNotifications>
    <IncomingNotificationObject>
      <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
      <DateReceived>0001-01-01T00:00:00</DateReceived>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <Message>String</Message>
      <NotificationMethod>00000000-0000-0000-0000-000000000000</NotificationMethod>
    </IncomingNotificationObject>
  </IncomingNotifications>
  <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>
</IncomingNotificationsResponse>