| All Verbs | /api/contactroles/{LicenseeId} |
|---|
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
[<AllowNullLiteral>]
type RoleModel() =
///<summary>
///Role Id
///</summary>
[<ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")>]
member val RoleId:Guid = new Guid() with get,set
///<summary>
///Role Name
///</summary>
[<ApiMember(DataType="string", Description="Role Name", Name="RoleName")>]
member val RoleName:String = null with get,set
///<summary>
///Is the role a licensee role?
///</summary>
[<ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")>]
member val IsLicenseeRole:Boolean = new Boolean() with get,set
///<summary>
///Is manage contacts role?
///</summary>
[<ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")>]
member val IsManageContacts:Boolean = new Boolean() with get,set
///<summary>
///Is the role a Platform role?
///</summary>
[<ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")>]
member val IsPlatformRole:Boolean = new Boolean() with get,set
///<summary>
///Is the role a services role?
///</summary>
[<ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")>]
member val IsServiceRole:Boolean = new Boolean() with get,set
///<summary>
///Is the role a customer role?
///</summary>
[<ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")>]
member val IsCustomerRole:Boolean = new Boolean() with get,set
///<summary>
///Is the role a functional role?
///</summary>
[<ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")>]
member val IsFunctionalRole:Boolean = new Boolean() with get,set
///<summary>
///Is the role an auto-accept role?
///</summary>
[<ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")>]
member val IsRequestAutoAccepted:Boolean = new Boolean() with get,set
///<summary>
///Suite that the role belongs to
///</summary>
[<ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")>]
member val SuiteId:Guid = new Guid() with get,set
///<summary>
///Suite that the role belongs to
///</summary>
[<ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")>]
member val SuiteName:String = null with get,set
///<summary>
///'A' (Active) or 'I' (Inactive)
///</summary>
[<ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")>]
member val RecordStatus:String = null with get,set
///<summary>
///Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.
///</summary>
[<ApiMember(DataType="Guid", Description="Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.", Name="ObjectConnectionId")>]
member val ObjectConnectionId:Guid = new Guid() with get,set
[<ApiResponse(Description="List of contact roles (custom and/or standard) for the specified licensee")>]
[<AllowNullLiteral>]
type GetContactRolesForLicenseeResponse() =
member val Roles:ResizeArray<RoleModel> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Get contact roles (custom and/or standard) for the specified licensee
///</summary>
[<Api(Description="Get contact roles (custom and/or standard) for the specified licensee")>]
[<AllowNullLiteral>]
type GetContactRolesForLicensee() =
///<summary>
///Get contact roles (custom and/or standard) for the specified licensee
///</summary>
[<ApiMember(DataType="Guid", Description="Get contact roles (custom and/or standard) for the specified licensee", IsRequired=true, Name="LicenseeId", ParameterType="query")>]
member val LicenseeId:Guid = new Guid() with get,set
///<summary>
///Contact Types
///</summary>
[<ApiMember(DataType="List<Guid>", Description="Contact Types", Name="ContactTypes", ParameterType="query")>]
member val ContactTypes:ResizeArray<Guid> = null with get,set
///<summary>
///Custom/Standard filter
///</summary>
[<ApiMember(DataType="List<Guid>", Description="Custom/Standard filter", Name="OwnerFilterIds", ParameterType="query")>]
member val OwnerFilterIds:ResizeArray<Guid> = null with get,set
///<summary>
///Active/Archived filter
///</summary>
[<ApiMember(DataType="string", Description="Active/Archived filter", Name="RecordStatus", ParameterType="query")>]
member val RecordStatus:String = null with get,set
///<summary>
///Text filter
///</summary>
[<ApiMember(DataType="string", Description="Text filter", Name="SearchText", ParameterType="query")>]
member val SearchText:String = null with get,set
F# GetContactRolesForLicensee DTOs
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/contactroles/{LicenseeId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ContactTypes:
[
00000000-0000-0000-0000-000000000000
],
OwnerFilterIds:
[
00000000-0000-0000-0000-000000000000
],
RecordStatus: String,
SearchText: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Roles:
[
{
RoleName: String,
IsLicenseeRole: False,
IsManageContacts: False,
IsPlatformRole: False,
IsServiceRole: False,
IsCustomerRole: False,
IsFunctionalRole: False,
IsRequestAutoAccepted: False,
SuiteName: String,
RecordStatus: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}