| 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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<GetConnectionRequests xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactId>00000000-0000-0000-0000-000000000000</ContactId>
<ContactTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</ContactTypes>
<IncludeIgnoredRequests>false</IncludeIgnoredRequests>
</GetConnectionRequests>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetConnectionRequestsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ConnectionRequests xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:ContactConnectionModel>
<d2p1:AllowCancel>false</d2p1:AllowCancel>
<d2p1:AllowRemove>false</d2p1:AllowRemove>
<d2p1:ConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ConnectionId>
<d2p1:ConnectionRequestId>00000000-0000-0000-0000-000000000000</d2p1:ConnectionRequestId>
<d2p1:ConnectionStatusId>00000000-0000-0000-0000-000000000000</d2p1:ConnectionStatusId>
<d2p1:ConnectionStatusName>String</d2p1:ConnectionStatusName>
<d2p1:Contact>
<d2p1:ContactFullName>String</d2p1:ContactFullName>
<d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
<d2p1:ContactTypeId>00000000-0000-0000-0000-000000000000</d2p1:ContactTypeId>
<d2p1:Description>String</d2p1:Description>
<d2p1:EmailAddress>String</d2p1:EmailAddress>
<d2p1:EmploymentGeographicArea>String</d2p1:EmploymentGeographicArea>
<d2p1:EmploymentIndustry>String</d2p1:EmploymentIndustry>
<d2p1:EmploymentRole>String</d2p1:EmploymentRole>
<d2p1:IsRemovedContact>false</d2p1:IsRemovedContact>
<d2p1:MobileNumber>String</d2p1:MobileNumber>
<d2p1:PhoneNumber>String</d2p1:PhoneNumber>
<d2p1:PrimaryAddress>String</d2p1:PrimaryAddress>
<d2p1:ProfilePhotoThumbnailUrl>String</d2p1:ProfilePhotoThumbnailUrl>
<d2p1:ProfilePhotoUrl>String</d2p1:ProfilePhotoUrl>
<d2p1:TimezoneName>String</d2p1:TimezoneName>
</d2p1:Contact>
<d2p1:ContactRoleId>00000000-0000-0000-0000-000000000000</d2p1:ContactRoleId>
<d2p1:ContactRoleName>String</d2p1:ContactRoleName>
<d2p1:FromDate>0001-01-01T00:00:00</d2p1:FromDate>
<d2p1:IsIncoming>false</d2p1:IsIncoming>
<d2p1:PrimaryRoleName>String</d2p1:PrimaryRoleName>
<d2p1:RequestorContactId>00000000-0000-0000-0000-000000000000</d2p1:RequestorContactId>
<d2p1:RequestorContactName>String</d2p1:RequestorContactName>
<d2p1:RequestorRoleId>00000000-0000-0000-0000-000000000000</d2p1:RequestorRoleId>
<d2p1:RequestorRoleName>String</d2p1:RequestorRoleName>
<d2p1:SuggesterContact>
<d2p1:ContactFullName>String</d2p1:ContactFullName>
<d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
<d2p1:ContactTypeId>00000000-0000-0000-0000-000000000000</d2p1:ContactTypeId>
<d2p1:Description>String</d2p1:Description>
<d2p1:EmailAddress>String</d2p1:EmailAddress>
<d2p1:EmploymentGeographicArea>String</d2p1:EmploymentGeographicArea>
<d2p1:EmploymentIndustry>String</d2p1:EmploymentIndustry>
<d2p1:EmploymentRole>String</d2p1:EmploymentRole>
<d2p1:IsRemovedContact>false</d2p1:IsRemovedContact>
<d2p1:MobileNumber>String</d2p1:MobileNumber>
<d2p1:PhoneNumber>String</d2p1:PhoneNumber>
<d2p1:PrimaryAddress>String</d2p1:PrimaryAddress>
<d2p1:ProfilePhotoThumbnailUrl>String</d2p1:ProfilePhotoThumbnailUrl>
<d2p1:ProfilePhotoUrl>String</d2p1:ProfilePhotoUrl>
<d2p1:TimezoneName>String</d2p1:TimezoneName>
</d2p1:SuggesterContact>
</d2p1:ContactConnectionModel>
</ConnectionRequests>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</GetConnectionRequestsResponse>