| All Verbs | /api/contacts/{ContactId}/connectionrequests/received | ||
|---|---|---|---|
| All Verbs | /api/contacts/{ContactId}/connectionrequests/sent |
import Foundation
import ServiceStack
public class GetConnectionRequests : Codable
{
/**
* Contact to get connection requests for
*/
// @ApiMember(Description="Contact to get connection requests for", IsRequired=true, Name="ContactId")
public var contactId:String
/**
* Filter connection requests for the specified contact types
*/
// @ApiMember(Description="Filter connection requests for the specified contact types", IsRequired=true, Name="ContactTypes")
public var contactTypes:[String] = []
/**
* Include ignored connection requests?
*/
// @ApiMember(Description="Include ignored connection requests?", IsRequired=true, Name="IncludeIgnoredRequests")
public var includeIgnoredRequests:Bool
required public init(){}
}
public class GetConnectionRequestsResponse : Codable
{
public var connectionRequests:[ContactConnectionModel]
public var responseStatus:ResponseStatus
required public init(){}
}
public class ContactConnectionModel : Codable
{
/**
* Connection Id (if applicable)
*/
// @ApiMember(DataType="Guid?", Description="Connection Id (if applicable)", Name="ConnectionId")
public var connectionId:String?
/**
* Connection Request Id (if applicable)
*/
// @ApiMember(DataType="Guid?", Description="Connection Request Id (if applicable)", Name="ConnectionRequestId")
public var connectionRequestId:String?
/**
* Details of the contact
*/
// @ApiMember(DataType="ContactSummaryModel", Description="Details of the contact", IsRequired=true, Name="Contact")
public var contact:ContactSummaryModel
/**
* Contact's role Id in the connection
*/
// @ApiMember(DataType="Guid", Description="Contact's role Id in the connection", IsRequired=true, Name="ContactRoleId")
public var contactRoleId:String
/**
* Contact's role name in the connection
*/
// @ApiMember(DataType="string", Description="Contact's role name in the connection", Name="ContactRoleName")
public var contactRoleName:String
/**
* Requestor Contact Id
*/
// @ApiMember(DataType="Guid", Description="Requestor Contact Id", IsRequired=true, Name="RequestorContactId")
public var requestorContactId:String
/**
* Requestor Contact Name
*/
// @ApiMember(DataType="Guid", Description="Requestor Contact Name", Name="RequestorContactName")
public var requestorContactName:String
/**
* Requestor contact's role Id in the connection
*/
// @ApiMember(DataType="Guid", Description="Requestor contact's role Id in the connection", IsRequired=true, Name="RequestorRoleId")
public var requestorRoleId:String
/**
* Requestor's role name in the connection
*/
// @ApiMember(DataType="string", Description="Requestor's role name in the connection", Name="RequestorRoleName")
public var requestorRoleName:String
/**
* Primary role in the connection to display
*/
// @ApiMember(DataType="string", Description="Primary role in the connection to display", Name="PrimaryRoleName")
public var primaryRoleName:String
/**
* Connection Status Id
*/
// @ApiMember(DataType="Guid", Description="Connection Status Id", IsRequired=true, Name="ConnectionStatusId")
public var connectionStatusId:String
/**
* Connection Status Name
*/
// @ApiMember(DataType="string", Description="Connection Status Name", Name="ConnectionStatusName")
public var connectionStatusName:String
/**
* Is this a pending connection request?
*/
// @ApiMember(DataType="bool", Description="Is this a pending connection request?", Name="IsConnectionRequest")
public var isConnectionRequest:Bool
/**
* Is this an incoming connection request?
*/
// @ApiMember(DataType="bool", Description="Is this an incoming connection request?", Name="IsIncoming")
public var isIncoming:Bool
public var fromDate:Date?
/**
* Details of the contact suggesting this connection
*/
// @ApiMember(DataType="ContactSummaryModel", Description="Details of the contact suggesting this connection", IsRequired=true, Name="SuggesterContact")
public var suggesterContact:ContactSummaryModel
/**
* Can this connection be cancelled?
*/
// @ApiMember(DataType="bool", Description="Can this connection be cancelled?", Name="AllowCancel")
public var allowCancel:Bool
/**
* Can this connection be removed?
*/
// @ApiMember(DataType="bool", Description="Can this connection be removed?", Name="AllowRemove")
public var allowRemove:Bool
required public init(){}
}
public class ContactSummaryModel : Codable
{
/**
* Contact linked to the profile
*/
// @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
public var contactId:String
/**
* Full name of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
public var contactFullName:String
/**
* Email Address of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
public var emailAddress:String
/**
* Mobile Number of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Mobile Number of the contact linked to the profile", Name="MobileNumber")
public var mobileNumber:String
/**
* Primary Phone Number of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Primary Phone Number of the contact linked to the profile", Name="PhoneNumber")
public var phoneNumber:String
/**
* Type of contact (person, organisation etc.) linked to the profile
*/
// @ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")
public var contactTypeId:String
/**
* Profile photo of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
public var profilePhotoUrl:String
/**
* Thumbnail photo of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
public var profilePhotoThumbnailUrl:String
/**
* Profile description
*/
// @ApiMember(DataType="string", Description="Profile description", Name="Description")
public var Description:String
/**
* Employment Industry
*/
// @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
public var employmentIndustry:String
/**
* Employment Role
*/
// @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
public var employmentRole:String
/**
* Areas of Work
*/
// @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
public var employmentGeographicArea:String
/**
* Timezone Name
*/
// @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
public var timezoneName:String
/**
* The primary address of the contact
*/
// @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
public var primaryAddress:String
/**
* Have all connections to the contact been removed?
*/
// @ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")
public var isRemovedContact:Bool
required public init(){}
}
Swift 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"}}}