import 'package:servicestack/servicestack.dart';
class UserContactConnectionModel implements IConvertible
{
/**
* The Contact Role Id, that links the Contact to their role.
*/
// @ApiMember(DataType="Guid", Description="The Contact Role Id, that links the Contact to their role.", Name="ContactRoleId", ParameterType="query")
String? ContactRoleId;
/**
* The role name.
*/
// @ApiMember(DataType="string", Description="The role name.", Name="ContactRoleName", ParameterType="query")
String? ContactRoleName;
/**
* The list item role Id.
*/
// @ApiMember(DataType="Guid", Description="The list item role Id.", Name="ContactListItemRoleId", ParameterType="query")
String? ContactListItemRoleId;
/**
* The URL of the contact role's image icon.
*/
// @ApiMember(DataType="string", Description="The URL of the contact role's image icon.", Name="ContactRolePrimaryImageURL", ParameterType="query")
String? ContactRolePrimaryImageURL;
/**
* The URL of the contact role's thumbnail image icon.
*/
// @ApiMember(DataType="string", Description="The URL of the contact role's thumbnail image icon.", Name="ContactRolePrimaryImageThumbnailURL", ParameterType="query")
String? ContactRolePrimaryImageThumbnailURL;
/**
* The Guid of the contact role's media file containing the image icon details.
*/
// @ApiMember(DataType="string", Description="The Guid of the contact role's media file containing the image icon details.", Name="ContactRolePrimaryImageId", ParameterType="query")
String? ContactRolePrimaryImageId;
/**
* The connected contacts Id. (licensee)
*/
// @ApiMember(DataType="string", Description="The connected contacts Id. (licensee)", Name="ConnectionContactId", ParameterType="query")
String? ConnectionContactId;
/**
* The connected contacts Full Name.
*/
// @ApiMember(DataType="string", Description="The connected contacts Full Name.", Name="ConnectionContactName", ParameterType="query")
String? ConnectionContactName;
/**
* The connected contacts role.
*/
// @ApiMember(DataType="string", Description="The connected contacts role.", Name="ConnectionContactRoleName", ParameterType="query")
String? ConnectionContactRoleName;
/**
* The connected contacts role Id.
*/
// @ApiMember(DataType="Guid", Description="The connected contacts role Id.", Name="ConnectionContactRoleId", ParameterType="query")
String? ConnectionContactRoleId;
/**
* The connected contacts list item role Id.
*/
// @ApiMember(DataType="Guid", Description="The connected contacts list item role Id.", Name="ConnectionContactListItemRoleId", ParameterType="query")
String? ConnectionContactListItemRoleId;
/**
* The Contacts Type.
*/
// @ApiMember(DataType="string", Description="The Contacts Type.", Name="ContactTypeName", ParameterType="query")
String? ContactTypeName;
/**
* The URL to the Connected Contacts Photo.
*/
// @ApiMember(DataType="string", Description="The URL to the Connected Contacts Photo.", Name="ConnectionContactPhotoURL", ParameterType="query")
String? ConnectionContactPhotoURL;
/**
* .
*/
// @ApiMember(DataType="bool", Description=".", Name="IsContactLicenseeRole", ParameterType="query")
bool? IsContactLicenseeRole;
/**
* If the connection is as a licensee this is true.
*/
// @ApiMember(DataType="bool", Description="If the connection is as a licensee this is true.", Name="IsConnectionLicenseeRole", ParameterType="query")
bool? IsConnectionLicenseeRole;
/**
* The status of the connection with the contact.
*/
// @ApiMember(DataType="string", Description="The status of the connection with the contact.", Name="ConnectionStatusName", ParameterType="query")
String? ConnectionStatusName;
/**
* The status Id of the connection with the contact.
*/
// @ApiMember(DataType="Guid", Description="The status Id of the connection with the contact.", Name="ConnectionStatusId", ParameterType="query")
String? ConnectionStatusId;
/**
* The ContactRoleConnectionId of an active connection with the contact.
*/
// @ApiMember(DataType="Guid", Description="The ContactRoleConnectionId of an active connection with the contact.", Name="ConnectionId", ParameterType="query")
String? ConnectionId;
/**
* The ContactRoleConnectionRequest of a pending connection with the contact.
*/
// @ApiMember(DataType="Guid", Description="The ContactRoleConnectionRequest of a pending connection with the contact.", Name="ConnectionRequestId", ParameterType="query")
String? ConnectionRequestId;
UserContactConnectionModel({this.ContactRoleId,this.ContactRoleName,this.ContactListItemRoleId,this.ContactRolePrimaryImageURL,this.ContactRolePrimaryImageThumbnailURL,this.ContactRolePrimaryImageId,this.ConnectionContactId,this.ConnectionContactName,this.ConnectionContactRoleName,this.ConnectionContactRoleId,this.ConnectionContactListItemRoleId,this.ContactTypeName,this.ConnectionContactPhotoURL,this.IsContactLicenseeRole,this.IsConnectionLicenseeRole,this.ConnectionStatusName,this.ConnectionStatusId,this.ConnectionId,this.ConnectionRequestId});
UserContactConnectionModel.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ContactRoleId = json['ContactRoleId'];
ContactRoleName = json['ContactRoleName'];
ContactListItemRoleId = json['ContactListItemRoleId'];
ContactRolePrimaryImageURL = json['ContactRolePrimaryImageURL'];
ContactRolePrimaryImageThumbnailURL = json['ContactRolePrimaryImageThumbnailURL'];
ContactRolePrimaryImageId = json['ContactRolePrimaryImageId'];
ConnectionContactId = json['ConnectionContactId'];
ConnectionContactName = json['ConnectionContactName'];
ConnectionContactRoleName = json['ConnectionContactRoleName'];
ConnectionContactRoleId = json['ConnectionContactRoleId'];
ConnectionContactListItemRoleId = json['ConnectionContactListItemRoleId'];
ContactTypeName = json['ContactTypeName'];
ConnectionContactPhotoURL = json['ConnectionContactPhotoURL'];
IsContactLicenseeRole = json['IsContactLicenseeRole'];
IsConnectionLicenseeRole = json['IsConnectionLicenseeRole'];
ConnectionStatusName = json['ConnectionStatusName'];
ConnectionStatusId = json['ConnectionStatusId'];
ConnectionId = json['ConnectionId'];
ConnectionRequestId = json['ConnectionRequestId'];
return this;
}
Map<String, dynamic> toJson() => {
'ContactRoleId': ContactRoleId,
'ContactRoleName': ContactRoleName,
'ContactListItemRoleId': ContactListItemRoleId,
'ContactRolePrimaryImageURL': ContactRolePrimaryImageURL,
'ContactRolePrimaryImageThumbnailURL': ContactRolePrimaryImageThumbnailURL,
'ContactRolePrimaryImageId': ContactRolePrimaryImageId,
'ConnectionContactId': ConnectionContactId,
'ConnectionContactName': ConnectionContactName,
'ConnectionContactRoleName': ConnectionContactRoleName,
'ConnectionContactRoleId': ConnectionContactRoleId,
'ConnectionContactListItemRoleId': ConnectionContactListItemRoleId,
'ContactTypeName': ContactTypeName,
'ConnectionContactPhotoURL': ConnectionContactPhotoURL,
'IsContactLicenseeRole': IsContactLicenseeRole,
'IsConnectionLicenseeRole': IsConnectionLicenseeRole,
'ConnectionStatusName': ConnectionStatusName,
'ConnectionStatusId': ConnectionStatusId,
'ConnectionId': ConnectionId,
'ConnectionRequestId': ConnectionRequestId
};
getTypeName() => "UserContactConnectionModel";
TypeContext? context = _ctx;
}
class ContactEmailAddress implements IConvertible
{
/**
* The Contact Id of the contact.
*/
// @ApiMember(DataType="Guid", Description="The Contact Id of the contact.", Name="ContactId", ParameterType="query")
String? ContactId;
/**
* The Contact Full Name
*/
// @ApiMember(DataType="string", Description="The Contact Full Name", Name="ContactName", ParameterType="query")
String? ContactName;
/**
* The Contact Email Address.
*/
// @ApiMember(DataType="string", Description="The Contact Email Address.", Name="EmailAddress", ParameterType="query")
String? EmailAddress;
/**
* The Contact Photo URL
*/
// @ApiMember(DataType="string", Description="The Contact Photo URL", Name="ContactPhotoURL", ParameterType="query")
String? ContactPhotoURL;
ContactEmailAddress({this.ContactId,this.ContactName,this.EmailAddress,this.ContactPhotoURL});
ContactEmailAddress.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ContactId = json['ContactId'];
ContactName = json['ContactName'];
EmailAddress = json['EmailAddress'];
ContactPhotoURL = json['ContactPhotoURL'];
return this;
}
Map<String, dynamic> toJson() => {
'ContactId': ContactId,
'ContactName': ContactName,
'EmailAddress': EmailAddress,
'ContactPhotoURL': ContactPhotoURL
};
getTypeName() => "ContactEmailAddress";
TypeContext? context = _ctx;
}
class UserContacts implements IConvertible
{
/**
* A list of contact connections assigned to the user.
*/
// @ApiMember(DataType="List<UserContactConnectionModel>", Description="A list of contact connections assigned to the user.", Name="ContactConnections", ParameterType="query")
List<UserContactConnectionModel>? ContactConnections;
/**
* A list of connected contacts and their email addresses.
*/
// @ApiMember(DataType="List<ContactEmailAddressBook>", Description="A list of connected contacts and their email addresses.", Name="EmailAddressBook", ParameterType="query")
List<ContactEmailAddress>? EmailAddressBook;
UserContacts({this.ContactConnections,this.EmailAddressBook});
UserContacts.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ContactConnections = JsonConverters.fromJson(json['ContactConnections'],'List<UserContactConnectionModel>',context!);
EmailAddressBook = JsonConverters.fromJson(json['EmailAddressBook'],'List<ContactEmailAddress>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ContactConnections': JsonConverters.toJson(ContactConnections,'List<UserContactConnectionModel>',context!),
'EmailAddressBook': JsonConverters.toJson(EmailAddressBook,'List<ContactEmailAddress>',context!)
};
getTypeName() => "UserContacts";
TypeContext? context = _ctx;
}
/**
* Returns a list of licensee contacts connected to a user profile' contact.
*/
// @Api(Description="Returns a list of licensee contacts connected to a user profile' contact.")
class GetLicenseeConnectedContacts implements IConvertible
{
/**
* The user profiles Contact Guid. Contacts connected to the user will be filted by this profiles contact ID.
*/
// @ApiMember(DataType="Guid", Description="The user profiles Contact Guid. Contacts connected to the user will be filted by this profiles contact ID.", IsRequired=true, Name="ContactId", ParameterType="query")
String? ContactId;
/**
* The suite id list. Gets contacts connected to the user filted by the suite IDs in this list..
*/
// @ApiMember(DataType="List<Guid>", Description="The suite id list. Gets contacts connected to the user filted by the suite IDs in this list..", Name="SuiteIds", ParameterType="query")
List<String>? SuiteIds;
GetLicenseeConnectedContacts({this.ContactId,this.SuiteIds});
GetLicenseeConnectedContacts.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ContactId = json['ContactId'];
SuiteIds = JsonConverters.fromJson(json['SuiteIds'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ContactId': ContactId,
'SuiteIds': JsonConverters.toJson(SuiteIds,'List<String>',context!)
};
getTypeName() => "GetLicenseeConnectedContacts";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
'UserContactConnectionModel': TypeInfo(TypeOf.Class, create:() => UserContactConnectionModel()),
'ContactEmailAddress': TypeInfo(TypeOf.Class, create:() => ContactEmailAddress()),
'UserContacts': TypeInfo(TypeOf.Class, create:() => UserContacts()),
'List<UserContactConnectionModel>': TypeInfo(TypeOf.Class, create:() => <UserContactConnectionModel>[]),
'List<ContactEmailAddress>': TypeInfo(TypeOf.Class, create:() => <ContactEmailAddress>[]),
'GetLicenseeConnectedContacts': TypeInfo(TypeOf.Class, create:() => GetLicenseeConnectedContacts()),
});
Dart GetLicenseeConnectedContacts DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsonl/reply/GetLicenseeConnectedContacts HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"ContactId":"00000000-0000-0000-0000-000000000000","SuiteIds":["00000000-0000-0000-0000-000000000000"]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ContactConnections":[{"ContactRoleId":"00000000-0000-0000-0000-000000000000","ContactRoleName":"String","ContactListItemRoleId":"00000000-0000-0000-0000-000000000000","ContactRolePrimaryImageURL":"String","ContactRolePrimaryImageThumbnailURL":"String","ContactRolePrimaryImageId":"00000000-0000-0000-0000-000000000000","ConnectionContactId":"00000000-0000-0000-0000-000000000000","ConnectionContactName":"String","ConnectionContactRoleName":"String","ConnectionContactRoleId":"00000000-0000-0000-0000-000000000000","ConnectionContactListItemRoleId":"00000000-0000-0000-0000-000000000000","ContactTypeName":"String","ConnectionContactPhotoURL":"String","IsContactLicenseeRole":false,"IsConnectionLicenseeRole":false,"ConnectionStatusName":"String","ConnectionStatusId":"00000000-0000-0000-0000-000000000000","ConnectionId":"00000000-0000-0000-0000-000000000000","ConnectionRequestId":"00000000-0000-0000-0000-000000000000"}],"EmailAddressBook":[{"ContactId":"00000000-0000-0000-0000-000000000000","ContactName":"String","EmailAddress":"String","ContactPhotoURL":"String"}]}