| 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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Notifications:
[
{
GroupName: String,
Notifications:
[
{
NotificationGroupName: String,
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
}
}
}