| All Verbs | /api/contacts/{ContactId}/connectionrequests/received | ||
|---|---|---|---|
| All Verbs | /api/contacts/{ContactId}/connectionrequests/sent |
"use strict";
export class ContactSummaryModel {
/** @param {{ContactId?:string,ContactFullName?:string,EmailAddress?:string,MobileNumber?:string,PhoneNumber?:string,ContactTypeId?:string,ProfilePhotoUrl?:string,ProfilePhotoThumbnailUrl?:string,Description?:string,EmploymentIndustry?:string,EmploymentRole?:string,EmploymentGeographicArea?:string,TimezoneName?:string,PrimaryAddress?:string,IsRemovedContact?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Contact linked to the profile */
ContactId;
/**
* @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 Mobile Number of the contact linked to the profile */
MobileNumber;
/**
* @type {string}
* @description Primary 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 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 description */
Description;
/**
* @type {string}
* @description Employment Industry */
EmploymentIndustry;
/**
* @type {string}
* @description Employment Role */
EmploymentRole;
/**
* @type {string}
* @description Areas of Work */
EmploymentGeographicArea;
/**
* @type {string}
* @description Timezone Name */
TimezoneName;
/**
* @type {string}
* @description The primary address of the contact */
PrimaryAddress;
/**
* @type {boolean}
* @description Have all connections to the contact been removed? */
IsRemovedContact;
}
export class ContactConnectionModel {
/** @param {{ConnectionId?:string,ConnectionRequestId?:string,Contact?:ContactSummaryModel,ContactRoleId?:string,ContactRoleName?:string,RequestorContactId?:string,RequestorContactName?:string,RequestorRoleId?:string,RequestorRoleName?:string,PrimaryRoleName?:string,ConnectionStatusId?:string,ConnectionStatusName?:string,IsConnectionRequest?:boolean,IsIncoming?:boolean,FromDate?:string,SuggesterContact?:ContactSummaryModel,AllowCancel?:boolean,AllowRemove?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description Connection Id (if applicable) */
ConnectionId;
/**
* @type {?string}
* @description Connection Request Id (if applicable) */
ConnectionRequestId;
/**
* @type {ContactSummaryModel}
* @description Details of the contact */
Contact;
/**
* @type {string}
* @description Contact's role Id in the connection */
ContactRoleId;
/**
* @type {string}
* @description Contact's role name in the connection */
ContactRoleName;
/**
* @type {string}
* @description Requestor Contact Id */
RequestorContactId;
/**
* @type {string}
* @description Requestor Contact Name */
RequestorContactName;
/**
* @type {string}
* @description Requestor contact's role Id in the connection */
RequestorRoleId;
/**
* @type {string}
* @description Requestor's role name in the connection */
RequestorRoleName;
/**
* @type {string}
* @description Primary role in the connection to display */
PrimaryRoleName;
/**
* @type {string}
* @description Connection Status Id */
ConnectionStatusId;
/**
* @type {string}
* @description Connection Status Name */
ConnectionStatusName;
/**
* @type {boolean}
* @description Is this a pending connection request? */
IsConnectionRequest;
/**
* @type {boolean}
* @description Is this an incoming connection request? */
IsIncoming;
/** @type {?string} */
FromDate;
/**
* @type {ContactSummaryModel}
* @description Details of the contact suggesting this connection */
SuggesterContact;
/**
* @type {boolean}
* @description Can this connection be cancelled? */
AllowCancel;
/**
* @type {boolean}
* @description Can this connection be removed? */
AllowRemove;
}
export class GetConnectionRequestsResponse {
/** @param {{ConnectionRequests?:ContactConnectionModel[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ContactConnectionModel[]} */
ConnectionRequests;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetConnectionRequests {
/** @param {{ContactId?:string,ContactTypes?:string[],IncludeIgnoredRequests?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Contact to get connection requests for */
ContactId;
/**
* @type {string[]}
* @description Filter connection requests for the specified contact types */
ContactTypes = [];
/**
* @type {boolean}
* @description Include ignored connection requests? */
IncludeIgnoredRequests;
}
JavaScript GetConnectionRequests 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/contacts/{ContactId}/connectionrequests/received HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ContactId":"00000000-0000-0000-0000-000000000000","ContactTypes":["00000000-0000-0000-0000-000000000000"],"IncludeIgnoredRequests":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ConnectionRequests":[{"ConnectionId":"00000000000000000000000000000000","ConnectionRequestId":"00000000000000000000000000000000","Contact":{"ContactId":"00000000-0000-0000-0000-000000000000","ContactFullName":"String","EmailAddress":"String","MobileNumber":"String","PhoneNumber":"String","ContactTypeId":"00000000-0000-0000-0000-000000000000","ProfilePhotoUrl":"String","ProfilePhotoThumbnailUrl":"String","Description":"String","EmploymentIndustry":"String","EmploymentRole":"String","EmploymentGeographicArea":"String","TimezoneName":"String","PrimaryAddress":"String","IsRemovedContact":false},"ContactRoleId":"00000000-0000-0000-0000-000000000000","ContactRoleName":"String","RequestorContactId":"00000000-0000-0000-0000-000000000000","RequestorContactName":"String","RequestorRoleId":"00000000-0000-0000-0000-000000000000","RequestorRoleName":"String","PrimaryRoleName":"String","ConnectionStatusId":"00000000-0000-0000-0000-000000000000","ConnectionStatusName":"String","IsConnectionRequest":false,"IsIncoming":false,"FromDate":"0001-01-01T00:00:00.0000000","SuggesterContact":{"ContactId":"00000000-0000-0000-0000-000000000000","ContactFullName":"String","EmailAddress":"String","MobileNumber":"String","PhoneNumber":"String","ContactTypeId":"00000000-0000-0000-0000-000000000000","ProfilePhotoUrl":"String","ProfilePhotoThumbnailUrl":"String","Description":"String","EmploymentIndustry":"String","EmploymentRole":"String","EmploymentGeographicArea":"String","TimezoneName":"String","PrimaryAddress":"String","IsRemovedContact":false},"AllowCancel":false,"AllowRemove":false}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}