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
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class IncomingNotificationObject implements IConvertible
{
    String? Id;
    String? CustomerId;
    String? Message;
    String? NotificationMethod;
    DateTime? DateReceived;

    IncomingNotificationObject({this.Id,this.CustomerId,this.Message,this.NotificationMethod,this.DateReceived});
    IncomingNotificationObject.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        CustomerId = json['CustomerId'];
        Message = json['Message'];
        NotificationMethod = json['NotificationMethod'];
        DateReceived = JsonConverters.fromJson(json['DateReceived'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'CustomerId': CustomerId,
        'Message': Message,
        'NotificationMethod': NotificationMethod,
        'DateReceived': JsonConverters.toJson(DateReceived,'DateTime',context!)
    };

    getTypeName() => "IncomingNotificationObject";
    TypeContext? context = _ctx;
}

class IncomingNotificationsResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<IncomingNotificationObject>? IncomingNotifications = [];

    IncomingNotificationsResponse({this.ResponseStatus,this.IncomingNotifications});
    IncomingNotificationsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        IncomingNotifications = JsonConverters.fromJson(json['IncomingNotifications'],'List<IncomingNotificationObject>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'IncomingNotifications': JsonConverters.toJson(IncomingNotifications,'List<IncomingNotificationObject>',context!)
    };

    getTypeName() => "IncomingNotificationsResponse";
    TypeContext? context = _ctx;
}

class IncomingNotifications extends IncomingNotificationObject implements IConvertible
{
    String? ApiKey;

    IncomingNotifications({this.ApiKey});
    IncomingNotifications.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        ApiKey = json['ApiKey'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ApiKey': ApiKey
    });

    getTypeName() => "IncomingNotifications";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'IncomingNotificationObject': TypeInfo(TypeOf.Class, create:() => IncomingNotificationObject()),
    'IncomingNotificationsResponse': TypeInfo(TypeOf.Class, create:() => IncomingNotificationsResponse()),
    'List<IncomingNotificationObject>': TypeInfo(TypeOf.Class, create:() => <IncomingNotificationObject>[]),
    'IncomingNotifications': TypeInfo(TypeOf.Class, create:() => IncomingNotifications()),
});

Dart 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>