Platform API

GetRolesForConnection

Get roles for the specified contact

The following routes are available for this service:
All Verbs	/api/roles/connection/{FromContactId}


export class RoleModel
{
    /** @description Role Id */
    // @ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")
    public RoleId: string;

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

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

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

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

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

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

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

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

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

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

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

    /** @description 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 ObjectConnectionId: string;

    public constructor(init?: Partial<RoleModel>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="List of roles available for connection from the specified contact for specified contact types")
export class GetRolesForConnectionResponse
{
    public Roles: RoleModel[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetRolesForConnectionResponse>) { (Object as any).assign(this, init); }
}

/** @description Get roles for the specified contact */
// @Api(Description="Get roles for the specified contact")
export class GetRolesForConnection
{
    /** @description Get roles available for connection from this contact */
    // @ApiMember(Description="Get roles available for connection from this contact", IsRequired=true, Name="FromContactId")
    public FromContactId: string;

    /** @description Get roles available for connection to this contact */
    // @ApiMember(Description="Get roles available for connection to this contact", Name="ContactId")
    public ContactId?: string;

    /** @description Get roles available for connection for the specified contact type */
    // @ApiMember(Description="Get roles available for connection for the specified contact type", IsRequired=true, Name="ContactTypeId")
    public ContactTypeId: string;

    public constructor(init?: Partial<GetRolesForConnection>) { (Object as any).assign(this, init); }
}

TypeScript GetRolesForConnection DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/roles/connection/{FromContactId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ContactId: 00000000000000000000000000000000
}

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
		}
	}
}