Platform API

InviteVirtualContact

The following routes are available for this service:
All Verbs	/api/contacts/invitevirtualcontact

import Foundation
import ServiceStack

public class InviteVirtualContact : Codable
{
    public var contactId:String
    public var emailAddress:String
    public var roles:[String]

    required public init(){}
}

public class InviteVirtualContactResponse : Codable
{
    public var success:Bool
    public var message:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift InviteVirtualContact DTOs

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

HTTP + JSV

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

POST /api/contacts/invitevirtualcontact HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}