Platform API

<back to all web services

GetContactGroups

Get customers for current licensee

Requires Authentication
The following routes are available for this service:
All Verbs/api/contactgroups
All Verbs/api/contactgroups/{ContactId}

export enum SortOrder
{
    Ascending = 'Ascending',
    Descending = 'Descending',
}

export class PagedModel
{
    /** @description Page Number to retrieve */
    // @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
    public PageNumber: number;

    /** @description Number of records to retrieve */
    // @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
    public PageSize: number;

    /** @description Index of field to sort results by */
    // @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
    public SortIndex: number;

    /** @description Sort Order - Ascending or Descending */
    // @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
    public SortOrder: SortOrder;

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

export class UserProfileSummaryModel
{
    /** @description User Profile Id */
    // @ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")
    public UserProfileId: string;

    /** @description User linked to the profile */
    // @ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")
    public UserId: string;

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

    /** @description User linked to the profile */
    // @ApiMember(DataType="string", Description="User linked to the profile", Name="UserName")
    public UserName: string;

    /** @description User Profile Name */
    // @ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")
    public ProfileName: 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 Email signature of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="Email signature of the contact linked to the profile", Name="EmailSignature")
    public EmailSignature: 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 Phone number of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="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 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="ContactTypeName")
    public ContactTypeName: string;

    /** @description First name of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")
    public FirstName: string;

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

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

    /** @description Legal name of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")
    public LegalName: string;

    /** @description Trading name of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")
    public TradingName: string;

    /** @description Australian Business Number */
    // @ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")
    public Abn: string;

    /** @description Australian Company Number */
    // @ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")
    public Acn: string;

    /** @description Australian Registered Body Number */
    // @ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")
    public Arbn: string;

    /** @description Indicates if the Contact is registered for GST. */
    // @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")
    public GstRegistered: boolean;

    /** @description True if english is a secondary language for the contact. */
    // @ApiMember(DataType="bool", Description="True if english is a secondary language for the contact.", Name="ESL", ParameterType="query")
    public ESL: boolean;

    /** @description Language that is the primary language for the contact. */
    // @ApiMember(DataType="string", Description="Language that is the primary language for the contact.", Name="Language", ParameterType="query")
    public Language: string;

    /** @description True if an interpreter is required. */
    // @ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")
    public InterpreterRequired: boolean;

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

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

export class RoleModel
{
    /** @description Role Id */
    // @ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")
    public RoleId: string;

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

    /** @description Is the role a licensee role? */
    // @ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")
    public IsLicenseeRole: boolean;

    /** @description Is manage contacts role? */
    // @ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")
    public IsManageContacts: boolean;

    /** @description Is the role a Platform role? */
    // @ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")
    public IsPlatformRole: boolean;

    /** @description Is the role a services role? */
    // @ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")
    public IsServiceRole: boolean;

    /** @description Is the role a customer role? */
    // @ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")
    public IsCustomerRole: boolean;

    /** @description Is the role a functional role? */
    // @ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")
    public IsFunctionalRole: boolean;

    /** @description Is the role an auto-accept role? */
    // @ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")
    public IsRequestAutoAccepted: boolean;

    /** @description Suite that the role belongs to */
    // @ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")
    public SuiteId: string;

    /** @description Suite that the role belongs to */
    // @ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")
    public SuiteName: string;

    /** @description 'A' (Active) or 'I' (Inactive) */
    // @ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")
    public RecordStatus: string;

    /** @description Object Connection Id, which is populated when the roles are returned based on those that are connected to an object. */
    // @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 ObjectConnectionId: string;

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

export class ContactGroupConnectionModel extends UserProfileSummaryModel
{
    /** @description Contact Group Id */
    // @ApiMember(DataType="Guid", Description="Contact Group Id", Name="ContactGroupId")
    public ContactGroupId: string;

    /** @description Connection id of the contact in the group */
    // @ApiMember(DataType="string", Description="Connection id of the contact in the group", Name="ContactGroupConnectionId")
    public ContactGroupConnectionId: string;

    /** @description The Id of the Role this contact is connected to the group with. */
    // @ApiMember(DataType="string", Description="The Id of the Role this contact is connected to the group with.", Name="ConnectionRoleId")
    public ConnectionRoleId: string;

    /** @description Order of contacts within a group, the primary contact will have an index of 1. */
    // @ApiMember(DataType="int", Description="Order of contacts within a group, the primary contact will have an index of 1.", Name="Index")
    public Index: number;

