| All Verbs | /api/contacts/{ContactId}/connectionrequests/received | ||
|---|---|---|---|
| All Verbs | /api/contacts/{ContactId}/connectionrequests/sent |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactId | path | Guid | Yes | Contact to get connection requests for |
| ContactTypes | query | List<Guid> | Yes | Filter connection requests for the specified contact types |
| IncludeIgnoredRequests | query | bool | Yes | Include ignored connection requests? |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConnectionRequests | form | List<ContactConnectionModel> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConnectionId | form | Guid? | No | Connection Id (if applicable) |
| ConnectionRequestId | form | Guid? | No | Connection Request Id (if applicable) |
| Contact | form | ContactSummaryModel | Yes | Details of the contact |
| ContactRoleId | form | Guid | Yes | Contact's role Id in the connection |
| ContactRoleName | form | string | No | Contact's role name in the connection |
| RequestorContactId | form | Guid | Yes | Requestor Contact Id |
| RequestorContactName | form | Guid | No | Requestor Contact Name |
| RequestorRoleId | form | Guid | Yes | Requestor contact's role Id in the connection |
| RequestorRoleName | form | string | No | Requestor's role name in the connection |
| PrimaryRoleName | form | string | No | Primary role in the connection to display |
| ConnectionStatusId | form | Guid | Yes | Connection Status Id |
| ConnectionStatusName | form | string | No | Connection Status Name |
| IsConnectionRequest | form | bool | No | Is this a pending connection request? |
| IsIncoming | form | bool | No | Is this an incoming connection request? |
| FromDate | form | DateTime? | No | |
| SuggesterContact | form | ContactSummaryModel | Yes | Details of the contact suggesting this connection |
| AllowCancel | form | bool | No | Can this connection be cancelled? |
| AllowRemove | form | bool | No | Can this connection be removed? |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactId | form | Guid | No | Contact linked to the profile |
| ContactFullName | form | string | No | Full name of the contact linked to the profile |
| EmailAddress | form | string | No | Email Address of the contact linked to the profile |
| MobileNumber | form | string | No | Mobile Number of the contact linked to the profile |
| PhoneNumber | form | string | No | Primary Phone Number of the contact linked to the profile |
| ContactTypeId | form | string | No | Type of contact (person, organisation etc.) linked to the profile |
| ProfilePhotoUrl | form | string | No | Profile photo of contact linked to the profile |
| ProfilePhotoThumbnailUrl | form | string | No | Thumbnail photo of contact linked to the profile |
| Description | form | string | No | Profile description |
| EmploymentIndustry | form | string | No | Employment Industry |
| EmploymentRole | form | string | No | Employment Role |
| EmploymentGeographicArea | form | string | No | Areas of Work |
| TimezoneName | query | string | No | Timezone Name |
| PrimaryAddress | query | string | No | The primary address of the contact |
| IsRemovedContact | form | bool | No | Have all connections to the contact been removed? |
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"}}}