| All Verbs | /api/searchcontactsforroles |
|---|
import Foundation
import ServiceStack
/**
* Search contacts by Name or Email Address, by Role Groups, or by Roles
*/
// @Api(Description="Search contacts by Name or Email Address, by Role Groups, or by Roles")
public class SearchContactsForRole : Codable
{
/**
* Search type: by Name or Email Address, by Role Groups, or by Roles
*/
// @ApiMember(DataType="Guid", Description="Search type: by Name or Email Address, by Role Groups, or by Roles", IsRequired=true, Name="SearchBy")
public var searchBy:String
/**
* Roles that contacts are connected to.
*/
// @ApiMember(DataType="List<Guid>", Description="Roles that contacts are connected to.", Name="Roles")
public var roles:[String]
/**
* Role Groups that contacts are connected to.
*/
// @ApiMember(DataType="List<Guid>", Description="Role Groups that contacts are connected to.", Name="RoleGroups")
public var roleGroups:[String]
/**
* For Search by Name or Email Address, filters contact results by this text value.
*/
// @ApiMember(DataType="string", Description="For Search by Name or Email Address, filters contact results by this text value.", Name="SearchText")
public var searchText:String
/**
* Excludes contacts already connected to this role.
*/
// @ApiMember(DataType="Guid", Description="Excludes contacts already connected to this role.", Name="ExcludeRole")
public var excludeRole:String
/**
* Filters contact results by contact type(s) provided, e.g. Real Persons, Organisations etc. Defaults to real person.
*/
// @ApiMember(DataType="List<Guid>", Description="Filters contact results by contact type(s) provided, e.g. Real Persons, Organisations etc. Defaults to real person.", Name="ContactTypes")
public var contactTypes:[String]
/**
* Determines whether the contact details (Email, mobile number etc.) to be returned.
*/
// @ApiMember(DataType="Bool", Description="Determines whether the contact details (Email, mobile number etc.) to be returned.", Name="IncludeDetails")
public var includeDetails:Bool
required public init(){}
}
public class SearchContactsForRoleResponse : Codable
{
public var contacts:[ContactSummaryModel]
public var responseStatus:ResponseStatus
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 SearchContactsForRole 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/searchcontactsforroles HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Roles:
[
00000000-0000-0000-0000-000000000000
],
RoleGroups:
[
00000000-0000-0000-0000-000000000000
],
SearchText: String,
ContactTypes:
[
00000000-0000-0000-0000-000000000000
],
IncludeDetails: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Contacts:
[
{
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
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}