| All Verbs | /api/connections/is-connected/{ContactId}/to/{LicenseeId}/role/{RoleId} |
|---|
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<ApiResponse(Description="Returns whether or not a contact with a specific role is connected to a licensee.")>]
[<AllowNullLiteral>]
type IsConnectedInRoleResponse() =
///<summary>
///True or false depending on if the contact is connected to the licensee in the role.
///</summary>
[<ApiMember(DataType="bool", Description="True or false depending on if the contact is connected to the licensee in the role.", Name="IsConnected")>]
member val IsConnected:Boolean = new Boolean() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Return true/false if a contact is connected to a licensee in a specific role.
///</summary>
[<Api(Description="Return true/false if a contact is connected to a licensee in a specific role.")>]
[<AllowNullLiteral>]
type IsConnectedInRole() =
///<summary>
///Contact Id of the contact to determine if they have the role with the licensee.
///</summary>
[<ApiMember(DataType="Guid", Description="Contact Id of the contact to determine if they have the role with the licensee.", IsRequired=true, Name="ContactId")>]
member val ContactId:Guid = new Guid() with get,set
///<summary>
///Role to check for.
///</summary>
[<ApiMember(DataType="Guid", Description="Role to check for.", IsRequired=true, Name="RoleId")>]
member val RoleId:Guid = new Guid() with get,set
///<summary>
///Licensee Contact Id we are checking if we're connected to.
///</summary>
[<ApiMember(DataType="Guid", Description="Licensee Contact Id we are checking if we're connected to.", IsRequired=true, Name="LicenseeId")>]
member val LicenseeId:Guid = new Guid() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"ContactId":"00000000-0000-0000-0000-000000000000","RoleId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}