| All Verbs | /api/contacts/{ContactId}/invite/contact | ||
|---|---|---|---|
| All Verbs | /api/contacts/{ContactId}/invite/{ToContactId} |
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class InviteContact
{
/**
* Contact Id inviting the contact
*/
@ApiMember(DataType="Guid", Description="Contact Id inviting the contact", IsRequired=true, Name="ContactId")
public UUID ContactId = null;
/**
* 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")
public UUID ToContactId = null;
/**
* 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")
public String EmailAddress = null;
/**
* List of roles to invite the contact
*/
@ApiMember(DataType="List<Guid>", Description="List of roles to invite the contact", IsRequired=true, Name="Roles")
public ArrayList<UUID> Roles = new ArrayList<UUID>();
public UUID getContactId() { return ContactId; }
public InviteContact setContactId(UUID value) { this.ContactId = value; return this; }
public UUID getToContactId() { return ToContactId; }
public InviteContact setToContactId(UUID value) { this.ToContactId = value; return this; }
public String getEmailAddress() { return EmailAddress; }
public InviteContact setEmailAddress(String value) { this.EmailAddress = value; return this; }
public ArrayList<UUID> getRoles() { return Roles; }
public InviteContact setRoles(ArrayList<UUID> value) { this.Roles = value; return this; }
}
@ApiResponse(Description="Contact Id of the newly invited/ created contact")
public static class AddContactResponse
{
public UUID ContactId = null;
public ResponseStatus ResponseStatus = null;
public UUID getContactId() { return ContactId; }
public AddContactResponse setContactId(UUID value) { this.ContactId = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public AddContactResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
Content-Type: application/json
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: application/json
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"}}}