| All Verbs | /api/contacts/invitevirtualcontact |
|---|
"use strict";
export class InviteVirtualContactResponse {
/** @param {{Success?:boolean,Message?:string,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
Success;
/** @type {string} */
Message;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class InviteVirtualContact {
/** @param {{ContactId?:string,EmailAddress?:string,Roles?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ContactId;
/** @type {string} */
EmailAddress;
/** @type {string[]} */
Roles;
}
JavaScript InviteVirtualContact 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/contacts/invitevirtualcontact HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
EmailAddress: String,
Roles:
[
00000000-0000-0000-0000-000000000000
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Success: False,
Message: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}