| All Verbs | /api/searchcontactsforroles |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;
namespace Eros.Saguna.Common.WebAPIModel.Models
{
public partial class ContactSummaryModel
{
///<summary>
///Contact linked to the profile
///</summary>
[ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")]
public virtual Guid ContactId { 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")]
public virtual string ContactFullName { 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")]
public virtual string EmailAddress { 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")]
public virtual string MobileNumber { 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")]
public virtual string PhoneNumber { 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")]
public virtual Guid ContactTypeId { 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")]
public virtual string ProfilePhotoUrl { 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")]
public virtual string ProfilePhotoThumbnailUrl { get; set; }
///<summary>
///Profile description
///</summary>
[ApiMember(DataType="string", Description="Profile description", Name="Description")]
public virtual string Description { get; set; }
///<summary>
///Employment Industry
///</summary>
[ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")]
public virtual string EmploymentIndustry { get; set; }
///<summary>
///Employment Role
///</summary>
[ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")]
public virtual string EmploymentRole { get; set; }
///<summary>
///Areas of Work
///</summary>
[ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")]
public virtual string EmploymentGeographicArea { get; set; }
///<summary>
///Timezone Name
///</summary>
[ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")]
public virtual string TimezoneName { get; set; }
///<summary>
///The primary address of the contact
///</summary>
[ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")]
public virtual string PrimaryAddress { 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")]
public virtual bool IsRemovedContact { get; set; }
}
}
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
///<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")]
public partial class 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")]
public virtual Guid SearchBy { get; set; }
///<summary>
///Roles that contacts are connected to.
///</summary>
[ApiMember(DataType="List<Guid>", Description="Roles that contacts are connected to.", Name="Roles")]
public virtual List<Guid> Roles { 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")]
public virtual List<Guid> RoleGroups { 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")]
public virtual string SearchText { get; set; }
///<summary>
///Excludes contacts already connected to this role.
///</summary>
[ApiMember(DataType="Guid", Description="Excludes contacts already connected to this role.", Name="ExcludeRole")]
public virtual Guid ExcludeRole { 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")]
public virtual List<Guid> ContactTypes { 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")]
public virtual bool IncludeDetails { get; set; }
}
public partial class SearchContactsForRoleResponse
{
public virtual List<ContactSummaryModel> Contacts { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"SearchBy":"00000000-0000-0000-0000-000000000000","Roles":["00000000-0000-0000-0000-000000000000"],"RoleGroups":["00000000-0000-0000-0000-000000000000"],"SearchText":"String","ExcludeRole":"00000000-0000-0000-0000-000000000000","ContactTypes":["00000000-0000-0000-0000-000000000000"],"IncludeDetails":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Contacts":[{"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}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}