| All Verbs | /api/contactrole/{ContactRoleId} |
|---|
"use strict";
/** @typedef {'Ascending'|'Descending'} */
export var SortOrder;
(function (SortOrder) {
SortOrder["Ascending"] = "Ascending"
SortOrder["Descending"] = "Descending"
})(SortOrder || (SortOrder = {}));
export class PagedModel {
/** @param {{PageNumber?:number,PageSize?:number,SortIndex?:number,SortOrder?:SortOrder}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description Page Number to retrieve */
PageNumber;
/**
* @type {number}
* @description Number of records to retrieve */
PageSize;
/**
* @type {number}
* @description Index of field to sort results by */
SortIndex;
/**
* @type {SortOrder}
* @description Sort Order - Ascending or Descending */
SortOrder;
}
export class UserProfileSummaryModel {
/** @param {{UserProfileId?:string,UserId?:string,ContactId?:string,UserName?:string,ProfileName?:string,ContactFullName?:string,EmailAddress?:string,EmailSignature?:string,MobileNumber?:string,PhoneNumber?:string,ContactTypeId?:string,ContactTypeName?:string,FirstName?:string,Surname?:string,Title?:string,LegalName?:string,TradingName?:string,Abn?:string,Acn?:string,Arbn?:string,GstRegistered?:boolean,ESL?:boolean,Language?:string,InterpreterRequired?:boolean,LicenseeNotes?:string,ProfilePhotoUrl?:string,ProfilePhotoThumbnailUrl?:string,ProfileImageId?:string,Description?:string,EmploymentIndustry?:string,EmploymentRole?:string,EmploymentGeographicArea?:string,Timezone?:string,TimezoneName?:string,PrimaryAddress?:string,IsActiveContact?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description User Profile Id */
UserProfileId;
/**
* @type {string}
* @description User linked to the profile */
UserId;
/**
* @type {string}
* @description Contact linked to the profile */
ContactId;
/**
* @type {string}
* @description User linked to the profile */
UserName;
/**
* @type {string}
* @description User Profile Name */
ProfileName;
/**
* @type {string}
* @description Full name of the contact linked to the profile */
ContactFullName;
/**
* @type {string}
* @description Email Address of the contact linked to the profile */
EmailAddress;
/**
* @type {string}
* @description Email signature of the contact linked to the profile */
EmailSignature;
/**
* @type {string}
* @description Mobile number of the contact linked to the profile */
MobileNumber;
/**
* @type {string}
* @description Phone number of the contact linked to the profile */
PhoneNumber;
/**
* @type {string}
* @description Type of contact (person, organisation etc.) linked to the profile */
ContactTypeId;
/**
* @type {string}
* @description Type of contact (person, organisation etc.) linked to the profile */
ContactTypeName;
/**
* @type {string}
* @description First name of the contact linked to the profile */
FirstName;
/**
* @type {string}
* @description Surname of the contact linked to the profile */
Surname;
/**
* @type {string}
* @description Title of contact linked to the profile */
Title;
/**
* @type {string}
* @description Legal name of contact linked to the profile */
LegalName;
/**
* @type {string}
* @description Trading name of contact linked to the profile */
TradingName;
/**
* @type {string}
* @description Australian Business Number */
Abn;
/**
* @type {string}
* @description Australian Company Number */
Acn;
/**
* @type {string}
* @description Australian Registered Body Number */
Arbn;
/**
* @type {boolean}
* @description Indicates if the Contact is registered for GST. */
GstRegistered;
/**
* @type {boolean}
* @description True if english is a secondary language for the contact. */
ESL;
/**
* @type {string}
* @description Language that is the primary language for the contact. */
Language;
/**
* @type {boolean}
* @description True if an interpreter is required. */
InterpreterRequired;
/**
* @type {string}
* @description Licensee specific notes about the contact. */
LicenseeNotes;
/**
* @type {string}
* @description Profile photo of contact linked to the profile */
ProfilePhotoUrl;
/**
* @type {string}
* @description Thumbnail photo of contact linked to the profile */
ProfilePhotoThumbnailUrl;
/**
* @type {string}
* @description Profile photo id of contact linked to the profile */
ProfileImageId;
/**
* @type {string}
* @description Profile description */
Description;
/**
* @type {string}
* @description Employment Industry */
EmploymentIndustry;
/**
* @type {string}
* @description Employment Role */
EmploymentRole;
/**
* @type {string}
* @description Areas of Work */
EmploymentGeographicArea;
/**
* @type {string}
* @description The contacts timezone. */
Timezone;
/**
* @type {string}
* @description Timezone Name */
TimezoneName;
/**
* @type {string}
* @description The primary address of the contact */
PrimaryAddress;
/**
* @type {boolean}
* @description Is this an active contact? Or an inactive contact (deleted account)? */
IsActiveContact;
}
export class ObjectShareModel {
/** @param {{ObjectShareId?:string,ObjectId?:string,ObjectName?:string,Name?:string,Description?:string,Reference?:string,ContactId?:string,ContactName?:string,ContactType?:string,ContactImageUrlPrimary?:string,ContactImageUrlPrimaryThmbnail?:string,ShareStatusId?:string,ShareStatusName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ObjectShareId;
/** @type {string} */
ObjectId;
/** @type {string} */
ObjectName;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {string} */
Reference;
/** @type {string} */
ContactId;
/** @type {string} */
ContactName;
/** @type {string} */
ContactType;
/** @type {string} */
ContactImageUrlPrimary;
/** @type {string} */
ContactImageUrlPrimaryThmbnail;
/** @type {string} */
ShareStatusId;
/** @type {string} */
ShareStatusName;
}
export class ListItemFilterModel {
/** @param {{ListItemFilterId?:string,FilterName?:string,ListId?:string,ListItemId?:string,ListItemIsInFilter?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ListItemFilterId;
/** @type {string} */
FilterName;
/** @type {string} */
ListId;
/** @type {string} */
ListItemId;
/** @type {boolean} */
ListItemIsInFilter;
}
export class ViewRoleModel extends PagedModel {
/** @param {{RoleId?:string,RoleName?:string,RoleConnectionDefinitionId?:string,ContactTypes?:string[],RequireContactsToAccept?:boolean,IsPlatformRole?:boolean,CanAddContacts?:boolean,CanShareRole?:boolean,CanEditRole?:boolean,CanEditContactTypes?:boolean,Contacts?:UserProfileSummaryModel[],ShareDetails?:IList<ObjectShareModel>,ListItemFilters?:ListItemFilterModel[],ContactIdOwner?:string,TotalItemCount?:number,PageNumber?:number,PageSize?:number,SortIndex?:number,SortOrder?:SortOrder}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description Role Id */
RoleId;
/**
* @type {string}
* @description Role Name */
RoleName;
/**
* @type {string}
* @description Role Connection Definition Id */
RoleConnectionDefinitionId;
/**
* @type {string[]}
* @description Contact Types the Role applies to */
ContactTypes;
/**
* @type {boolean}
* @description Does the role require contacts to accept it? */
RequireContactsToAccept;
/** @type {boolean} */
IsPlatformRole;
/** @type {boolean} */
CanAddContacts;
/** @type {boolean} */
CanShareRole;
/** @type {boolean} */
CanEditRole;
/** @type {boolean} */
CanEditContactTypes;
/** @type {UserProfileSummaryModel[]} */
Contacts;
/** @type {IList<ObjectShareModel>} */
ShareDetails;
/** @type {ListItemFilterModel[]} */
ListItemFilters;
/** @type {string} */
ContactIdOwner;
/** @type {number} */
TotalItemCount;
}
export class GetContactRoleDetailsResponse {
/** @param {{ContactRole?:ViewRoleModel,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ViewRoleModel} */
ContactRole;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetContactRoleDetails extends PagedModel {
/** @param {{ContactRoleId?:string,SearchText?:string,PageNumber?:number,PageSize?:number,SortIndex?:number,SortOrder?:SortOrder}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description The Contact Role Guid. Records retrieved will belong to this contact. */
ContactRoleId;
/**
* @type {string}
* @description Text filter */
SearchText;
}
JavaScript GetContactRoleDetails 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/contactrole/{ContactRoleId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
SearchText: String,
PageNumber: 0,
PageSize: 0,
SortIndex: 0,
SortOrder: Ascending
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ContactRole:
{
RoleName: String,
ContactTypes:
[
00000000-0000-0000-0000-000000000000
],
RequireContactsToAccept: False,
IsPlatformRole: False,
CanAddContacts: False,
CanShareRole: False,
CanEditRole: False,
CanEditContactTypes: False,
Contacts:
[
{
UserName: String,
ProfileName: String,
ContactFullName: String,
EmailAddress: String,
EmailSignature: String,
MobileNumber: String,
PhoneNumber: String,
ContactTypeName: String,
FirstName: String,
Surname: String,
Title: String,
LegalName: String,
TradingName: String,
Abn: String,
Acn: String,
Arbn: String,
GstRegistered: False,
ESL: False,
Language: String,
InterpreterRequired: False,
LicenseeNotes: String,
ProfilePhotoUrl: String,
ProfilePhotoThumbnailUrl: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
TimezoneName: String,
PrimaryAddress: String,
IsActiveContact: False
}
],
ListItemFilters:
[
{
FilterName: String,
ListItemIsInFilter: False
}
],
TotalItemCount: 0,
PageNumber: 0,
PageSize: 0,
SortIndex: 0,
SortOrder: Ascending
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}