| POST | /api/profiles |
|---|
import 'package:servicestack/servicestack.dart';
/**
* Add a Users Profile information'
*/
// @Api(Description="Add a Users Profile information'")
class AddUserProfile implements IConvertible
{
List<String>? UserIds;
List<String>? ContactIds;
String? ProfileToShareId;
AddUserProfile({this.UserIds,this.ContactIds,this.ProfileToShareId});
AddUserProfile.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
UserIds = JsonConverters.fromJson(json['UserIds'],'List<String>',context!);
ContactIds = JsonConverters.fromJson(json['ContactIds'],'List<String>',context!);
ProfileToShareId = json['ProfileToShareId'];
return this;
}
Map<String, dynamic> toJson() => {
'UserIds': JsonConverters.toJson(UserIds,'List<String>',context!),
'ContactIds': JsonConverters.toJson(ContactIds,'List<String>',context!),
'ProfileToShareId': ProfileToShareId
};
getTypeName() => "AddUserProfile";
TypeContext? context = _ctx;
}
class AddUserProfileResponse implements IConvertible
{
List<ResponseError>? Errors;
/**
* Guid representing the object that is the User Profile Id in Eros.
*/
// @ApiMember(DataType="Guid", Description="Guid representing the object that is the User Profile Id in Eros.", Name="UserProfileId", ParameterType="query")
String? ProfileToShareId;
/**
* Service Stack Response Status.
*/
// @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
ResponseStatus? ResponseStatus;
AddUserProfileResponse({this.Errors,this.ProfileToShareId,this.ResponseStatus});
AddUserProfileResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Errors = JsonConverters.fromJson(json['Errors'],'List<ResponseError>',context!);
ProfileToShareId = json['ProfileToShareId'];
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Errors': JsonConverters.toJson(Errors,'List<ResponseError>',context!),
'ProfileToShareId': ProfileToShareId,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "AddUserProfileResponse";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
'AddUserProfile': TypeInfo(TypeOf.Class, create:() => AddUserProfile()),
'AddUserProfileResponse': TypeInfo(TypeOf.Class, create:() => AddUserProfileResponse()),
});
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/profiles HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddUserProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</ContactIds>
<ProfileToShareId>00000000-0000-0000-0000-000000000000</ProfileToShareId>
<UserIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</UserIds>
</AddUserProfile>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AddUserProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<Errors xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</Errors>
<ProfileToShareId>00000000-0000-0000-0000-000000000000</ProfileToShareId>
<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>
</AddUserProfileResponse>