Platform API

<back to all web services

InviteVirtualContact

Requires Authentication
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"ContactId":"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

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