| 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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<InviteContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactId>00000000-0000-0000-0000-000000000000</ContactId>
<EmailAddress>String</EmailAddress>
<Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</Roles>
<ToContactId>00000000-0000-0000-0000-000000000000</ToContactId>
</InviteContact>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AddContactResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactId>00000000-0000-0000-0000-000000000000</ContactId>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</AddContactResponse>