| All Verbs | /api/contactgroups | ||
|---|---|---|---|
| All Verbs | /api/contactgroups/{ContactId} |
import 'package:servicestack/servicestack.dart';
enum SortOrder
{
Ascending,
Descending,
}
class PagedModel implements IConvertible
{
/**
* Page Number to retrieve
*/
// @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
int? PageNumber;
/**
* Number of records to retrieve
*/
// @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
int? PageSize;
/**
* Index of field to sort results by
*/
// @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
int? SortIndex;
/**
* Sort Order - Ascending or Descending
*/
// @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
SortOrder? SortOrder;
PagedModel({this.PageNumber,this.PageSize,this.SortIndex,this.SortOrder});
PagedModel.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
PageNumber = json['PageNumber'];
PageSize = json['PageSize'];
SortIndex = json['SortIndex'];
SortOrder = JsonConverters.fromJson(json['SortOrder'],'SortOrder',context!);
return this;
}
Map<String, dynamic> toJson() => {
'PageNumber': PageNumber,
'PageSize': PageSize,
'SortIndex': SortIndex,
'SortOrder': JsonConverters.toJson(SortOrder,'SortOrder',context!)
};
getTypeName() => "PagedModel";
TypeContext? context = _ctx;
}
class UserProfileSummaryModel implements IConvertible
{
/**
* User Profile Id
*/
// @ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")
String? UserProfileId;
/**
* User linked to the profile
*/
// @ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")
String? UserId;
/**
* Contact linked to the profile
*/
// @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
String? ContactId;
/**
* User linked to the profile
*/
// @ApiMember(DataType="string", Description="User linked to the profile", Name="UserName")
String? UserName;
/**
* User Profile Name
*/
// @ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")
String? ProfileName;
/**
* Full name of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
String? ContactFullName;
/**
* Email Address of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
String? EmailAddress;
/**
* Email signature of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Email signature of the contact linked to the profile", Name="EmailSignature")
String? EmailSignature;
/**
* Mobile number of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Mobile number of the contact linked to the profile", Name="MobileNumber")
String? MobileNumber;
/**
* Phone number of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Phone number of the contact linked to the profile", Name="PhoneNumber")
String? PhoneNumber;
/**
* 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")
String? ContactTypeId;
/**
* 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")
String? ContactTypeName;
/**
* First name of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")
String? FirstName;
/**
* Surname of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Surname of the contact linked to the profile", Name="Surname")
String? Surname;
/**
* Title of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Title of contact linked to the profile", Name="Title")
String? Title;
/**
* Legal name of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")
String? LegalName;
/**
* Trading name of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")
String? TradingName;
/**
* Australian Business Number
*/
// @ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")
String? Abn;
/**
* Australian Company Number
*/
// @ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")
String? Acn;
/**
* Australian Registered Body Number
*/
// @ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")
String? Arbn;
/**
* Indicates if the Contact is registered for GST.
*/
// @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")
bool? GstRegistered;
/**
* 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")
bool? ESL;
/**
* 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")
String? Language;
/**
* True if an interpreter is required.
*/
// @ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")
bool? InterpreterRequired;
/**
* Licensee specific notes about the contact.
*/
// @ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")
String? LicenseeNotes;
/**
* Profile photo of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
String? ProfilePhotoUrl;
/**
* Thumbnail photo of contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
String? ProfilePhotoThumbnailUrl;
/**
* Profile photo id of contact linked to the profile
*/
// @ApiMember(DataType="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")
String? ProfileImageId;
/**
* Profile description
*/
// @ApiMember(DataType="string", Description="Profile description", Name="Description")
String? Description;
/**
* Employment Industry
*/
// @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
String? EmploymentIndustry;
/**
* Employment Role
*/
// @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
String? EmploymentRole;
/**
* Areas of Work
*/
// @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
String? EmploymentGeographicArea;
/**
* The contacts timezone.
*/
// @ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
String? Timezone;
/**
* Timezone Name
*/
// @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
String? TimezoneName;
/**
* The primary address of the contact
*/
// @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
String? PrimaryAddress;
/**
* 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")
bool? IsActiveContact;
UserProfileSummaryModel({this.UserProfileId,this.UserId,this.ContactId,this.UserName,this.ProfileName,this.ContactFullName,this.EmailAddress,this.EmailSignature,this.MobileNumber,this.PhoneNumber,this.ContactTypeId,this.ContactTypeName,this.FirstName,this.Surname,this.Title,this.LegalName,this.TradingName,this.Abn,this.Acn,this.Arbn,this.GstRegistered,this.ESL,this.Language,this.InterpreterRequired,this.LicenseeNotes,this.ProfilePhotoUrl,this.ProfilePhotoThumbnailUrl,this.ProfileImageId,this.Description,this.EmploymentIndustry,this.EmploymentRole,this.EmploymentGeographicArea,this.Timezone,this.TimezoneName,this.PrimaryAddress,this.IsActiveContact});
UserProfileSummaryModel.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
UserProfileId = json['UserProfileId'];
UserId = json['UserId'];
ContactId = json['ContactId'];
UserName = json['UserName'];
ProfileName = json['ProfileName'];
ContactFullName = json['ContactFullName'];
EmailAddress = json['EmailAddress'];
EmailSignature = json['EmailSignature'];
MobileNumber = json['MobileNumber'];
PhoneNumber = json['PhoneNumber'];
ContactTypeId = json['ContactTypeId'];
ContactTypeName = json['ContactTypeName'];
FirstName = json['FirstName'];
Surname = json['Surname'];
Title = json['Title'];
LegalName = json['LegalName'];
TradingName = json['TradingName'];
Abn = json['Abn'];
Acn = json['Acn'];
Arbn = json['Arbn'];
GstRegistered = json['GstRegistered'];
ESL = json['ESL'];
Language = json['Language'];
InterpreterRequired = json['InterpreterRequired'];
LicenseeNotes = json['LicenseeNotes'];
ProfilePhotoUrl = json['ProfilePhotoUrl'];
ProfilePhotoThumbnailUrl = json['ProfilePhotoThumbnailUrl'];
ProfileImageId = json['ProfileImageId'];
Description = json['Description'];
EmploymentIndustry = json['EmploymentIndustry'];
EmploymentRole = json['EmploymentRole'];
EmploymentGeographicArea = json['EmploymentGeographicArea'];
Timezone = json['Timezone'];
TimezoneName = json['TimezoneName'];
PrimaryAddress = json['PrimaryAddress'];
IsActiveContact = json['IsActiveContact'];
return this;
}
Map<String, dynamic> toJson() => {
'UserProfileId': UserProfileId,
'UserId': UserId,
'ContactId': ContactId,
'UserName': UserName,
'ProfileName': ProfileName,
'ContactFullName': ContactFullName,
'EmailAddress': EmailAddress,
'EmailSignature': EmailSignature,
'MobileNumber': MobileNumber,
'PhoneNumber': PhoneNumber,
'ContactTypeId': ContactTypeId,
'ContactTypeName': ContactTypeName,
'FirstName': FirstName,
'Surname': Surname,
'Title': Title,
'LegalName': LegalName,
'TradingName': TradingName,
'Abn': Abn,
'Acn': Acn,
'Arbn': Arbn,
'GstRegistered': GstRegistered,
'ESL': ESL,
'Language': Language,
'InterpreterRequired': InterpreterRequired,
'LicenseeNotes': LicenseeNotes,
'ProfilePhotoUrl': ProfilePhotoUrl,
'ProfilePhotoThumbnailUrl': ProfilePhotoThumbnailUrl,
'ProfileImageId': ProfileImageId,
'Description': Description,
'EmploymentIndustry': EmploymentIndustry,
'EmploymentRole': EmploymentRole,
'EmploymentGeographicArea': EmploymentGeographicArea,
'Timezone': Timezone,
'TimezoneName': TimezoneName,
'PrimaryAddress': PrimaryAddress,
'IsActiveContact': IsActiveContact
};
getTypeName() => "UserProfileSummaryModel";
TypeContext? context = _ctx;
}
class RoleModel implements IConvertible
{
/**
* Role Id
*/
// @ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")
String? RoleId;
/**
* Role Name
*/
// @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
String? RoleName;
/**
* Is the role a licensee role?
*/
// @ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")
bool? IsLicenseeRole;
/**
* Is manage contacts role?
*/
// @ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")
bool? IsManageContacts;
/**
* Is the role a Platform role?
*/
// @ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")
bool? IsPlatformRole;
/**
* Is the role a services role?
*/
// @ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")
bool? IsServiceRole;
/**
* Is the role a customer role?
*/
// @ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")
bool? IsCustomerRole;
/**
* Is the role a functional role?
*/
// @ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")
bool? IsFunctionalRole;
/**
* Is the role an auto-accept role?
*/
// @ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")
bool? IsRequestAutoAccepted;
/**
* Suite that the role belongs to
*/
// @ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")
String? SuiteId;
/**
* Suite that the role belongs to
*/
// @ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")
String? SuiteName;
/**
* 'A' (Active) or 'I' (Inactive)
*/
// @ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")
String? RecordStatus;
/**
* 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")
String? ObjectConnectionId;
RoleModel({this.RoleId,this.RoleName,this.IsLicenseeRole,this.IsManageContacts,this.IsPlatformRole,this.IsServiceRole,this.IsCustomerRole,this.IsFunctionalRole,this.IsRequestAutoAccepted,this.SuiteId,this.SuiteName,this.RecordStatus,this.ObjectConnectionId});
RoleModel.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
RoleId = json['RoleId'];
RoleName = json['RoleName'];
IsLicenseeRole = json['IsLicenseeRole'];
IsManageContacts = json['IsManageContacts'];
IsPlatformRole = json['IsPlatformRole'];
IsServiceRole = json['IsServiceRole'];
IsCustomerRole = json['IsCustomerRole'];
IsFunctionalRole = json['IsFunctionalRole'];
IsRequestAutoAccepted = json['IsRequestAutoAccepted'];
SuiteId = json['SuiteId'];
SuiteName = json['SuiteName'];
RecordStatus = json['RecordStatus'];
ObjectConnectionId = json['ObjectConnectionId'];
return this;
}
Map<String, dynamic> toJson() => {
'RoleId': RoleId,
'RoleName': RoleName,
'IsLicenseeRole': IsLicenseeRole,
'IsManageContacts': IsManageContacts,
'IsPlatformRole': IsPlatformRole,
'IsServiceRole': IsServiceRole,
'IsCustomerRole': IsCustomerRole,
'IsFunctionalRole': IsFunctionalRole,
'IsRequestAutoAccepted': IsRequestAutoAccepted,
'SuiteId': SuiteId,
'SuiteName': SuiteName,
'RecordStatus': RecordStatus,
'ObjectConnectionId': ObjectConnectionId
};
getTypeName() => "RoleModel";
TypeContext? context = _ctx;
}
class ContactGroupConnectionModel extends UserProfileSummaryModel implements IConvertible
{
/**
* Contact Group Id
*/
// @ApiMember(DataType="Guid", Description="Contact Group Id", Name="ContactGroupId")
String? ContactGroupId;
/**
* Connection id of the contact in the group
*/
// @ApiMember(DataType="string", Description="Connection id of the contact in the group", Name="ContactGroupConnectionId")
String? ContactGroupConnectionId;
/**
* 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")
String? ConnectionRoleId;
/**
* 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")
int? Index;
/**
* 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")
List<RoleModel>? ContactRoles;
ContactGroupConnectionModel({this.ContactGroupId,this.ContactGroupConnectionId,this.ConnectionRoleId,this.Index,this.ContactRoles});
ContactGroupConnectionModel.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
ContactGroupId = json['ContactGroupId'];
ContactGroupConnectionId = json['ContactGroupConnectionId'];
ConnectionRoleId = json['ConnectionRoleId'];
Index = json['Index'];
ContactRoles = JsonConverters.fromJson(json['ContactRoles'],'List<RoleModel>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'ContactGroupId': ContactGroupId,
'ContactGroupConnectionId': ContactGroupConnectionId,
'ConnectionRoleId': ConnectionRoleId,
'Index': Index,
'ContactRoles': JsonConverters.toJson(ContactRoles,'List<RoleModel>',context!)
});
getTypeName() => "ContactGroupConnectionModel";
TypeContext? context = _ctx;
}
class CustomerProjectModel implements IConvertible
{
String? ProjectId;
String? Name;
String? ProjectAddress;
String? ManagerContactId;
String? ManagerContactName;
String? ManagerProfilePhotoUrl;
String? ManagerProfilePhotoThumbnailUrl;
String? SupervisorContactId;
String? SupervisorContactName;
String? SupervisorProfilePhotoUrl;
String? SupervisorProfilePhotoThumbnailUrl;
String? CustomerServiceContactId;
String? CustomerServiceContactName;
String? CustomerServiceProfilePhotoUrl;
String? CustomerServiceProfilePhotoThumbnail;
CustomerProjectModel({this.ProjectId,this.Name,this.ProjectAddress,this.ManagerContactId,this.ManagerContactName,this.ManagerProfilePhotoUrl,this.ManagerProfilePhotoThumbnailUrl,this.SupervisorContactId,this.SupervisorContactName,this.SupervisorProfilePhotoUrl,this.SupervisorProfilePhotoThumbnailUrl,this.CustomerServiceContactId,this.CustomerServiceContactName,this.CustomerServiceProfilePhotoUrl,this.CustomerServiceProfilePhotoThumbnail});
CustomerProjectModel.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ProjectId = json['ProjectId'];
Name = json['Name'];
ProjectAddress = json['ProjectAddress'];
ManagerContactId = json['ManagerContactId'];
ManagerContactName = json['ManagerContactName'];
ManagerProfilePhotoUrl = json['ManagerProfilePhotoUrl'];
ManagerProfilePhotoThumbnailUrl = json['ManagerProfilePhotoThumbnailUrl'];
SupervisorContactId = json['SupervisorContactId'];
SupervisorContactName = json['SupervisorContactName'];
SupervisorProfilePhotoUrl = json['SupervisorProfilePhotoUrl'];
SupervisorProfilePhotoThumbnailUrl = json['SupervisorProfilePhotoThumbnailUrl'];
CustomerServiceContactId = json['CustomerServiceContactId'];
CustomerServiceContactName = json['CustomerServiceContactName'];
CustomerServiceProfilePhotoUrl = json['CustomerServiceProfilePhotoUrl'];
CustomerServiceProfilePhotoThumbnail = json['CustomerServiceProfilePhotoThumbnail'];
return this;
}
Map<String, dynamic> toJson() => {
'ProjectId': ProjectId,
'Name': Name,
'ProjectAddress': ProjectAddress,
'ManagerContactId': ManagerContactId,
'ManagerContactName': ManagerContactName,
'ManagerProfilePhotoUrl': ManagerProfilePhotoUrl,
'ManagerProfilePhotoThumbnailUrl': ManagerProfilePhotoThumbnailUrl,
'SupervisorContactId': SupervisorContactId,
'SupervisorContactName': SupervisorContactName,
'SupervisorProfilePhotoUrl': SupervisorProfilePhotoUrl,
'SupervisorProfilePhotoThumbnailUrl': SupervisorProfilePhotoThumbnailUrl,
'CustomerServiceContactId': CustomerServiceContactId,
'CustomerServiceContactName': CustomerServiceContactName,
'CustomerServiceProfilePhotoUrl': CustomerServiceProfilePhotoUrl,
'CustomerServiceProfilePhotoThumbnail': CustomerServiceProfilePhotoThumbnail
};
getTypeName() => "CustomerProjectModel";
TypeContext? context = _ctx;
}
class ContactGroupModel implements IConvertible
{
/**
* Contact Group Id
*/
// @ApiMember(DataType="Guid", Description="Contact Group Id", Name="ContactGroupId")
String? ContactGroupId;
/**
* Contact Group Name
*/
// @ApiMember(DataType="string", Description="Contact Group Name", Name="Name")
String? Name;
/**
* Contact Group Reference
*/
// @ApiMember(DataType="string", Description="Contact Group Reference", Name="Reference")
String? Reference;
/**
* Group Role Id for e.g. Customer
*/
// @ApiMember(DataType="Guid", Description="Group Role Id for e.g. Customer", Name="GroupRoleId")
String? GroupRoleId;
/**
* Primary contact in the group
*/
// @ApiMember(DataType="string", Description="Primary contact in the group", Name="PrimaryContactName")
String? PrimaryContactName;
/**
* Contact Id of the primary contact in the group
*/
// @ApiMember(DataType="Guid", Description="Contact Id of the primary contact in the group", Name="PrimaryContactId")
String? PrimaryContactId;
/**
* 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")
String? PrimaryContactPhotoUrl;
/**
* 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")
String? PrimaryContactThumbnailUrl;
/**
* Number of contacts in the group
*/
// @ApiMember(DataType="int", Description="Number of contacts in the group", Name="NumberOfContacts")
int? NumberOfContacts;
/**
* Record Status of contact group
*/
// @ApiMember(DataType="string", Description="Record Status of contact group", Name="RecordStatus")
String? RecordStatus;
/**
* Details of contact in the contact group
*/
// @ApiMember(DataType="List", Description="Details of contact in the contact group", Name="Contacts")
List<ContactGroupConnectionModel>? Contacts;
/**
* Details of projects for the contact group
*/
// @ApiMember(DataType="List", Description="Details of projects for the contact group", Name="Projects")
List<CustomerProjectModel>? Projects;
ContactGroupModel({this.ContactGroupId,this.Name,this.Reference,this.GroupRoleId,this.PrimaryContactName,this.PrimaryContactId,this.PrimaryContactPhotoUrl,this.PrimaryContactThumbnailUrl,this.NumberOfContacts,this.RecordStatus,this.Contacts,this.Projects});
ContactGroupModel.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ContactGroupId = json['ContactGroupId'];
Name = json['Name'];
Reference = json['Reference'];
GroupRoleId = json['GroupRoleId'];
PrimaryContactName = json['PrimaryContactName'];
PrimaryContactId = json['PrimaryContactId'];
PrimaryContactPhotoUrl = json['PrimaryContactPhotoUrl'];
PrimaryContactThumbnailUrl = json['PrimaryContactThumbnailUrl'];
NumberOfContacts = json['NumberOfContacts'];
RecordStatus = json['RecordStatus'];
Contacts = JsonConverters.fromJson(json['Contacts'],'List<ContactGroupConnectionModel>',context!);
Projects = JsonConverters.fromJson(json['Projects'],'List<CustomerProjectModel>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ContactGroupId': ContactGroupId,
'Name': Name,
'Reference': Reference,
'GroupRoleId': GroupRoleId,
'PrimaryContactName': PrimaryContactName,
'PrimaryContactId': PrimaryContactId,
'PrimaryContactPhotoUrl': PrimaryContactPhotoUrl,
'PrimaryContactThumbnailUrl': PrimaryContactThumbnailUrl,
'NumberOfContacts': NumberOfContacts,
'RecordStatus': RecordStatus,
'Contacts': JsonConverters.toJson(Contacts,'List<ContactGroupConnectionModel>',context!),
'Projects': JsonConverters.toJson(Projects,'List<CustomerProjectModel>',context!)
};
getTypeName() => "ContactGroupModel";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="Get contact groups for current licensee")
class GetContactGroupsResponse implements IConvertible
{
List<ContactGroupModel>? ContactGroups;
/**
* Count of total groups.
*/
// @ApiMember(DataType="int", Description="Count of total groups.", Name="TotalGroups")
int? TotalGroups;
ResponseStatus? ResponseStatus;
GetContactGroupsResponse({this.ContactGroups,this.TotalGroups,this.ResponseStatus});
GetContactGroupsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ContactGroups = JsonConverters.fromJson(json['ContactGroups'],'List<ContactGroupModel>',context!);
TotalGroups = json['TotalGroups'];
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ContactGroups': JsonConverters.toJson(ContactGroups,'List<ContactGroupModel>',context!),
'TotalGroups': TotalGroups,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "GetContactGroupsResponse";
TypeContext? context = _ctx;
}
/**
* Get customers for current licensee
*/
// @Api(Description="Get customers for current licensee")
class GetContactGroups extends PagedModel implements IConvertible
{
/**
* Get contactGroups for the specified contact
*/
// @ApiMember(Description="Get contactGroups for the specified contact", Name="ContactId")
String? ContactId;
/**
* 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")
String? SearchText;
/**
* 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")
String? ContactGroupRoleId;
/**
* Include active contact groups
*/
// @ApiMember(Description="Include active contact groups", Name="IncludeActive")
bool? IncludeActive;
/**
* Include archived contact groups
*/
// @ApiMember(Description="Include archived contact groups", Name="IncludeArchived")
bool? IncludeArchived;
GetContactGroups({this.ContactId,this.SearchText,this.ContactGroupRoleId,this.IncludeActive,this.IncludeArchived});
GetContactGroups.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
ContactId = json['ContactId'];
SearchText = json['SearchText'];
ContactGroupRoleId = json['ContactGroupRoleId'];
IncludeActive = json['IncludeActive'];
IncludeArchived = json['IncludeArchived'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'ContactId': ContactId,
'SearchText': SearchText,
'ContactGroupRoleId': ContactGroupRoleId,
'IncludeActive': IncludeActive,
'IncludeArchived': IncludeArchived
});
getTypeName() => "GetContactGroups";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
'SortOrder': TypeInfo(TypeOf.Enum, enumValues:SortOrder.values),
'PagedModel': TypeInfo(TypeOf.Class, create:() => PagedModel()),
'UserProfileSummaryModel': TypeInfo(TypeOf.Class, create:() => UserProfileSummaryModel()),
'RoleModel': TypeInfo(TypeOf.Class, create:() => RoleModel()),
'ContactGroupConnectionModel': TypeInfo(TypeOf.Class, create:() => ContactGroupConnectionModel()),
'List<RoleModel>': TypeInfo(TypeOf.Class, create:() => <RoleModel>[]),
'CustomerProjectModel': TypeInfo(TypeOf.Class, create:() => CustomerProjectModel()),
'ContactGroupModel': TypeInfo(TypeOf.Class, create:() => ContactGroupModel()),
'List<ContactGroupConnectionModel>': TypeInfo(TypeOf.Class, create:() => <ContactGroupConnectionModel>[]),
'List<CustomerProjectModel>': TypeInfo(TypeOf.Class, create:() => <CustomerProjectModel>[]),
'GetContactGroupsResponse': TypeInfo(TypeOf.Class, create:() => GetContactGroupsResponse()),
'List<ContactGroupModel>': TypeInfo(TypeOf.Class, create:() => <ContactGroupModel>[]),
'GetContactGroups': TypeInfo(TypeOf.Class, create:() => GetContactGroups()),
});
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/contactgroups HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetContactGroups xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<PageNumber xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</PageNumber>
<PageSize xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</PageSize>
<SortIndex xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</SortIndex>
<SortOrder xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">Ascending</SortOrder>
<ContactGroupRoleId>00000000-0000-0000-0000-000000000000</ContactGroupRoleId>
<ContactId>00000000-0000-0000-0000-000000000000</ContactId>
<IncludeActive>false</IncludeActive>
<IncludeArchived>false</IncludeArchived>
<SearchText>String</SearchText>
</GetContactGroups>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetContactGroupsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:ContactGroupModel>
<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>
</d2p1:ContactGroupModel>
</ContactGroups>
<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>
<TotalGroups>0</TotalGroups>
</GetContactGroupsResponse>