| All Verbs | /api/contacts/{ContactId}/connections |
|---|
import Foundation
import ServiceStack
/**
* Get connections to the specified contact for the requestor contact
*/
// @Api(Description="Get connections to the specified contact for the requestor contact")
public class GetConnectionsToContact : PagedModel
{
/**
* Contact Id to get connections for
*/
// @ApiMember(DataType="Guid", Description="Contact Id to get connections for", IsRequired=true, Name="ContactId")
public var contactId:String
/**
* Type of the contact to get connections for (i.e. Real/ virtual Person/ Organisation)
*/
// @ApiMember(DataType="Guid", Description="Type of the contact to get connections for (i.e. Real/ virtual Person/ Organisation)", IsRequired=true, Name="ContactTypeId")
public var contactTypeId:String
/**
* Contact Id requesting the details - Current user or licensee
*/
// @ApiMember(DataType="Guid", Description="Contact Id requesting the details - Current user or licensee", IsRequired=true, Name="RequestorContactId")
public var requestorContactId:String
/**
* Return all connections or paged results?
*/
// @ApiMember(Description="Return all connections or paged results?", Name="IsPagedMode")
public var isPagedMode:Bool
/**
* Option to return removed connections
*/
// @ApiMember(Description="Option to return removed connections", Name="IncludeRemoved")
public var includeRemoved:Bool
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case contactId
case contactTypeId
case requestorContactId
case isPagedMode
case includeRemoved
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
contactId = try container.decodeIfPresent(String.self, forKey: .contactId)
contactTypeId = try container.decodeIfPresent(String.self, forKey: .contactTypeId)
requestorContactId = try container.decodeIfPresent(String.self, forKey: .requestorContactId)
isPagedMode = try container.decodeIfPresent(Bool.self, forKey: .isPagedMode)
includeRemoved = try container.decodeIfPresent(Bool.self, forKey: .includeRemoved)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if contactId != nil { try container.encode(contactId, forKey: .contactId) }
if contactTypeId != nil { try container.encode(contactTypeId, forKey: .contactTypeId) }
if requestorContactId != nil { try container.encode(requestorContactId, forKey: .requestorContactId) }
if isPagedMode != nil { try container.encode(isPagedMode, forKey: .isPagedMode) }
if includeRemoved != nil { try container.encode(includeRemoved, forKey: .includeRemoved) }
}
}
public class PagedModel : Codable
{
/**
* Page Number to retrieve
*/
// @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
public var pageNumber:Int
/**
* Number of records to retrieve
*/
// @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
public var pageSize:Int
/**
* Index of field to sort results by
*/
// @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
public var sortIndex:Int
/**
* Sort Order - Ascending or Descending
*/
// @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
public var sortOrder:SortOrder
required public init(){}
}
public enum SortOrder : String, Codable
{
case Ascending
case Descending
}
// @ApiResponse(Description="Connections to the specified contact for the requestor contact")
public class GetConnectionsToContactResponse : Codable
{
public var connections:[ContactConnectionModel]
public var totalConnections:Int
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 GetConnectionsToContact 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/contacts/{ContactId}/connections HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
IsPagedMode: False,
IncludeRemoved: False,
PageNumber: 0,
PageSize: 0,
SortIndex: 0,
SortOrder: Ascending
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Connections:
[
{
ConnectionId: 00000000000000000000000000000000,
ConnectionRequestId: 00000000000000000000000000000000,
Contact:
{
ContactFullName: String,
EmailAddress: String,
MobileNumber: String,
PhoneNumber: String,
ProfilePhotoUrl: String,
ProfilePhotoThumbnailUrl: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
TimezoneName: String,
PrimaryAddress: String,
IsRemovedContact: False
},
ContactRoleName: String,
RequestorContactName: String,
RequestorRoleName: String,
PrimaryRoleName: String,
ConnectionStatusName: String,
IsConnectionRequest: False,
IsIncoming: False,
FromDate: 0001-01-01,
SuggesterContact:
{
ContactFullName: String,
EmailAddress: String,
MobileNumber: String,
PhoneNumber: String,
ProfilePhotoUrl: String,
ProfilePhotoThumbnailUrl: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
TimezoneName: String,
PrimaryAddress: String,
IsRemovedContact: False
},
AllowCancel: False,
AllowRemove: False
}
],
TotalConnections: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}