| All Verbs | /api/contactrolegroup/{ContactRoleGroupId} |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Get details of the specified contact role group
*/
@Api(Description="Get details of the specified contact role group")
public static 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")
public UUID ContactRoleGroupId = null;
public UUID getContactRoleGroupId() { return ContactRoleGroupId; }
public GetContactRoleGroupDetails setContactRoleGroupId(UUID value) { this.ContactRoleGroupId = value; return this; }
}
@ApiResponse(Description="Details of the specified contact role group")
public static class GetContactRoleGroupDetailsResponse
{
public RoleGroupModel ContactRoleGroup = null;
public ResponseStatus ResponseStatus = null;
public RoleGroupModel getContactRoleGroup() { return ContactRoleGroup; }
public GetContactRoleGroupDetailsResponse setContactRoleGroup(RoleGroupModel value) { this.ContactRoleGroup = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetContactRoleGroupDetailsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class RoleGroupModel
{
/**
* Role Group Id
*/
@ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
public UUID RoleGroupId = null;
/**
* Role Group Name
*/
@ApiMember(DataType="string", Description="Role Group Name", Name="Name")
public String Name = null;
/**
* Owner Contact Id
*/
@ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
public UUID OwnerContactId = null;
/**
* Number of Roles
*/
@ApiMember(DataType="int", Description="Number of Roles", Name="NumberOfRoles")
public Integer NumberOfRoles = null;
/**
* Roles belonging to the Role Group
*/
@ApiMember(DataType="List", Description="Roles belonging to the Role Group", Name="Roles")
public ArrayList<RoleGroupRolesModel> Roles = null;
/**
* 'A' (Active), 'I' (Inactive)
*/
@ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
public String RecordStatus = 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")
public Boolean AllowEdit = null;
public UUID getRoleGroupId() { return RoleGroupId; }
public RoleGroupModel setRoleGroupId(UUID value) { this.RoleGroupId = value; return this; }
public String getName() { return Name; }
public RoleGroupModel setName(String value) { this.Name = value; return this; }
public UUID getOwnerContactId() { return OwnerContactId; }
public RoleGroupModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
public Integer getNumberOfRoles() { return NumberOfRoles; }
public RoleGroupModel setNumberOfRoles(Integer value) { this.NumberOfRoles = value; return this; }
public ArrayList<RoleGroupRolesModel> getRoles() { return Roles; }
public RoleGroupModel setRoles(ArrayList<RoleGroupRolesModel> value) { this.Roles = value; return this; }
public String getRecordStatus() { return RecordStatus; }
public RoleGroupModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
public Boolean isAllowEdit() { return AllowEdit; }
public RoleGroupModel setAllowEdit(Boolean value) { this.AllowEdit = value; return this; }
}
public static class RoleGroupRolesModel
{
/**
* Role Id
*/
@ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
public UUID RoleId = null;
/**
* Role Name
*/
@ApiMember(DataType="string", Description="Role Name", Name="RoleName")
public String RoleName = null;
/**
* Role Group Id
*/
@ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
public UUID RoleGroupId = null;
/**
* Role Group Name
*/
@ApiMember(DataType="string", Description="Role Group Name", Name="RoleGroupName")
public String RoleGroupName = null;
/**
* Role Group Role Id
*/
@ApiMember(DataType="Guid", Description="Role Group Role Id", Name="RoleGroupRoleId")
public UUID RoleGroupRoleId = null;
/**
* 'A' (Active), 'I' (Inactive)
*/
@ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
public String RecordStatus = null;
/**
* Owner Contact Id
*/
@ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
public UUID OwnerContactId = null;
public UUID getRoleId() { return RoleId; }
public RoleGroupRolesModel setRoleId(UUID value) { this.RoleId = value; return this; }
public String getRoleName() { return RoleName; }
public RoleGroupRolesModel setRoleName(String value) { this.RoleName = value; return this; }
public UUID getRoleGroupId() { return RoleGroupId; }
public RoleGroupRolesModel setRoleGroupId(UUID value) { this.RoleGroupId = value; return this; }
public String getRoleGroupName() { return RoleGroupName; }
public RoleGroupRolesModel setRoleGroupName(String value) { this.RoleGroupName = value; return this; }
public UUID getRoleGroupRoleId() { return RoleGroupRoleId; }
public RoleGroupRolesModel setRoleGroupRoleId(UUID value) { this.RoleGroupRoleId = value; return this; }
public String getRecordStatus() { return RecordStatus; }
public RoleGroupRolesModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
public UUID getOwnerContactId() { return OwnerContactId; }
public RoleGroupRolesModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
}
}
Java GetContactRoleGroupDetails DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"ContactRoleGroupId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ContactRoleGroup":{"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},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}