    /** @description List of roles that the contact in the contact group has across appliances for e.g. Platform Customer, Nexus customer etc. */
    // @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 ContactRoles: RoleModel[];

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

export class CustomerProjectModel
{
    public ProjectId: string;
    public Name: string;
    public ProjectAddress: string;
    public ManagerContactId?: string;
    public ManagerContactName: string;
    public ManagerProfilePhotoUrl: string;
    public ManagerProfilePhotoThumbnailUrl: string;
    public SupervisorContactId?: string;
    public SupervisorContactName: string;
    public SupervisorProfilePhotoUrl: string;
    public SupervisorProfilePhotoThumbnailUrl: string;
    public CustomerServiceContactId?: string;
    public CustomerServiceContactName: string;
    public CustomerServiceProfilePhotoUrl: string;
    public CustomerServiceProfilePhotoThumbnail: string;

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

export class ContactGroupModel
{
    /** @description Contact Group Id */
    // @ApiMember(DataType="Guid", Description="Contact Group Id", Name="ContactGroupId")
    public ContactGroupId: string;

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

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

    /** @description Group Role Id for e.g. Customer */
    // @ApiMember(DataType="Guid", Description="Group Role Id for e.g. Customer", Name="GroupRoleId")
    public GroupRoleId: string;

    /** @description Primary contact in the group */
    // @ApiMember(DataType="string", Description="Primary contact in the group", Name="PrimaryContactName")
    public PrimaryContactName: string;

    /** @description Contact Id of the primary contact in the group */
    // @ApiMember(DataType="Guid", Description="Contact Id of the primary contact in the group", Name="PrimaryContactId")
    public PrimaryContactId: string;

    /** @description Profile photo url of the primary contact in the group */
    // @ApiMember(DataType="string", Description="Profile photo url of the primary contact in the group", Name="PrimaryContactPhotoUrl")
    public PrimaryContactPhotoUrl: string;

    /** @description Profile photo thumbnail url of the primary contact in the group */
    // @ApiMember(DataType="string", Description="Profile photo thumbnail url of the primary contact in the group", Name="PrimaryContactThumbnailUrl")
    public PrimaryContactThumbnailUrl: string;

    /** @description Number of contacts in the group */
    // @ApiMember(DataType="int", Description="Number of contacts in the group", Name="NumberOfContacts")
    public NumberOfContacts: number;

    /** @description Record Status of contact group */
    // @ApiMember(DataType="string", Description="Record Status of contact group", Name="RecordStatus")
    public RecordStatus: string;

    /** @description Details of contact in the contact group */
    // @ApiMember(DataType="List", Description="Details of contact in the contact group", Name="Contacts")
    public Contacts: ContactGroupConnectionModel[];

    /** @description Details of projects for the contact group */
    // @ApiMember(DataType="List", Description="Details of projects for the contact group", Name="Projects")
    public Projects: CustomerProjectModel[];

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

// @ApiResponse(Description="Get contact groups for current licensee")
export class GetContactGroupsResponse
{
    public ContactGroups: ContactGroupModel[];
    /** @description Count of total groups. */
    // @ApiMember(DataType="int", Description="Count of total groups.", Name="TotalGroups")
    public TotalGroups: number;

    public ResponseStatus: ResponseStatus;

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

/** @description Get customers for current licensee */
// @Api(Description="Get customers for current licensee")
export class GetContactGroups extends PagedModel
{
    /** @description Get contactGroups for the specified contact */
    // @ApiMember(Description="Get contactGroups for the specified contact", Name="ContactId")
    public ContactId: string;

    /** @description Specific search text to search for i.e. Contact Name, Employment Details etc. */
    // @ApiMember(DataType="string", Description="Specific search text to search for i.e. Contact Name, Employment Details etc.", Name="SearchText")
    public SearchText: string;

    /** @description Set the Contact Group Role Id to only retrieve groups of that type. If ContactId is not set this is mandatory. */
    // @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 ContactGroupRoleId: string;

    /** @description Include active contact groups */
    // @ApiMember(Description="Include active contact groups", Name="IncludeActive")
    public IncludeActive: boolean;

    /** @description Include archived contact groups */
    // @ApiMember(Description="Include archived contact groups", Name="IncludeArchived")
    public IncludeArchived: boolean;

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

TypeScript GetContactGroups 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/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"}}}