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.*


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

    /**
    * Id of licensee to get notification for
    */
    @ApiMember(Description="Id of licensee to get notification for", IsRequired=true, Name="LicenseeId")
    open var LicenseeId:UUID? = null

    /**
    * Id of suite to get notification for
    */
    @ApiMember(Description="Id of suite to get notification for", IsRequired=true, Name="SuiteId")
    open var SuiteId:UUID? = null

    /**
    * List of notification to update
    */
    @ApiMember(Description="List of notification to update", IsRequired=true, Name="Notifications")
    open var Notifications:ArrayList<NotificationItem> = ArrayList<NotificationItem>()
}

open class NotificationItem
{
    open var Id:UUID? = null
    open var Name:String? = null
}

Kotlin UpdateContactNotifications DTOs

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

HTTP + CSV

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

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