Platform API

<back to all web services

GetAssociatedRolesForRole

Get associated roles for a specified role

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Get associated roles for a specified role
    */
    @Api(Description="Get associated roles for a specified role")
    public static class GetAssociatedRolesForRole
    {
        /**
        * The  Role Guid. Records retrieved will belong to this role.
        */
        @ApiMember(DataType="Guid", Description="The  Role Guid. Records retrieved will belong to this role.", IsRequired=true, Name="RoleId", ParameterType="query")
        public UUID RoleId = null;
        
        public UUID getRoleId() { return RoleId; }
        public GetAssociatedRolesForRole setRoleId(UUID value) { this.RoleId = value; return this; }
    }

    @ApiResponse(Description="List of associated roles by contact type")
    public static class GetAssociatedRolesForRoleResponse
    {
        public ArrayList<RoleModel> Roles = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<RoleModel> getRoles() { return Roles; }
        public GetAssociatedRolesForRoleResponse setRoles(ArrayList<RoleModel> value) { this.Roles = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetAssociatedRolesForRoleResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class RoleModel
    {
        /**
        * Role Id
        */
        @ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")
        public UUID RoleId = null;

        /**
        * Role Name
        */
        @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
        public String RoleName = null;

        /**
        * Is the role a licensee role?
        */
        @ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")
        public Boolean IsLicenseeRole = null;

        /**
        * Is manage contacts role?
        */
        @ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")
        public Boolean IsManageContacts = null;

        /**
        * Is the role a Platform role?
        */
        @ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")
        public Boolean IsPlatformRole = null;

        /**
        * Is the role a services role?
        */
        @ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")
        public Boolean IsServiceRole = null;

        /**
        * Is the role a customer role?
        */
        @ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")
        public Boolean IsCustomerRole = null;

        /**
        * Is the role a functional role?
        */
        @ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")
        public Boolean IsFunctionalRole = null;

        /**
        * Is the role an auto-accept role?
        */
        @ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")
        public Boolean IsRequestAutoAccepted = null;

        /**
        * Suite that the role belongs to
        */
        @ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")
        public UUID SuiteId = null;

        /**
        * Suite that the role belongs to
        */
        @ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")
        public String SuiteName = null;

        /**
        * 'A' (Active) or 'I' (Inactive)
        */
        @ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")
        public String RecordStatus = null;

        /**
        * Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.
        */
        @ApiMember(DataType="Guid", Description="Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.", Name="ObjectConnectionId")
        public UUID ObjectConnectionId = null;
        
        public UUID getRoleId() { return RoleId; }
        public RoleModel setRoleId(UUID value) { this.RoleId = value; return this; }
        public String getRoleName() { return RoleName; }
        public RoleModel setRoleName(String value) { this.RoleName = value; return this; }
        public Boolean getIsLicenseeRole() { return IsLicenseeRole; }
        public RoleModel setIsLicenseeRole(Boolean value) { this.IsLicenseeRole = value; return this; }
        public Boolean getIsManageContacts() { return IsManageContacts; }
        public RoleModel setIsManageContacts(Boolean value) { this.IsManageContacts = value; return this; }
        public Boolean getIsPlatformRole() { return IsPlatformRole; }
        public RoleModel setIsPlatformRole(Boolean value) { this.IsPlatformRole = value; return this; }
        public Boolean getIsServiceRole() { return IsServiceRole; }
        public RoleModel setIsServiceRole(Boolean value) { this.IsServiceRole = value; return this; }
        public Boolean getIsCustomerRole() { return IsCustomerRole; }
        public RoleModel setIsCustomerRole(Boolean value) { this.IsCustomerRole = value; return this; }
        public Boolean getIsFunctionalRole() { return IsFunctionalRole; }
        public RoleModel setIsFunctionalRole(Boolean value) { this.IsFunctionalRole = value; return this; }
        public Boolean getIsRequestAutoAccepted() { return IsRequestAutoAccepted; }
        public RoleModel setIsRequestAutoAccepted(Boolean value) { this.IsRequestAutoAccepted = value; return this; }
        public UUID getSuiteId() { return SuiteId; }
        public RoleModel setSuiteId(UUID value) { this.SuiteId = value; return this; }
        public String getSuiteName() { return SuiteName; }
        public RoleModel setSuiteName(String value) { this.SuiteName = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public RoleModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
        public UUID getObjectConnectionId() { return ObjectConnectionId; }
        public RoleModel setObjectConnectionId(UUID value) { this.ObjectConnectionId = value; return this; }
    }

}

Java GetAssociatedRolesForRole DTOs

POST /api/roles/{RoleId}/associatedroles/safetystaff 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

{
	Roles: 
	[
		{
			RoleName: String,
			IsLicenseeRole: False,
			IsManageContacts: False,
			IsPlatformRole: False,
			IsServiceRole: False,
			IsCustomerRole: False,
			IsFunctionalRole: False,
			IsRequestAutoAccepted: False,
			SuiteName: String,
			RecordStatus: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}