| All Verbs | /api/contactrolegroup/{ContactRoleGroupId} |
|---|
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 RoleGroupRolesModel() =
///<summary>
///Role Id
///</summary>
[<ApiMember(DataType="Guid", Description="Role Id", 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>
///Role Group Id
///</summary>
[<ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")>]
member val RoleGroupId:Guid = new Guid() with get,set
///<summary>
///Role Group Name
///</summary>
[<ApiMember(DataType="string", Description="Role Group Name", Name="RoleGroupName")>]
member val RoleGroupName:String = null with get,set
///<summary>
///Role Group Role Id
///</summary>
[<ApiMember(DataType="Guid", Description="Role Group Role Id", Name="RoleGroupRoleId")>]
member val RoleGroupRoleId:Guid = new Guid() with get,set
///<summary>
///'A' (Active), 'I' (Inactive)
///</summary>
[<ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")>]
member val RecordStatus:String = null with get,set
///<summary>
///Owner Contact Id
///</summary>
[<ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")>]
member val OwnerContactId:Guid = new Guid() with get,set
[<AllowNullLiteral>]
type RoleGroupModel() =
///<summary>
///Role Group Id
///</summary>
[<ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")>]
member val RoleGroupId:Guid = new Guid() with get,set
///<summary>
///Role Group Name
///</summary>
[<ApiMember(DataType="string", Description="Role Group Name", Name="Name")>]
member val Name:String = null with get,set
///<summary>
///Owner Contact Id
///</summary>
[<ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")>]
member val OwnerContactId:Guid = new Guid() with get,set
///<summary>
///Number of Roles
///</summary>
[<ApiMember(DataType="int", Description="Number of Roles", Name="NumberOfRoles")>]
member val NumberOfRoles:Int32 = new Int32() with get,set
///<summary>
///Roles belonging to the Role Group
///</summary>
[<ApiMember(DataType="List", Description="Roles belonging to the Role Group", Name="Roles")>]
member val Roles:ResizeArray<RoleGroupRolesModel> = null with get,set
///<summary>
///'A' (Active), 'I' (Inactive)
///</summary>
[<ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")>]
member val RecordStatus:String = null with get,set
///<summary>
///True if Licensee-owned, allowing editing, deleting, archiving
///</summary>
[<ApiMember(DataType="bool", Description="True if Licensee-owned, allowing editing, deleting, archiving", Name="AllowEdit", ParameterType="query")>]
member val AllowEdit:Boolean = new Boolean() with get,set
[<ApiResponse(Description="Details of the specified contact role group")>]
[<AllowNullLiteral>]
type GetContactRoleGroupDetailsResponse() =
member val ContactRoleGroup:RoleGroupModel = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Get details of the specified contact role group
///</summary>
[<Api(Description="Get details of the specified contact role group")>]
[<AllowNullLiteral>]
type GetContactRoleGroupDetails() =
///<summary>
///The Contact Role Group Guid. Records retrieved will belong to this role group.
///</summary>
[<ApiMember(DataType="Guid", Description="The Contact Role Group Guid. Records retrieved will belong to this role group.", IsRequired=true, Name="ContactRoleGroupId", ParameterType="query")>]
member val ContactRoleGroupId:Guid = new Guid() with get,set
F# GetContactRoleGroupDetails 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/contactrolegroup/{ContactRoleGroupId} 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
{
ContactRoleGroup:
{
Name: String,
NumberOfRoles: 0,
Roles:
[
{
RoleName: String,
RoleGroupName: String,
RecordStatus: String
}
],
RecordStatus: String,
AllowEdit: False
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}