| All Verbs | /api/contactgroup/{ContactGroupId} |
|---|
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 group and details of contacts in the contact group for e.g. contacts in a customer group and response status")
export class GetContactGroupResponse
{
public ContactGroup: ContactGroupModel;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetContactGroupResponse>) { (Object as any).assign(this, init); }
}
/** @description Get details of the specified contact group */
// @Api(Description="Get details of the specified contact group")
export class GetContactGroup
{
/** @description Get details of the specified contact group including details of contacts in the group */
// @ApiMember(Description="Get details of the specified contact group including details of contacts in the group", Name="ContactGroupId")
public ContactGroupId: string;
/** @description The type of ContactGroup to get. */
// @ApiMember(Description="The type of ContactGroup to get.", Name="ContactGroupRoleId")
public ContactGroupRoleId: string;
/** @description Include projects linked to the contact group? */
// @ApiMember(Description="Include projects linked to the contact group?", Name="IncludeProjects")
public IncludeProjects: boolean;
public constructor(init?: Partial<GetContactGroup>) { (Object as any).assign(this, init); }
}
TypeScript GetContactGroup DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/contactgroup/{ContactGroupId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetContactGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactGroupId>00000000-0000-0000-0000-000000000000</ContactGroupId>
<ContactGroupRoleId>00000000-0000-0000-0000-000000000000</ContactGroupRoleId>
<IncludeProjects>false</IncludeProjects>
</GetContactGroup>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetContactGroupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactGroup xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:ContactGroupId>00000000-0000-0000-0000-000000000000</d2p1:ContactGroupId>
<d2p1:Contacts>
<d2p1:ContactGroupConnectionModel>
<d2p1:Abn>String</d2p1:Abn>
<d2p1:Acn>String</d2p1:Acn>
<d2p1:Arbn>String</d2p1:Arbn>
<d2p1:ContactFullName>String</d2p1:ContactFullName>
<d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
<d2p1:ContactTypeId>00000000-0000-0000-0000-000000000000</d2p1:ContactTypeId>
<d2p1:ContactTypeName>String</d2p1:ContactTypeName>
<d2p1:Description>String</d2p1:Description>
<d2p1:ESL>false</d2p1:ESL>
<d2p1:EmailAddress>String</d2p1:EmailAddress>
<d2p1:EmailSignature>String</d2p1:EmailSignature>
<d2p1:EmploymentGeographicArea>String</d2p1:EmploymentGeographicArea>
<d2p1:EmploymentIndustry>String</d2p1:EmploymentIndustry>
<d2p1:EmploymentRole>String</d2p1:EmploymentRole>
<d2p1:FirstName>String</d2p1:FirstName>
<d2p1:GstRegistered>false</d2p1:GstRegistered>
<d2p1:InterpreterRequired>false</d2p1:InterpreterRequired>
<d2p1:IsActiveContact>false</d2p1:IsActiveContact>
<d2p1:Language>String</d2p1:Language>
<d2p1:LegalName>String</d2p1:LegalName>
<d2p1:LicenseeNotes>String</d2p1:LicenseeNotes>
<d2p1:MobileNumber>String</d2p1:MobileNumber>
<d2p1:PhoneNumber>String</d2p1:PhoneNumber>
<d2p1:PrimaryAddress>String</d2p1:PrimaryAddress>
<d2p1:ProfileImageId>00000000-0000-0000-0000-000000000000</d2p1:ProfileImageId>
<d2p1:ProfileName>String</d2p1:ProfileName>
<d2p1:ProfilePhotoThumbnailUrl>String</d2p1:ProfilePhotoThumbnailUrl>
<d2p1:ProfilePhotoUrl>String</d2p1:ProfilePhotoUrl>
<d2p1:Surname>String</d2p1:Surname>
<d2p1:Timezone>00000000-0000-0000-0000-000000000000</d2p1:Timezone>
<d2p1:TimezoneName>String</d2p1:TimezoneName>
<d2p1:Title>String</d2p1:Title>
<d2p1:TradingName>String</d2p1:TradingName>
<d2p1:UserId>00000000-0000-0000-0000-000000000000</d2p1:UserId>
<d2p1:UserName>String</d2p1:UserName>
<d2p1:UserProfileId>00000000-0000-0000-0000-000000000000</d2p1:UserProfileId>
<d2p1:ConnectionRoleId>00000000-0000-0000-0000-000000000000</d2p1:ConnectionRoleId>
<d2p1:ContactGroupConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ContactGroupConnectionId>
<d2p1:ContactGroupId>00000000-0000-0000-0000-000000000000</d2p1:ContactGroupId>
<d2p1:ContactRoles>
<d2p1:RoleModel>
<d2p1:IsCustomerRole>false</d2p1:IsCustomerRole>
<d2p1:IsFunctionalRole>false</d2p1:IsFunctionalRole>
<d2p1:IsLicenseeRole>false</d2p1:IsLicenseeRole>
<d2p1:IsManageContacts>false</d2p1:IsManageContacts>
<d2p1:IsPlatformRole>false</d2p1:IsPlatformRole>
<d2p1:IsRequestAutoAccepted>false</d2p1:IsRequestAutoAccepted>
<d2p1:IsServiceRole>false</d2p1:IsServiceRole>
<d2p1:ObjectConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectConnectionId>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
<d2p1:RoleName>String</d2p1:RoleName>
<d2p1:SuiteId>00000000-0000-0000-0000-000000000000</d2p1:SuiteId>
<d2p1:SuiteName>String</d2p1:SuiteName>
</d2p1:RoleModel>
</d2p1:ContactRoles>
<d2p1:Index>0</d2p1:Index>
</d2p1:ContactGroupConnectionModel>
</d2p1:Contacts>
<d2p1:GroupRoleId>00000000-0000-0000-0000-000000000000</d2p1:GroupRoleId>
<d2p1:Name>String</d2p1:Name>
<d2p1:NumberOfContacts>0</d2p1:NumberOfContacts>
<d2p1:PrimaryContactId>00000000-0000-0000-0000-000000000000</d2p1:PrimaryContactId>
<d2p1:PrimaryContactName>String</d2p1:PrimaryContactName>
<d2p1:PrimaryContactPhotoUrl>String</d2p1:PrimaryContactPhotoUrl>
<d2p1:PrimaryContactThumbnailUrl>String</d2p1:PrimaryContactThumbnailUrl>
<d2p1:Projects>
<d2p1:CustomerProjectModel>
<d2p1:CustomerServiceContactId>00000000-0000-0000-0000-000000000000</d2p1:CustomerServiceContactId>
<d2p1:CustomerServiceContactName>String</d2p1:CustomerServiceContactName>
<d2p1:CustomerServiceProfilePhotoThumbnail>String</d2p1:CustomerServiceProfilePhotoThumbnail>
<d2p1:CustomerServiceProfilePhotoUrl>String</d2p1:CustomerServiceProfilePhotoUrl>
<d2p1:ManagerContactId>00000000-0000-0000-0000-000000000000</d2p1:ManagerContactId>
<d2p1:ManagerContactName>String</d2p1:ManagerContactName>
<d2p1:ManagerProfilePhotoThumbnailUrl>String</d2p1:ManagerProfilePhotoThumbnailUrl>
<d2p1:ManagerProfilePhotoUrl>String</d2p1:ManagerProfilePhotoUrl>
<d2p1:Name>String</d2p1:Name>
<d2p1:ProjectAddress>String</d2p1:ProjectAddress>
<d2p1:ProjectId>00000000-0000-0000-0000-000000000000</d2p1:ProjectId>
<d2p1:SupervisorContactId>00000000-0000-0000-0000-000000000000</d2p1:SupervisorContactId>
<d2p1:SupervisorContactName>String</d2p1:SupervisorContactName>
<d2p1:SupervisorProfilePhotoThumbnailUrl>String</d2p1:SupervisorProfilePhotoThumbnailUrl>
<d2p1:SupervisorProfilePhotoUrl>String</d2p1:SupervisorProfilePhotoUrl>
</d2p1:CustomerProjectModel>
</d2p1:Projects>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:Reference>String</d2p1:Reference>
</ContactGroup>
<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>
</GetContactGroupResponse>