Platform API

<back to all web services

ReclaimVirtualContact

Requires Authentication
The following routes are available for this service:
All Verbs/api/contact/{ContactId}/reclaimvirtualcontact
import 'package:servicestack/servicestack.dart';

class ReclaimVirtualContactResponse implements IConvertible
{
    bool? Success;
    String? Message;
    ResponseStatus? ResponseStatus;

    ReclaimVirtualContactResponse({this.Success,this.Message,this.ResponseStatus});
    ReclaimVirtualContactResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class ReclaimVirtualContact implements IConvertible
{
    /**
    * Contact Id to reclaim as virtual contact
    */
    // @ApiMember(DataType="Guid", Description="Contact Id to reclaim as virtual contact", IsRequired=true, Name="ContactId")
    String? ContactId;

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

    fromMap(Map<String, dynamic> json) {
        ContactId = json['ContactId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContactId': ContactId
    };

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

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

Dart ReclaimVirtualContact DTOs

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

HTTP + CSV

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

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

{"ContactId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Success":false,"Message":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}