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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Updates contact notifications
    */
    @Api(Description="Updates contact notifications")
    public static class UpdateContactNotifications
    {
        /**
        * Id of contact to get notification for
        */
        @ApiMember(Description="Id of contact to get notification for", IsRequired=true, Name="ContactId")
        public UUID ContactId = null;

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

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

        /**
        * List of notification to update
        */
        @ApiMember(Description="List of notification to update", IsRequired=true, Name="Notifications")
        public ArrayList<NotificationItem> Notifications = new ArrayList<NotificationItem>();
        
        public UUID getContactId() { return ContactId; }
        public UpdateContactNotifications setContactId(UUID value) { this.ContactId = value; return this; }
        public UUID getLicenseeId() { return LicenseeId; }
        public UpdateContactNotifications setLicenseeId(UUID value) { this.LicenseeId = value; return this; }
        public UUID getSuiteId() { return SuiteId; }
        public UpdateContactNotifications setSuiteId(UUID value) { this.SuiteId = value; return this; }
        public ArrayList<NotificationItem> getNotifications() { return Notifications; }
        public UpdateContactNotifications setNotifications(ArrayList<NotificationItem> value) { this.Notifications = value; return this; }
    }

    public static class NotificationItem
    {
        public UUID Id = null;
        public String Name = null;
        
        public UUID getId() { return Id; }
        public NotificationItem setId(UUID value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public NotificationItem setName(String value) { this.Name = value; return this; }
    }

}

Java UpdateContactNotifications DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ContactId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000","SuiteId":"00000000-0000-0000-0000-000000000000","Notifications":[{"Id":"00000000-0000-0000-0000-000000000000","Name":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}