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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ReclaimVirtualContact
    {
        /**
        * Contact Id to reclaim as virtual contact
        */
        @ApiMember(DataType="Guid", Description="Contact Id to reclaim as virtual contact", IsRequired=true, Name="ContactId")
        public UUID ContactId = null;
        
        public UUID getContactId() { return ContactId; }
        public ReclaimVirtualContact setContactId(UUID value) { this.ContactId = value; return this; }
    }

    public static class ReclaimVirtualContactResponse
    {
        public Boolean Success = null;
        public String Message = null;
        public ResponseStatus ResponseStatus = null;
        
        public Boolean isSuccess() { return Success; }
        public ReclaimVirtualContactResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public ReclaimVirtualContactResponse setMessage(String value) { this.Message = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ReclaimVirtualContactResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java 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"}}}