Platform API

<back to all web services

SearchContactsForRole

Search contacts by Name or Email Address, by Role Groups, or by Roles

Requires Authentication
The following routes are available for this service:
All Verbs/api/searchcontactsforroles

export class ContactSummaryModel
{
    /** @description Contact linked to the profile */
    // @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
    public ContactId: string;

    /** @description 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 ContactFullName: string;

    /** @description 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 EmailAddress: string;

    /** @description 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 MobileNumber: string;

    /** @description 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 PhoneNumber: string;

    /** @description 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 ContactTypeId: string;

    /** @description Profile photo of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
    public ProfilePhotoUrl: string;

    /** @description Thumbnail photo of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
    public ProfilePhotoThumbnailUrl: string;

    /** @description Profile description */
    // @ApiMember(DataType="string", Description="Profile description", Name="Description")
    public Description: string;

    /** @description Employment Industry */
    // @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
    public EmploymentIndustry: string;

    /** @description Employment Role */
    // @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
    public EmploymentRole: string;

    /** @description Areas of Work */
    // @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
    public EmploymentGeographicArea: string;

    /** @description Timezone Name */
    // @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
    public TimezoneName: string;

    /** @description The primary address of the contact */
    // @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
    public PrimaryAddress: string;

    /** @description Have all connections to the contact been removed? */
    // @ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")
    public IsRemovedContact: boolean;

    public constructor(init?: Partial<ContactSummaryModel>) { (Object as any).assign(this, init); }
}

export class SearchContactsForRoleResponse
{
    public Contacts: ContactSummaryModel[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<SearchContactsForRoleResponse>) { (Object as any).assign(this, init); }
}

/** @description 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")
export class SearchContactsForRole
{
    /** @description 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 SearchBy: string;

    /** @description Roles that contacts are connected to. */
    // @ApiMember(DataType="List<Guid>", Description="Roles that contacts are connected to.", Name="Roles")
    public Roles: string[];

    /** @description Role Groups that contacts are connected to. */
    // @ApiMember(DataType="List<Guid>", Description="Role Groups that contacts are connected to.", Name="RoleGroups")
    public RoleGroups: string[];

    /** @description 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 SearchText: string;

    /** @description Excludes contacts already connected to this role. */
    // @ApiMember(DataType="Guid", Description="Excludes contacts already connected to this role.", Name="ExcludeRole")
    public ExcludeRole: string;

    /** @description 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 ContactTypes: string[];

    /** @description 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 IncludeDetails: boolean;

    public constructor(init?: Partial<SearchContactsForRole>) { (Object as any).assign(this, init); }
}

TypeScript SearchContactsForRole DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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"}}}