| All Verbs | /api/contacts/{UserProfileId}/notmanagingorgprofile |
|---|
import 'package:servicestack/servicestack.dart';
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 GetContactsNotManagingOrgProfileResponse implements IConvertible
{
/**
* A list of contacts eligible, but not yet managing the passed in Organisation Profile.
*/
// @ApiMember(DataType="List<UserProfileSummaryModel>", Description="A list of contacts eligible, but not yet managing the passed in Organisation Profile.", Name="ContactsNotManagingOrgProfile")
List<UserProfileSummaryModel>? ContactsNotManagingOrgProfile;
int? TotalContactsNotManagingOrgProfile;
/**
* Service Stack Response Status.
*/
// @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus")
ResponseStatus? ResponseStatus;
GetContactsNotManagingOrgProfileResponse({this.ContactsNotManagingOrgProfile,this.TotalContactsNotManagingOrgProfile,this.ResponseStatus});
GetContactsNotManagingOrgProfileResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ContactsNotManagingOrgProfile = JsonConverters.fromJson(json['ContactsNotManagingOrgProfile'],'List<UserProfileSummaryModel>',context!);
TotalContactsNotManagingOrgProfile = json['TotalContactsNotManagingOrgProfile'];
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ContactsNotManagingOrgProfile': JsonConverters.toJson(ContactsNotManagingOrgProfile,'List<UserProfileSummaryModel>',context!),
'TotalContactsNotManagingOrgProfile': TotalContactsNotManagingOrgProfile,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "GetContactsNotManagingOrgProfileResponse";
TypeContext? context = _ctx;
}
/**
* Gets a list of contacts that are not currently managing the userProfileId supplied.
*/
// @Api(Description="Gets a list of contacts that are not currently managing the userProfileId supplied.")
class GetContactsNotManagingOrgProfile implements IConvertible
{
/**
* Id of the Organisation Profile record being managed.
*/
// @ApiMember(DataType="Guid", Description="Id of the Organisation Profile record being managed.", IsRequired=true, Name="UserProfileId", ParameterType="query")
String? UserProfileId;
GetContactsNotManagingOrgProfile({this.UserProfileId});
GetContactsNotManagingOrgProfile.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
UserProfileId = json['UserProfileId'];
return this;
}
Map<String, dynamic> toJson() => {
'UserProfileId': UserProfileId
};
getTypeName() => "GetContactsNotManagingOrgProfile";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
'UserProfileSummaryModel': TypeInfo(TypeOf.Class, create:() => UserProfileSummaryModel()),
'GetContactsNotManagingOrgProfileResponse': TypeInfo(TypeOf.Class, create:() => GetContactsNotManagingOrgProfileResponse()),
'List<UserProfileSummaryModel>': TypeInfo(TypeOf.Class, create:() => <UserProfileSummaryModel>[]),
'GetContactsNotManagingOrgProfile': TypeInfo(TypeOf.Class, create:() => GetContactsNotManagingOrgProfile()),
});
Dart GetContactsNotManagingOrgProfile 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/contacts/{UserProfileId}/notmanagingorgprofile HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetContactsNotManagingOrgProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<UserProfileId>00000000-0000-0000-0000-000000000000</UserProfileId>
</GetContactsNotManagingOrgProfile>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetContactsNotManagingOrgProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactsNotManagingOrgProfile xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:UserProfileSummaryModel>
<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:UserProfileSummaryModel>
</ContactsNotManagingOrgProfile>
<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>
<TotalContactsNotManagingOrgProfile>0</TotalContactsNotManagingOrgProfile>
</GetContactsNotManagingOrgProfileResponse>