| All Verbs | /api/contacts/{ContactId}/invite/contact | ||
|---|---|---|---|
| All Verbs | /api/contacts/{ContactId}/invite/{ToContactId} |
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
[ApiResponse(Description="Contact Id of the newly invited/ created contact")]
public partial class AddContactResponse
{
public virtual Guid ContactId { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
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 virtual Guid ContactId { get; set; }
///<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 virtual Guid ToContactId { get; set; }
///<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 virtual string EmailAddress { get; set; }
///<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 virtual List<Guid> Roles { get; set; } = [];
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/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
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}