| All Verbs | /api/connections/is-connected/{ContactId}/to/{LicenseeId}/role/{RoleId} |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Return true/false if a contact is connected to a licensee in a specific role.
*/
@Api(Description="Return true/false if a contact is connected to a licensee in a specific role.")
open class IsConnectedInRole
{
/**
* Contact Id of the contact to determine if they have the role with the licensee.
*/
@ApiMember(DataType="Guid", Description="Contact Id of the contact to determine if they have the role with the licensee.", IsRequired=true, Name="ContactId")
open var ContactId:UUID? = null
/**
* Role to check for.
*/
@ApiMember(DataType="Guid", Description="Role to check for.", IsRequired=true, Name="RoleId")
open var RoleId:UUID? = null
/**
* Licensee Contact Id we are checking if we're connected to.
*/
@ApiMember(DataType="Guid", Description="Licensee Contact Id we are checking if we're connected to.", IsRequired=true, Name="LicenseeId")
open var LicenseeId:UUID? = null
}
@ApiResponse(Description="Returns whether or not a contact with a specific role is connected to a licensee.")
open class IsConnectedInRoleResponse
{
/**
* True or false depending on if the contact is connected to the licensee in the role.
*/
@ApiMember(DataType="bool", Description="True or false depending on if the contact is connected to the licensee in the role.", Name="IsConnected")
open var IsConnected:Boolean? = null
open var ResponseStatus:ResponseStatus? = null
}
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/connections/is-connected/{ContactId}/to/{LicenseeId}/role/{RoleId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
IsConnected: False,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}