| All Verbs | /api/contactrolegroups/{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 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="List of role groups")>]
[<AllowNullLiteral>]
type GetContactRoleGroupsResponse() =
member val RoleGroups:ResizeArray<RoleGroupModel> = null with get,set
member val TotalRoleGroups:Int32 = new Int32() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
type SortOrder =
| Ascending = 0
| Descending = 1
[<AllowNullLiteral>]
type PagedModel() =
///<summary>
///Page Number to retrieve
///</summary>
[<ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")>]
member val PageNumber:Int32 = new Int32() with get,set
///<summary>
///Number of records to retrieve
///</summary>
[<ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")>]
member val PageSize:Int32 = new Int32() with get,set
///<summary>
///Index of field to sort results by
///</summary>
[<ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")>]
member val SortIndex:Int32 = new Int32() with get,set
///<summary>
///Sort Order - Ascending or Descending
///</summary>
[<ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")>]
member val SortOrder:SortOrder = new SortOrder() with get,set
///<summary>
///Get role groups for the given criteria
///</summary>
[<Api(Description="Get role groups for the given criteria")>]
[<AllowNullLiteral>]
type GetContactRoleGroups() =
inherit PagedModel()
///<summary>
///Get contact role groups for the specified licensee
///</summary>
[<ApiMember(DataType="Guid", Description="Get contact role groups for the specified licensee", IsRequired=true, Name="LicenseeId", ParameterType="query")>]
member val LicenseeId:Guid = new Guid() with get,set
///<summary>
///Role Group Name
///</summary>
[<ApiMember(DataType="string", Description="Role Group Name", Name="Name", ParameterType="query")>]
member val Name:String = 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/contactrolegroups/{LicenseeId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"LicenseeId":"00000000-0000-0000-0000-000000000000","Name":"String","RecordStatus":"String","PageNumber":0,"PageSize":0,"SortIndex":0,"SortOrder":"Ascending"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"RoleGroups":[{"RoleGroupId":"00000000-0000-0000-0000-000000000000","Name":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","NumberOfRoles":0,"Roles":[{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","RoleGroupId":"00000000-0000-0000-0000-000000000000","RoleGroupName":"String","RoleGroupRoleId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000"}],"RecordStatus":"String","AllowEdit":false}],"TotalRoleGroups":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}