| All Verbs | /api/contacts/{ContactId}/invite/contact | ||
|---|---|---|---|
| All Verbs | /api/contacts/{ContactId}/invite/{ToContactId} |
import Foundation
import ServiceStack
public class InviteContact : Codable
{
/**
* Contact Id inviting the contact
*/
// @ApiMember(DataType="Guid", Description="Contact Id inviting the contact", IsRequired=true, Name="ContactId")
public var contactId:String
/**
* 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 var toContactId:String
/**
* 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 var emailAddress:String
/**
* List of roles to invite the contact
*/
// @ApiMember(DataType="List<Guid>", Description="List of roles to invite the contact", IsRequired=true, Name="Roles")
public var roles:[String] = []
required public init(){}
}
// @ApiResponse(Description="Contact Id of the newly invited/ created contact")
public class AddContactResponse : Codable
{
public var contactId:String
public var responseStatus:ResponseStatus
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
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/csv
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"}}}