| All Verbs | /api/searchcontactsforroles |
|---|
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ContactSummaryModel() =
///<summary>
///Contact linked to the profile
///</summary>
[<ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")>]
member val ContactId:Guid = new Guid() with get,set
///<summary>
///Full name of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")>]
member val ContactFullName:String = null with get,set
///<summary>
///Email Address of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")>]
member val EmailAddress:String = null with get,set
///<summary>
///Mobile Number of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Mobile Number of the contact linked to the profile", Name="MobileNumber")>]
member val MobileNumber:String = null with get,set
///<summary>
///Primary Phone Number of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Primary Phone Number of the contact linked to the profile", Name="PhoneNumber")>]
member val PhoneNumber:String = null with get,set
///<summary>
///Type of contact (person, organisation etc.) linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")>]
member val ContactTypeId:Guid = new Guid() with get,set
///<summary>
///Profile photo of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")>]
member val ProfilePhotoUrl:String = null with get,set
///<summary>
///Thumbnail photo of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")>]
member val ProfilePhotoThumbnailUrl:String = null with get,set
///<summary>
///Profile description
///</summary>
[<ApiMember(DataType="string", Description="Profile description", Name="Description")>]
member val Description:String = null with get,set
///<summary>
///Employment Industry
///</summary>
[<ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")>]
member val EmploymentIndustry:String = null with get,set
///<summary>
///Employment Role
///</summary>
[<ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")>]
member val EmploymentRole:String = null with get,set
///<summary>
///Areas of Work
///</summary>
[<ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")>]
member val EmploymentGeographicArea:String = null with get,set
///<summary>
///Timezone Name
///</summary>
[<ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")>]
member val TimezoneName:String = null with get,set
///<summary>
///The primary address of the contact
///</summary>
[<ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")>]
member val PrimaryAddress:String = null with get,set
///<summary>
///Have all connections to the contact been removed?
///</summary>
[<ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")>]
member val IsRemovedContact:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type SearchContactsForRoleResponse() =
member val Contacts:ResizeArray<ContactSummaryModel> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Search contacts by Name or Email Address, by Role Groups, or by Roles
///</summary>
[<Api(Description="Search contacts by Name or Email Address, by Role Groups, or by Roles")>]
[<AllowNullLiteral>]
type SearchContactsForRole() =
///<summary>
///Search type: by Name or Email Address, by Role Groups, or by Roles
///</summary>
[<ApiMember(DataType="Guid", Description="Search type: by Name or Email Address, by Role Groups, or by Roles", IsRequired=true, Name="SearchBy")>]
member val SearchBy:Guid = new Guid() with get,set
///<summary>
///Roles that contacts are connected to.
///</summary>
[<ApiMember(DataType="List<Guid>", Description="Roles that contacts are connected to.", Name="Roles")>]
member val Roles:ResizeArray<Guid> = null with get,set
///<summary>
///Role Groups that contacts are connected to.
///</summary>
[<ApiMember(DataType="List<Guid>", Description="Role Groups that contacts are connected to.", Name="RoleGroups")>]
member val RoleGroups:ResizeArray<Guid> = null with get,set
///<summary>
///For Search by Name or Email Address, filters contact results by this text value.
///</summary>
[<ApiMember(DataType="string", Description="For Search by Name or Email Address, filters contact results by this text value.", Name="SearchText")>]
member val SearchText:String = null with get,set
///<summary>
///Excludes contacts already connected to this role.
///</summary>
[<ApiMember(DataType="Guid", Description="Excludes contacts already connected to this role.", Name="ExcludeRole")>]
member val ExcludeRole:Guid = new Guid() with get,set
///<summary>
///Filters contact results by contact type(s) provided, e.g. Real Persons, Organisations etc. Defaults to real person.
///</summary>
[<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")>]
member val ContactTypes:ResizeArray<Guid> = null with get,set
///<summary>
///Determines whether the contact details (Email, mobile number etc.) to be returned.
///</summary>
[<ApiMember(DataType="Bool", Description="Determines whether the contact details (Email, mobile number etc.) to be returned.", Name="IncludeDetails")>]
member val IncludeDetails:Boolean = new Boolean() with get,set
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
}
}
}