| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<GetContactRoleGroupDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactRoleGroupId>00000000-0000-0000-0000-000000000000</ContactRoleGroupId>
</GetContactRoleGroupDetails>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetContactRoleGroupDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactRoleGroup xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:AllowEdit>false</d2p1:AllowEdit>
<d2p1:Name>String</d2p1:Name>
<d2p1:NumberOfRoles>0</d2p1:NumberOfRoles>
<d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:RoleGroupId>00000000-0000-0000-0000-000000000000</d2p1:RoleGroupId>
<d2p1:Roles>
<d2p1:RoleGroupRolesModel>
<d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:RoleGroupId>00000000-0000-0000-0000-000000000000</d2p1:RoleGroupId>
<d2p1:RoleGroupName>String</d2p1:RoleGroupName>
<d2p1:RoleGroupRoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleGroupRoleId>
<d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
<d2p1:RoleName>String</d2p1:RoleName>
</d2p1:RoleGroupRolesModel>
</d2p1:Roles>
</ContactRoleGroup>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</GetContactRoleGroupDetailsResponse>