Platform API

<back to all web services

GetContactGroups

Get customers for current licensee

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 ContactGroupConnectionModel
        : UserProfileSummaryModel
    {
        ///<summary>
        ///Contact Group Id
        ///</summary>
        [ApiMember(DataType="Guid", Description="Contact Group Id", Name="ContactGroupId")]
        public virtual Guid ContactGroupId { get; set; }

        ///<summary>
        ///Connection id of the contact in the group
        ///</summary>
        [ApiMember(DataType="string", Description="Connection id of the contact in the group", Name="ContactGroupConnectionId")]
        public virtual Guid ContactGroupConnectionId { get; set; }

        ///<summary>
        ///The Id of the Role this contact is connected to the group with.
        ///</summary>
        [ApiMember(DataType="string", Description="The Id of the Role this contact is connected to the group with.", Name="ConnectionRoleId")]
        public virtual Guid ConnectionRoleId { get; set; }

        ///<summary>
        ///Order of contacts within a group, the primary contact will have an index of 1.
        ///</summary>
        [ApiMember(DataType="int", Description="Order of contacts within a group, the primary contact will have an index of 1.", Name="Index")]
        public virtual int Index { get; set; }

        ///<summary>
        ///List of roles that the contact in the contact group has across appliances for e.g. Platform Customer, Nexus customer etc.
        ///</summary>
        [ApiMember(DataType="string", Description="List of roles that the contact in the contact group has across appliances for e.g. Platform Customer, Nexus customer etc.", Name="ContactRoles")]
        public virtual List<RoleModel> ContactRoles { get; set; }
    }

    public partial class ContactGroupModel
    {
        ///<summary>
        ///Contact Group Id
        ///</summary>
        [ApiMember(DataType="Guid", Description="Contact Group Id", Name="ContactGroupId")]
        public virtual Guid ContactGroupId { get; set; }

        ///<summary>
        ///Contact Group Name
        ///</summary>
        [ApiMember(DataType="string", Description="Contact Group Name", Name="Name")]
        public virtual string Name { get; set; }

        ///<summary>
        ///Contact Group Reference
        ///</summary>
        [ApiMember(DataType="string", Description="Contact Group Reference", Name="Reference")]
        public virtual string Reference { get; set; }

        ///<summary>
        ///Group Role Id for e.g. Customer
        ///</summary>
        [ApiMember(DataType="Guid", Description="Group Role Id for e.g. Customer", Name="GroupRoleId")]
        public virtual Guid GroupRoleId { get; set; }

        ///<summary>
        ///Primary contact in the group
        ///</summary>
        [ApiMember(DataType="string", Description="Primary contact in the group", Name="PrimaryContactName")]
        public virtual string PrimaryContactName { get; set; }

        ///<summary>
        ///Contact Id of the primary contact in the group
        ///</summary>
        [ApiMember(DataType="Guid", Description="Contact Id of the primary contact in the group", Name="PrimaryContactId")]
        public virtual Guid PrimaryContactId { get; set; }

        ///<summary>
        ///Profile photo url of the primary contact in the group
        ///</summary>
        [ApiMember(DataType="string", Description="Profile photo url of the primary contact in the group", Name="PrimaryContactPhotoUrl")]
        public virtual string PrimaryContactPhotoUrl { get; set; }

        ///<summary>
        ///Profile photo thumbnail url of the primary contact in the group
        ///</summary>
        [ApiMember(DataType="string", Description="Profile photo thumbnail url of the primary contact in the group", Name="PrimaryContactThumbnailUrl")]
        public virtual string PrimaryContactThumbnailUrl { get; set; }

        ///<summary>
        ///Number of contacts in the group
        ///</summary>
        [ApiMember(DataType="int", Description="Number of contacts in the group", Name="NumberOfContacts")]
        public virtual int NumberOfContacts { get; set; }

        ///<summary>
        ///Record Status of contact group
        ///</summary>
        [ApiMember(DataType="string", Description="Record Status of contact group", Name="RecordStatus")]
        public virtual string RecordStatus { get; set; }

        ///<summary>
        ///Details of contact in the contact group
        ///</summary>
        [ApiMember(DataType="List", Description="Details of contact in the contact group", Name="Contacts")]
        public virtual List<ContactGroupConnectionModel> Contacts { get; set; }

        ///<summary>
        ///Details of projects for the contact group
        ///</summary>
        [ApiMember(DataType="List", Description="Details of projects for the contact group", Name="Projects")]
        public virtual List<CustomerProjectModel> Projects { get; set; }
    }

    public partial class CustomerProjectModel
    {
        public virtual Guid ProjectId { get; set; }
        public virtual string Name { get; set; }
        public virtual string ProjectAddress { get; set; }
        public virtual Guid? ManagerContactId { get; set; }
        public virtual string ManagerContactName { get; set; }
        public virtual string ManagerProfilePhotoUrl { get; set; }
        public virtual string ManagerProfilePhotoThumbnailUrl { get; set; }
        public virtual Guid? SupervisorContactId { get; set; }
        public virtual string SupervisorContactName { get; set; }
        public virtual string SupervisorProfilePhotoUrl { get; set; }
        public virtual string SupervisorProfilePhotoThumbnailUrl { get; set; }
        public virtual Guid? CustomerServiceContactId { get; set; }
        public virtual string CustomerServiceContactName { get; set; }
        public virtual string CustomerServiceProfilePhotoUrl { get; set; }
        public virtual string CustomerServiceProfilePhotoThumbnail { get; set; }
    }

    public partial class PagedModel
    {
        ///<summary>
        ///Page Number to retrieve
        ///</summary>
        [ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")]
        public virtual int PageNumber { get; set; }

        ///<summary>
        ///Number of records to retrieve
        ///</summary>
        [ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")]
        public virtual int PageSize { get; set; }

        ///<summary>
        ///Index of field to sort results by
        ///</summary>
        [ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")]
        public virtual int SortIndex { get; set; }

        ///<summary>
        ///Sort Order - Ascending or Descending
        ///</summary>
        [ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")]
        public virtual SortOrder SortOrder { get; set; }
    }

    public partial class RoleModel
    {
        ///<summary>
        ///Role Id
        ///</summary>
        [ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")]
        public virtual Guid RoleId { get; set; }

        ///<summary>
        ///Role Name
        ///</summary>
        [ApiMember(DataType="string", Description="Role Name", Name="RoleName")]
        public virtual string RoleName { get; set; }

        ///<summary>
        ///Is the role a licensee role?
        ///</summary>
        [ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")]
        public virtual bool IsLicenseeRole { get; set; }

        ///<summary>
        ///Is manage contacts role?
        ///</summary>
        [ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")]
        public virtual bool IsManageContacts { get; set; }

        ///<summary>
        ///Is the role a Platform role?
        ///</summary>
        [ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")]
        public virtual bool IsPlatformRole { get; set; }

        ///<summary>
        ///Is the role a services role?
        ///</summary>
        [ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")]
        public virtual bool IsServiceRole { get; set; }

        ///<summary>
        ///Is the role a customer role?
        ///</summary>
        [ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")]
        public virtual bool IsCustomerRole { get; set; }

        ///<summary>
        ///Is the role a functional role?
        ///</summary>
        [ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")]
        public virtual bool IsFunctionalRole { get; set; }

        ///<summary>
        ///Is the role an auto-accept role?
        ///</summary>
        [ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")]
        public virtual bool IsRequestAutoAccepted { get; set; }

        ///<summary>
        ///Suite that the role belongs to
        ///</summary>
        [ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")]
        public virtual Guid SuiteId { get; set; }

        ///<summary>
        ///Suite that the role belongs to
        ///</summary>
        [ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")]
        public virtual string SuiteName { get; set; }

        ///<summary>
        ///'A' (Active) or 'I' (Inactive)
        ///</summary>
        [ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")]
        public virtual string RecordStatus { get; set; }

        ///<summary>
        ///Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.", Name="ObjectConnectionId")]
        public virtual Guid ObjectConnectionId { get; set; }
    }

    public enum SortOrder
    {
        Ascending,
        Descending,
    }

    public partial class UserProfileSummaryModel
    {
        ///<summary>
        ///User Profile Id
        ///</summary>
        [ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")]
        public virtual Guid UserProfileId { get; set; }

        ///<summary>
        ///User linked to the profile
        ///</summary>
        [ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")]
        public virtual Guid UserId { get; set; }

        ///<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>
        ///User linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="User linked to the profile", Name="UserName")]
        public virtual string UserName { get; set; }

        ///<summary>
        ///User Profile Name
        ///</summary>
        [ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")]
        public virtual string ProfileName { 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>
        ///Email signature of the contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Email signature of the contact linked to the profile", Name="EmailSignature")]
        public virtual string EmailSignature { 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>
        ///Phone number of the contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="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>
        ///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="ContactTypeName")]
        public virtual string ContactTypeName { get; set; }

        ///<summary>
        ///First name of the contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")]
        public virtual string FirstName { get; set; }

        ///<summary>
        ///Surname of the contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Surname of the contact linked to the profile", Name="Surname")]
        public virtual string Surname { get; set; }

        ///<summary>
        ///Title of contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Title of contact linked to the profile", Name="Title")]
        public virtual string Title { get; set; }

        ///<summary>
        ///Legal name of contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")]
        public virtual string LegalName { get; set; }

        ///<summary>
        ///Trading name of contact linked to the profile
        ///</summary>
        [ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")]
        public virtual string TradingName { get; set; }

        ///<summary>
        ///Australian Business Number
        ///</summary>
        [ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")]
        public virtual string Abn { get; set; }

        ///<summary>
        ///Australian Company Number
        ///</summary>
        [ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")]
        public virtual string Acn { get; set; }

        ///<summary>
        ///Australian Registered Body Number
        ///</summary>
        [ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")]
        public virtual string Arbn { get; set; }

        ///<summary>
        ///Indicates if the Contact is registered for GST.
        ///</summary>
        [ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")]
        public virtual bool GstRegistered { get; set; }

        ///<summary>
        ///True if english is a secondary language for the contact.
        ///</summary>
        [ApiMember(DataType="bool", Description="True if english is a secondary language for the contact.", Name="ESL", ParameterType="query")]
        public virtual bool ESL { get; set; }

        ///<summary>
        ///Language that is the primary language for the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="Language that is the primary language for the contact.", Name="Language", ParameterType="query")]
        public virtual string Language { get; set; }

        ///<summary>
        ///True if an interpreter is required.
        ///</summary>
        [ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")]
        public virtual bool InterpreterRequired { get; set; }

        ///<summary>
        ///Licensee specific notes about the contact.
        ///</summary>
        [ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")]
        public virtual string LicenseeNotes { 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 photo id of contact linked to the profile
        ///</summary>
        [ApiMember(DataType="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")]
        public virtual Guid ProfileImageId { 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>
        ///The contacts timezone.
        ///</summary>
        [ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")]
        public virtual Guid Timezone { 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>
        ///Is this an active contact? Or an inactive contact (deleted account)?
        ///</summary>
        [ApiMember(DataType="bool", Description="Is this an active contact? Or an inactive contact (deleted account)?", Name="IsActiveContact")]
        public virtual bool IsActiveContact { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Get customers for current licensee
    ///</summary>
    [Api(Description="Get customers for current licensee")]
    public partial class GetContactGroups
        : PagedModel
    {
        ///<summary>
        ///Get contactGroups for the specified contact
        ///</summary>
        [ApiMember(Description="Get contactGroups for the specified contact", Name="ContactId")]
        public virtual Guid ContactId { get; set; }

        ///<summary>
        ///Specific search text to search for i.e. Contact Name, Employment Details etc.
        ///</summary>
        [ApiMember(DataType="string", Description="Specific search text to search for i.e. Contact Name, Employment Details etc.", Name="SearchText")]
        public virtual string SearchText { get; set; }

        ///<summary>
        ///Set the Contact Group Role Id to only retrieve groups of that type. If ContactId is not set this is mandatory.
        ///</summary>
        [ApiMember(Description="Set the Contact Group Role Id to only retrieve groups of that type. If ContactId is not set this is mandatory.", Name="ContactGroupRoleId")]
        public virtual Guid ContactGroupRoleId { get; set; }

        ///<summary>
        ///Include active contact groups
        ///</summary>
        [ApiMember(Description="Include active contact groups", Name="IncludeActive")]
        public virtual bool IncludeActive { get; set; }

        ///<summary>
        ///Include archived contact groups
        ///</summary>
        [ApiMember(Description="Include archived contact groups", Name="IncludeArchived")]
        public virtual bool IncludeArchived { get; set; }
    }

    [ApiResponse(Description="Get contact groups for current licensee")]
    public partial class GetContactGroupsResponse
    {
        public virtual List<ContactGroupModel> ContactGroups { get; set; }
        ///<summary>
        ///Count of total groups.
        ///</summary>
        [ApiMember(DataType="int", Description="Count of total groups.", Name="TotalGroups")]
        public virtual int TotalGroups { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetContactGroups DTOs

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

{"ContactId":"00000000-0000-0000-0000-000000000000","SearchText":"String","ContactGroupRoleId":"00000000-0000-0000-0000-000000000000","IncludeActive":false,"IncludeArchived":false,"PageNumber":0,"PageSize":0,"SortIndex":0,"SortOrder":"Ascending"}

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

{"ContactGroups":[{"ContactGroupId":"00000000-0000-0000-0000-000000000000","Name":"String","Reference":"String","GroupRoleId":"00000000-0000-0000-0000-000000000000","PrimaryContactName":"String","PrimaryContactId":"00000000-0000-0000-0000-000000000000","PrimaryContactPhotoUrl":"String","PrimaryContactThumbnailUrl":"String","NumberOfContacts":0,"RecordStatus":"String","Contacts":[{"ContactGroupId":"00000000-0000-0000-0000-000000000000","ContactGroupConnectionId":"00000000-0000-0000-0000-000000000000","ConnectionRoleId":"00000000-0000-0000-0000-000000000000","Index":0,"ContactRoles":[{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","IsLicenseeRole":false,"IsManageContacts":false,"IsPlatformRole":false,"IsServiceRole":false,"IsCustomerRole":false,"IsFunctionalRole":false,"IsRequestAutoAccepted":false,"SuiteId":"00000000-0000-0000-0000-000000000000","SuiteName":"String","RecordStatus":"String","ObjectConnectionId":"00000000-0000-0000-0000-000000000000"}],"UserProfileId":"00000000-0000-0000-0000-000000000000","UserId":"00000000-0000-0000-0000-000000000000","ContactId":"00000000-0000-0000-0000-000000000000","UserName":"String","ProfileName":"String","ContactFullName":"String","EmailAddress":"String","EmailSignature":"String","MobileNumber":"String","PhoneNumber":"String","ContactTypeId":"00000000-0000-0000-0000-000000000000","ContactTypeName":"String","FirstName":"String","Surname":"String","Title":"String","LegalName":"String","TradingName":"String","Abn":"String","Acn":"String","Arbn":"String","GstRegistered":false,"ESL":false,"Language":"String","InterpreterRequired":false,"LicenseeNotes":"String","ProfilePhotoUrl":"String","ProfilePhotoThumbnailUrl":"String","ProfileImageId":"00000000-0000-0000-0000-000000000000","Description":"String","EmploymentIndustry":"String","EmploymentRole":"String","EmploymentGeographicArea":"String","Timezone":"00000000-0000-0000-0000-000000000000","TimezoneName":"String","PrimaryAddress":"String","IsActiveContact":false}],"Projects":[{"ProjectId":"00000000-0000-0000-0000-000000000000","Name":"String","ProjectAddress":"String","ManagerContactId":"00000000000000000000000000000000","ManagerContactName":"String","ManagerProfilePhotoUrl":"String","ManagerProfilePhotoThumbnailUrl":"String","SupervisorContactId":"00000000000000000000000000000000","SupervisorContactName":"String","SupervisorProfilePhotoUrl":"String","SupervisorProfilePhotoThumbnailUrl":"String","CustomerServiceContactId":"00000000000000000000000000000000","CustomerServiceContactName":"String","CustomerServiceProfilePhotoUrl":"String","CustomerServiceProfilePhotoThumbnail":"String"}]}],"TotalGroups":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}