Platform API

<back to all web services

UpdateContactNotifications

Updates contact notifications

Requires Authentication
The following routes are available for this service:
PUT/api/contact/{ContactId}/updatenotifications
import 'package:servicestack/servicestack.dart';

class NotificationItem implements IConvertible
{
    String? Id;
    String? Name;

    NotificationItem({this.Id,this.Name});
    NotificationItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Name = json['Name'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Name': Name
    };

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

/**
* Updates contact notifications
*/
// @Api(Description="Updates contact notifications")
class UpdateContactNotifications implements IConvertible
{
    /**
    * Id of contact to get notification for
    */
    // @ApiMember(Description="Id of contact to get notification for", IsRequired=true, Name="ContactId")
    String? ContactId;

    /**
    * Id of licensee to get notification for
    */
    // @ApiMember(Description="Id of licensee to get notification for", IsRequired=true, Name="LicenseeId")
    String? LicenseeId;

    /**
    * Id of suite to get notification for
    */
    // @ApiMember(Description="Id of suite to get notification for", IsRequired=true, Name="SuiteId")
    String? SuiteId;

    /**
    * List of notification to update
    */
    // @ApiMember(Description="List of notification to update", IsRequired=true, Name="Notifications")
    List<NotificationItem>? Notifications = [];

    UpdateContactNotifications({this.ContactId,this.LicenseeId,this.SuiteId,this.Notifications});
    UpdateContactNotifications.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ContactId = json['ContactId'];
        LicenseeId = json['LicenseeId'];
        SuiteId = json['SuiteId'];
        Notifications = JsonConverters.fromJson(json['Notifications'],'List<NotificationItem>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContactId': ContactId,
        'LicenseeId': LicenseeId,
        'SuiteId': SuiteId,
        'Notifications': JsonConverters.toJson(Notifications,'List<NotificationItem>',context!)
    };

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

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'NotificationItem': TypeInfo(TypeOf.Class, create:() => NotificationItem()),
    'UpdateContactNotifications': TypeInfo(TypeOf.Class, create:() => UpdateContactNotifications()),
    'List<NotificationItem>': TypeInfo(TypeOf.Class, create:() => <NotificationItem>[]),
});

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

PUT /api/contact/{ContactId}/updatenotifications HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateContactNotifications xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactId>00000000-0000-0000-0000-000000000000</ContactId>
  <LicenseeId>00000000-0000-0000-0000-000000000000</LicenseeId>
  <Notifications xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
    <d2p1:NotificationItem>
      <d2p1:_x003C_Id_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
    </d2p1:NotificationItem>
  </Notifications>
  <SuiteId>00000000-0000-0000-0000-000000000000</SuiteId>
</UpdateContactNotifications>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>