Platform API

<back to all web services

GetContactNotifications

Get notifications for the specified contact

Requires Authentication
The following routes are available for this service:
All Verbs/api/contact/{ContactId}/notifications
"use strict";
export class InputSwitch {
    /** @param {{Id?:string,Name?:string,IsDisabled?:boolean,IsChecked?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Name;
    /** @type {boolean} */
    IsDisabled;
    /** @type {boolean} */
    IsChecked;
}
export class NotificationDetails {
    /** @param {{NotificationId?:string,NotificationGroupName?:string,NotificationValueId?:string,Name?:string,Description?:string,IsMandatory?:boolean,IsCardinality?:boolean,IsSystem?:boolean,IsVisibleToRecipients?:boolean,Index?:number,Email?:InputSwitch,SMS?:InputSwitch,UpdateNotification?:InputSwitch,Push?:InputSwitch,Phone?:InputSwitch}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    NotificationId;
    /** @type {string} */
    NotificationGroupName;
    /** @type {string} */
    NotificationValueId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {boolean} */
    IsMandatory;
    /** @type {boolean} */
    IsCardinality;
    /** @type {boolean} */
    IsSystem;
    /** @type {boolean} */
    IsVisibleToRecipients;
    /** @type {number} */
    Index;
    /** @type {InputSwitch} */
    Email;
    /** @type {InputSwitch} */
    SMS;
    /** @type {InputSwitch} */
    UpdateNotification;
    /** @type {InputSwitch} */
    Push;
    /** @type {InputSwitch} */
    Phone;
}
export class NotificationGroup {
    /** @param {{GroupName?:string,Notifications?:NotificationDetails[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    GroupName;
    /** @type {NotificationDetails[]} */
    Notifications;
}
export class GetContactNotificationsResponse {
    /** @param {{Notifications?:NotificationGroup[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {NotificationGroup[]} */
    Notifications;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetContactNotifications {
    /** @param {{ContactId?:string,LicenseeId?:string,SuiteId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Id of contact to get notifications for */
    ContactId;
    /**
     * @type {string}
     * @description Id of licensee to get notifications for */
    LicenseeId;
    /**
     * @type {string}
     * @description Id of suite to get notifications for */
    SuiteId;
}

JavaScript 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"}}}