Skip to content

Get-HaloAppointment

SYNOPSIS

Gets appointments from the Halo API.

SYNTAX

Multi (Default)

1
2
3
Get-HaloAppointment [-ShowAll] [-StartDate <String>] [-EndDate <String>] [-Agents <String>] [-ShowHolidays]
 [-ShowProjects] [-ShowChanges] [-ShowAppointments] [-Search <String>] [-AppointmentsOnly] [-TasksOnly]
 [-HideCompleted] [-TicketID <Int64>] [<CommonParameters>]

Single

1
Get-HaloAppointment -AppointmentID <Int64> [-IncludeDetails] [<CommonParameters>]

DESCRIPTION

Retrieves appointments from the Halo API - supports a variety of filtering parameters.

EXAMPLES

Example 1

1
PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-Agents

Comma separated list of agent IDs. Returns these agent's appointments

1
2
3
4
5
6
7
8
9
Type: String
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AppointmentID

Appointment ID

1
2
3
4
5
6
7
8
9
Type: Int64
Parameter Sets: Single
Aliases:

Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-AppointmentsOnly

Only return appointments in the response

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-EndDate

Return appointments with an end date greater than this value

1
2
3
4
5
6
7
8
9
Type: String
Parameter Sets: Multi
Aliases: end_date

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HideCompleted

Exclude completed appointments from the response

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IncludeDetails

Whether to include extra objects in the response

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Single
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Search

Return appointments like this search string

1
2
3
4
5
6
7
8
9
Type: String
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ShowAll

Admin override to return all appointments

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ShowAppointments

Include appointments in the response

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ShowChanges

Include change requests in the response

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ShowHolidays

Include the appointment type 'holiday' in the response

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ShowProjects

Include projects in the response

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-StartDate

Return appointments with a start date greater than this value.

1
2
3
4
5
6
7
8
9
Type: String
Parameter Sets: Multi
Aliases: start_date

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TasksOnly

Only return tasks in the response

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-TicketID

Return appointments assigned to a particular ticket

1
2
3
4
5
6
7
8
9
Type: Int64
Parameter Sets: Multi
Aliases: ticket_id

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

A powershell object containing the response.

NOTES