Platform API

<back to all web services

SearchContactsForRole

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

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; }
    }

}

C# SearchContactsForRole DTOs

POST /api/searchcontactsforroles HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SearchContactsForRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </ContactTypes>
  <ExcludeRole>00000000-0000-0000-0000-000000000000</ExcludeRole>
  <IncludeDetails>false</IncludeDetails>
  <RoleGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </RoleGroups>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </Roles>
  <SearchBy>00000000-0000-0000-0000-000000000000</SearchBy>
  <SearchText>String</SearchText>
</SearchContactsForRole>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SearchContactsForRoleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Contacts xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:ContactSummaryModel>
      <d2p1:ContactFullName>String</d2p1:ContactFullName>
      <d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
      <d2p1:ContactTypeId>00000000-0000-0000-0000-000000000000</d2p1:ContactTypeId>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:EmailAddress>String</d2p1:EmailAddress>
      <d2p1:EmploymentGeographicArea>String</d2p1:EmploymentGeographicArea>
      <d2p1:EmploymentIndustry>String</d2p1:EmploymentIndustry>
      <d2p1:EmploymentRole>String</d2p1:EmploymentRole>
      <d2p1:IsRemovedContact>false</d2p1:IsRemovedContact>
      <d2p1:MobileNumber>String</d2p1:MobileNumber>
      <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
      <d2p1:PrimaryAddress>String</d2p1:PrimaryAddress>
      <d2p1:ProfilePhotoThumbnailUrl>String</d2p1:ProfilePhotoThumbnailUrl>
      <d2p1:ProfilePhotoUrl>String</d2p1:ProfilePhotoUrl>
      <d2p1:TimezoneName>String</d2p1:TimezoneName>
    </d2p1:ContactSummaryModel>
  </Contacts>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</SearchContactsForRoleResponse>