GET api/appointment/{id}

Get an appointment by its id.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The id of the appointment to get. Pass 0 to be returned an empty data contract.	integer	Required

Body Parameters

None.

Response Information

Resource Description

The role or null if it does not exist

AppointmentDataContract

Name	Type	Additional information
AllDayEvent	boolean	None.
StartDate	date	None.
EndDate	date	None.
Address	AddressDataContract	None.
MeetingPlace	MeetingPlaceDataContract	None.
AttendingGroups	Collection of AppointmentAttendeeCollectionDataContract	None.
SpecialArrangements	Collection of SpecialArrangementDataContract	None.
Roles	Collection of RoleDataContract	None.
MarketingRoleId	integer	None.
PropertyId	integer	None.
AppointmentRecurringSchedule	AppointmentRecurringScheduleDataContract	None.
ExternalAppointmentReference	string	None.
AppointmentRecurringScheduleId	integer	None.
AppointmentRecurringFirstInstanceId	integer	None.
Team	EventTeamDataContract	None.
Notes	Collection of EventNoteCommandDataContract	None.
Documents	Collection of DocumentDataContract	None.
Name	string	None.
Description	string	None.
DateTime	date	None.
EventCategory	EnumDataContract	None.
EventType	EnumDataContract	None.
EventStatus	EnumDataContract	None.
Negotiators	Collection of ListNegotiatorDataContract	None.
BranchId	integer	None.
OwningTeamId	integer	None.
TeamAccessType	string	None.
CustomFields	Collection of CustomFieldGroupWithValuesDataContract	None.
CreatedDate	date	None.
CreatedBy	CreatedByDataContract	None.
Id	integer	None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path 'Documents[0].Attachments'.

text/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path 'Documents[0].Attachments'.