| All Verbs | /api/contactrolegroups/{LicenseeId} |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Get role groups for the given criteria
*/
@Api(Description="Get role groups for the given criteria")
public static class GetContactRoleGroups extends PagedModel
{
/**
* Get contact role groups for the specified licensee
*/
@ApiMember(DataType="Guid", Description="Get contact role groups for the specified licensee", IsRequired=true, Name="LicenseeId", ParameterType="query")
public UUID LicenseeId = null;
/**
* Role Group Name
*/
@ApiMember(DataType="string", Description="Role Group Name", Name="Name", ParameterType="query")
public String Name = null;
/**
* Active/Archived filter
*/
@ApiMember(DataType="string", Description="Active/Archived filter", Name="RecordStatus", ParameterType="query")
public String RecordStatus = null;
public UUID getLicenseeId() { return LicenseeId; }
public GetContactRoleGroups setLicenseeId(UUID value) { this.LicenseeId = value; return this; }
public String getName() { return Name; }
public GetContactRoleGroups setName(String value) { this.Name = value; return this; }
public String getRecordStatus() { return RecordStatus; }
public GetContactRoleGroups setRecordStatus(String value) { this.RecordStatus = value; return this; }
}
public static class PagedModel
{
/**
* Page Number to retrieve
*/
@ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
public Integer PageNumber = null;
/**
* Number of records to retrieve
*/
@ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
public Integer PageSize = null;
/**
* Index of field to sort results by
*/
@ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
public Integer SortIndex = null;
/**
* Sort Order - Ascending or Descending
*/
@ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
public SortOrder SortOrder = null;
public Integer getPageNumber() { return PageNumber; }
public PagedModel setPageNumber(Integer value) { this.PageNumber = value; return this; }
public Integer getPageSize() { return PageSize; }
public PagedModel setPageSize(Integer value) { this.PageSize = value; return this; }
public Integer getSortIndex() { return SortIndex; }
public PagedModel setSortIndex(Integer value) { this.SortIndex = value; return this; }
public SortOrder getSortOrder() { return SortOrder; }
public PagedModel setSortOrder(SortOrder value) { this.SortOrder = value; return this; }
}
public static enum SortOrder
{
Ascending,
Descending;
}
@ApiResponse(Description="List of role groups")
public static class GetContactRoleGroupsResponse
{
public ArrayList<RoleGroupModel> RoleGroups = null;
public Integer TotalRoleGroups = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<RoleGroupModel> getRoleGroups() { return RoleGroups; }
public GetContactRoleGroupsResponse setRoleGroups(ArrayList<RoleGroupModel> value) { this.RoleGroups = value; return this; }
public Integer getTotalRoleGroups() { return TotalRoleGroups; }
public GetContactRoleGroupsResponse setTotalRoleGroups(Integer value) { this.TotalRoleGroups = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetContactRoleGroupsResponse 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 GetContactRoleGroups 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/contactrolegroups/{LicenseeId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetContactRoleGroups xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<PageNumber xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</PageNumber>
<PageSize xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</PageSize>
<SortIndex xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</SortIndex>
<SortOrder xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">Ascending</SortOrder>
<LicenseeId>00000000-0000-0000-0000-000000000000</LicenseeId>
<Name>String</Name>
<RecordStatus>String</RecordStatus>
</GetContactRoleGroups>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetContactRoleGroupsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<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>
<RoleGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:RoleGroupModel>
<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>
</d2p1:RoleGroupModel>
</RoleGroups>
<TotalRoleGroups>0</TotalRoleGroups>
</GetContactRoleGroupsResponse>