| All Verbs | /api/contacts/{ContactId}/invite/contact | ||
|---|---|---|---|
| All Verbs | /api/contacts/{ContactId}/invite/{ToContactId} |
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Namespace Global
Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
<ApiResponse(Description:="Contact Id of the newly invited/ created contact")>
Public Partial Class AddContactResponse
Public Overridable Property ContactId As Guid
Public Overridable Property ResponseStatus As ResponseStatus
End Class
Public Partial Class InviteContact
'''<Summary>
'''Contact Id inviting the contact
'''</Summary>
<ApiMember(DataType:="Guid", Description:="Contact Id inviting the contact", IsRequired:=true, Name:="ContactId")>
Public Overridable Property ContactId As Guid
'''<Summary>
'''Contact Id of the virtual contact invited to be real.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="Contact Id of the virtual contact invited to be real.", Name:="ToContactId")>
Public Overridable Property ToContactId As Guid
'''<Summary>
'''Email Address of the real/ virtual contact to be invited.
'''</Summary>
<ApiMember(DataType:="string", Description:="Email Address of the real/ virtual contact to be invited.", IsRequired:=true, Name:="EmailAddress")>
Public Overridable Property EmailAddress As String
'''<Summary>
'''List of roles to invite the contact
'''</Summary>
<ApiMember(DataType:="List<Guid>", Description:="List of roles to invite the contact", IsRequired:=true, Name:="Roles")>
Public Overridable Property Roles As List(Of Guid) = New List(Of Guid)
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
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/jsonl
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"}}}