GET api/auction/{id}
Get an auction by its id. Processes this auction API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The id of the auction to get. Pass 0 to be returned an empty data contract. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The auction or null if it does not exist
AuctionDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| CutOffDate |
The cut off date, expressed as a date and time. |
date |
None. |
| AllDayEvent |
Indicates whether all day event is true. |
boolean |
None. |
| StartDate |
The start date, expressed as a date and time. |
date |
None. |
| EndDate |
The end date, expressed as a date and time. |
date |
None. |
| Address |
The address value. |
AddressDataContract |
None. |
| MeetingPlace |
The meeting place value. |
MeetingPlaceDataContract |
None. |
| AttendingGroups |
The collection of attending groups. |
Collection of AppointmentAttendeeCollectionDataContract |
None. |
| SpecialArrangements |
The collection of special arrangements. |
Collection of SpecialArrangementDataContract |
None. |
| Roles |
The collection of roles. |
Collection of RoleDataContract |
None. |
| MarketingRoleId |
The unique identifier of the related marketing role resource. |
integer |
None. |
| PropertyId |
The unique identifier of the related property resource. |
integer |
None. |
| AppointmentRecurringSchedule |
The appointment recurring schedule value. |
AppointmentRecurringScheduleDataContract |
None. |
| ExternalAppointmentReference |
The external appointment reference value. |
string |
None. |
| AppointmentRecurringScheduleId |
The unique identifier of the related appointment recurring schedule resource. |
integer |
None. |
| AppointmentRecurringFirstInstanceId |
The unique identifier of the related appointment recurring first instance resource. |
integer |
None. |
| Team |
The team value. |
EventTeamDataContract |
None. |
| Notes |
The collection of notes. |
Collection of EventNoteCommandDataContract |
None. |
| Documents |
The collection of documents. |
Collection of DocumentDataContract |
None. |
| Name |
The name value. |
string |
None. |
| Description |
The description value. |
string |
None. |
| DateTime |
The date time, expressed as a date and time. |
date |
None. |
| EventCategory |
The event category value. |
EnumDataContract |
None. |
| EventType |
The event type value. |
EnumDataContract |
None. |
| EventStatus |
The event status value. |
EnumDataContract |
None. |
| Negotiators |
The collection of negotiators. |
Collection of ListNegotiatorDataContract |
None. |
| BranchId |
The unique identifier of the related branch resource. |
integer |
None. |
| OwningTeamId |
The unique identifier of the related owning team resource. |
integer |
None. |
| TeamAccessType |
The team access type value. |
string |
None. |
| CustomFields |
The collection of custom fields. |
Collection of CustomFieldGroupWithValuesDataContract |
None. |
| CreatedDate |
The created date, expressed as a date and time. |
date |
None. |
| CreatedBy |
The created by value. |
CreatedByDataContract |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.