| All Verbs | /api/contactrolegroup/{ContactRoleGroupId} |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get details of the specified contact role group
*/
@Api(Description="Get details of the specified contact role group")
open class GetContactRoleGroupDetails
{
/**
* The Contact Role Group Guid. Records retrieved will belong to this role group.
*/
@ApiMember(DataType="Guid", Description="The Contact Role Group Guid. Records retrieved will belong to this role group.", IsRequired=true, Name="ContactRoleGroupId", ParameterType="query")
open var ContactRoleGroupId:UUID? = null
}
@ApiResponse(Description="Details of the specified contact role group")
open class GetContactRoleGroupDetailsResponse
{
open var ContactRoleGroup:RoleGroupModel? = null
open var ResponseStatus:ResponseStatus? = null
}
open class RoleGroupModel
{
/**
* Role Group Id
*/
@ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
open var RoleGroupId:UUID? = null
/**
* Role Group Name
*/
@ApiMember(DataType="string", Description="Role Group Name", Name="Name")
open var Name:String? = null
/**
* Owner Contact Id
*/
@ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
open var OwnerContactId:UUID? = null
/**
* Number of Roles
*/
@ApiMember(DataType="int", Description="Number of Roles", Name="NumberOfRoles")
open var NumberOfRoles:Int? = null
/**
* Roles belonging to the Role Group
*/
@ApiMember(DataType="List", Description="Roles belonging to the Role Group", Name="Roles")
open var Roles:ArrayList<RoleGroupRolesModel>? = null
/**
* 'A' (Active), 'I' (Inactive)
*/
@ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
open var RecordStatus:String? = null
/**
* True if Licensee-owned, allowing editing, deleting, archiving
*/
@ApiMember(DataType="bool", Description="True if Licensee-owned, allowing editing, deleting, archiving", Name="AllowEdit", ParameterType="query")
open var AllowEdit:Boolean? = null
}
open class RoleGroupRolesModel
{
/**
* Role Id
*/
@ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
open var RoleId:UUID? = null
/**
* Role Name
*/
@ApiMember(DataType="string", Description="Role Name", Name="RoleName")
open var RoleName:String? = null
/**
* Role Group Id
*/
@ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
open var RoleGroupId:UUID? = null
/**
* Role Group Name
*/
@ApiMember(DataType="string", Description="Role Group Name", Name="RoleGroupName")
open var RoleGroupName:String? = null
/**
* Role Group Role Id
*/
@ApiMember(DataType="Guid", Description="Role Group Role Id", Name="RoleGroupRoleId")
open var RoleGroupRoleId:UUID? = null
/**
* 'A' (Active), 'I' (Inactive)
*/
@ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
open var RecordStatus:String? = null
/**
* Owner Contact Id
*/
@ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
open var OwnerContactId:UUID? = null
}
Kotlin 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
}
}
}