Platform API

GetContactNotifications

Get notifications for the specified contact

The following routes are available for this service:
All Verbs	/api/contact/{ContactId}/notifications

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


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

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

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

@ApiResponse(Description="List of contact notifications")
open class GetContactNotificationsResponse
{
    open var Notifications:ArrayList<NotificationGroup>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class NotificationGroup
{
    open var GroupName:String? = null
    open var Notifications:ArrayList<NotificationDetails>? = null
}

open class NotificationDetails
{
    open var NotificationId:UUID? = null
    open var NotificationGroupName:String? = null
    open var NotificationValueId:UUID? = null
    open var Name:String? = null
    open var Description:String? = null
    open var IsMandatory:Boolean? = null
    open var IsCardinality:Boolean? = null
    open var IsSystem:Boolean? = null
    open var IsVisibleToRecipients:Boolean? = null
    open var Index:Int? = null
    open var Email:InputSwitch? = null
    open var SMS:InputSwitch? = null
    open var UpdateNotification:InputSwitch? = null
    open var Push:InputSwitch? = null
    open var Phone:InputSwitch? = null
}

open class InputSwitch
{
    open var Id:String? = null
    open var Name:String? = null
    open var IsDisabled:Boolean? = null
    open var IsChecked:Boolean? = null
}

Kotlin GetContactNotifications DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/contact/{ContactId}/notifications HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ContactId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000","SuiteId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Notifications":[{"GroupName":"String","Notifications":[{"NotificationId":"00000000-0000-0000-0000-000000000000","NotificationGroupName":"String","NotificationValueId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","IsMandatory":false,"IsCardinality":false,"IsSystem":false,"IsVisibleToRecipients":false,"Index":0,"Email":{"Id":"String","Name":"String","IsDisabled":false,"IsChecked":false},"SMS":{"Id":"String","Name":"String","IsDisabled":false,"IsChecked":false},"UpdateNotification":{"Id":"String","Name":"String","IsDisabled":false,"IsChecked":false},"Push":{"Id":"String","Name":"String","IsDisabled":false,"IsChecked":false},"Phone":{"Id":"String","Name":"String","IsDisabled":false,"IsChecked":false}}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}