Platform API

InviteContact

The following routes are available for this service:
All Verbs	/api/contacts/{ContactId}/invite/contact
All Verbs	/api/contacts/{ContactId}/invite/{ToContactId}

import 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="Contact Id of the newly invited/ created contact")
class AddContactResponse implements IConvertible
{
    String? ContactId;
    ResponseStatus? ResponseStatus;

    AddContactResponse({this.ContactId,this.ResponseStatus});
    AddContactResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ContactId = json['ContactId'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContactId': ContactId,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "AddContactResponse";
    TypeContext? context = _ctx;
}

class InviteContact implements IConvertible
{
    /**
    * Contact Id inviting the contact
    */
    // @ApiMember(DataType="Guid", Description="Contact Id inviting the contact", IsRequired=true, Name="ContactId")
    String? ContactId;

    /**
    * Contact Id of the virtual contact invited to be real.
    */
    // @ApiMember(DataType="Guid", Description="Contact Id of the virtual contact invited to be real.", Name="ToContactId")
    String? ToContactId;

    /**
    * Email Address of the real/ virtual contact to be invited.
    */
    // @ApiMember(DataType="string", Description="Email Address of the real/ virtual contact to be invited.", IsRequired=true, Name="EmailAddress")
    String? EmailAddress;

    /**
    * List of roles to invite the contact
    */
    // @ApiMember(DataType="List<Guid>", Description="List of roles to invite the contact", IsRequired=true, Name="Roles")
    List<String>? Roles = [];

    InviteContact({this.ContactId,this.ToContactId,this.EmailAddress,this.Roles});
    InviteContact.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ContactId = json['ContactId'];
        ToContactId = json['ToContactId'];
        EmailAddress = json['EmailAddress'];
        Roles = JsonConverters.fromJson(json['Roles'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContactId': ContactId,
        'ToContactId': ToContactId,
        'EmailAddress': EmailAddress,
        'Roles': JsonConverters.toJson(Roles,'List<String>',context!)
    };

    getTypeName() => "InviteContact";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'AddContactResponse': TypeInfo(TypeOf.Class, create:() => AddContactResponse()),
    'InviteContact': TypeInfo(TypeOf.Class, create:() => InviteContact()),
});

Dart InviteContact DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/contacts/{ContactId}/invite/contact HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ContactId":"00000000-0000-0000-0000-000000000000","ToContactId":"00000000-0000-0000-0000-000000000000","EmailAddress":"String","Roles":["00000000-0000-0000-0000-000000000000"]}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ContactId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}