| All Verbs | /api/searchcontactsforroles |
|---|
import 'package:servicestack/servicestack.dart';
class ContactSummaryModel implements IConvertible
{
/**
* Contact linked to the profile
*/
// @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
String? ContactId;
/**
* 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;
/**
* 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;
/**
* Primary Phone Number of the contact linked to the profile
*/
// @ApiMember(DataType="string", Description="Primary 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;
/**
* 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 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;
/**
* 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;
/**
* Have all connections to the contact been removed?
*/
// @ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")
bool? IsRemovedContact;
ContactSummaryModel({this.ContactId,this.ContactFullName,this.EmailAddress,this.MobileNumber,this.PhoneNumber,this.ContactTypeId,this.ProfilePhotoUrl,this.ProfilePhotoThumbnailUrl,this.Description,this.EmploymentIndustry,this.EmploymentRole,this.EmploymentGeographicArea,this.TimezoneName,this.PrimaryAddress,this.IsRemovedContact});
ContactSummaryModel.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ContactId = json['ContactId'];
ContactFullName = json['ContactFullName'];
EmailAddress = json['EmailAddress'];
MobileNumber = json['MobileNumber'];
PhoneNumber = json['PhoneNumber'];
ContactTypeId = json['ContactTypeId'];
ProfilePhotoUrl = json['ProfilePhotoUrl'];
ProfilePhotoThumbnailUrl = json['ProfilePhotoThumbnailUrl'];
Description = json['Description'];
EmploymentIndustry = json['EmploymentIndustry'];
EmploymentRole = json['EmploymentRole'];
EmploymentGeographicArea = json['EmploymentGeographicArea'];
TimezoneName = json['TimezoneName'];
PrimaryAddress = json['PrimaryAddress'];
IsRemovedContact = json['IsRemovedContact'];
return this;
}
Map<String, dynamic> toJson() => {
'ContactId': ContactId,
'ContactFullName': ContactFullName,
'EmailAddress': EmailAddress,
'MobileNumber': MobileNumber,
'PhoneNumber': PhoneNumber,
'ContactTypeId': ContactTypeId,
'ProfilePhotoUrl': ProfilePhotoUrl,
'ProfilePhotoThumbnailUrl': ProfilePhotoThumbnailUrl,
'Description': Description,
'EmploymentIndustry': EmploymentIndustry,
'EmploymentRole': EmploymentRole,
'EmploymentGeographicArea': EmploymentGeographicArea,
'TimezoneName': TimezoneName,
'PrimaryAddress': PrimaryAddress,
'IsRemovedContact': IsRemovedContact
};
getTypeName() => "ContactSummaryModel";
TypeContext? context = _ctx;
}
class SearchContactsForRoleResponse implements IConvertible
{
List<ContactSummaryModel>? Contacts;
ResponseStatus? ResponseStatus;
SearchContactsForRoleResponse({this.Contacts,this.ResponseStatus});
SearchContactsForRoleResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Contacts = JsonConverters.fromJson(json['Contacts'],'List<ContactSummaryModel>',context!);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Contacts': JsonConverters.toJson(Contacts,'List<ContactSummaryModel>',context!),
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "SearchContactsForRoleResponse";
TypeContext? context = _ctx;
}
/**
* Search contacts by Name or Email Address, by Role Groups, or by Roles
*/
// @Api(Description="Search contacts by Name or Email Address, by Role Groups, or by Roles")
class SearchContactsForRole implements IConvertible
{
/**
* Search type: by Name or Email Address, by Role Groups, or by Roles
*/
// @ApiMember(DataType="Guid", Description="Search type: by Name or Email Address, by Role Groups, or by Roles", IsRequired=true, Name="SearchBy")
String? SearchBy;
/**
* Roles that contacts are connected to.
*/
// @ApiMember(DataType="List<Guid>", Description="Roles that contacts are connected to.", Name="Roles")
List<String>? Roles;
/**
* Role Groups that contacts are connected to.
*/
// @ApiMember(DataType="List<Guid>", Description="Role Groups that contacts are connected to.", Name="RoleGroups")
List<String>? RoleGroups;
/**
* For Search by Name or Email Address, filters contact results by this text value.
*/
// @ApiMember(DataType="string", Description="For Search by Name or Email Address, filters contact results by this text value.", Name="SearchText")
String? SearchText;
/**
* Excludes contacts already connected to this role.
*/
// @ApiMember(DataType="Guid", Description="Excludes contacts already connected to this role.", Name="ExcludeRole")
String? ExcludeRole;
/**
* Filters contact results by contact type(s) provided, e.g. Real Persons, Organisations etc. Defaults to real person.
*/
// @ApiMember(DataType="List<Guid>", Description="Filters contact results by contact type(s) provided, e.g. Real Persons, Organisations etc. Defaults to real person.", Name="ContactTypes")
List<String>? ContactTypes;
/**
* Determines whether the contact details (Email, mobile number etc.) to be returned.
*/
// @ApiMember(DataType="Bool", Description="Determines whether the contact details (Email, mobile number etc.) to be returned.", Name="IncludeDetails")
bool? IncludeDetails;
SearchContactsForRole({this.SearchBy,this.Roles,this.RoleGroups,this.SearchText,this.ExcludeRole,this.ContactTypes,this.IncludeDetails});
SearchContactsForRole.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
SearchBy = json['SearchBy'];
Roles = JsonConverters.fromJson(json['Roles'],'List<String>',context!);
RoleGroups = JsonConverters.fromJson(json['RoleGroups'],'List<String>',context!);
SearchText = json['SearchText'];
ExcludeRole = json['ExcludeRole'];
ContactTypes = JsonConverters.fromJson(json['ContactTypes'],'List<String>',context!);
IncludeDetails = json['IncludeDetails'];
return this;
}
Map<String, dynamic> toJson() => {
'SearchBy': SearchBy,
'Roles': JsonConverters.toJson(Roles,'List<String>',context!),
'RoleGroups': JsonConverters.toJson(RoleGroups,'List<String>',context!),
'SearchText': SearchText,
'ExcludeRole': ExcludeRole,
'ContactTypes': JsonConverters.toJson(ContactTypes,'List<String>',context!),
'IncludeDetails': IncludeDetails
};
getTypeName() => "SearchContactsForRole";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
'ContactSummaryModel': TypeInfo(TypeOf.Class, create:() => ContactSummaryModel()),
'SearchContactsForRoleResponse': TypeInfo(TypeOf.Class, create:() => SearchContactsForRoleResponse()),
'List<ContactSummaryModel>': TypeInfo(TypeOf.Class, create:() => <ContactSummaryModel>[]),
'SearchContactsForRole': TypeInfo(TypeOf.Class, create:() => SearchContactsForRole()),
});
Dart SearchContactsForRole 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/searchcontactsforroles HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SearchContactsForRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</ContactTypes>
<ExcludeRole>00000000-0000-0000-0000-000000000000</ExcludeRole>
<IncludeDetails>false</IncludeDetails>
<RoleGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</RoleGroups>
<Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</Roles>
<SearchBy>00000000-0000-0000-0000-000000000000</SearchBy>
<SearchText>String</SearchText>
</SearchContactsForRole>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SearchContactsForRoleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<Contacts xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:ContactSummaryModel>
<d2p1:ContactFullName>String</d2p1:ContactFullName>
<d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
<d2p1:ContactTypeId>00000000-0000-0000-0000-000000000000</d2p1:ContactTypeId>
<d2p1:Description>String</d2p1:Description>
<d2p1:EmailAddress>String</d2p1:EmailAddress>
<d2p1:EmploymentGeographicArea>String</d2p1:EmploymentGeographicArea>
<d2p1:EmploymentIndustry>String</d2p1:EmploymentIndustry>
<d2p1:EmploymentRole>String</d2p1:EmploymentRole>
<d2p1:IsRemovedContact>false</d2p1:IsRemovedContact>
<d2p1:MobileNumber>String</d2p1:MobileNumber>
<d2p1:PhoneNumber>String</d2p1:PhoneNumber>
<d2p1:PrimaryAddress>String</d2p1:PrimaryAddress>
<d2p1:ProfilePhotoThumbnailUrl>String</d2p1:ProfilePhotoThumbnailUrl>
<d2p1:ProfilePhotoUrl>String</d2p1:ProfilePhotoUrl>
<d2p1:TimezoneName>String</d2p1:TimezoneName>
</d2p1:ContactSummaryModel>
</Contacts>
<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>
</SearchContactsForRoleResponse>