GET v1/appointments/{id}

Gets appointment details by id.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Provide appointment id to get details	integer	Required

Body Parameters

None.

Response Information

Resource Description

Appointment

Name	Description	Type	Additional information
Id	Appointment Id	integer	None.
Subject	Appointment Subject	string	None.
MeetingTime	The appointment meeting time (in company time zone).	DateRange	None.
Notes	Appointment Notes	string	None.
CustomerVendors	List of Customer/Vendor added to appointment	Collection of AccountRef	None.
Organizer	Appointment Organizer Info	Attendee	None.
Attendees	Appointment Attendees	Collection of Attendee	None.
DateCreated	Read-only. The date and time (in company time zone) when the appointment was created.	date	None.
CreatedBy	The person who created the appointment.	IdNamePair	None.
LastUpdatedDate	Read-only. The date and time (in company time zone) when the appointment was last updated.	date	None.
LastUpdatedBy	The person who last updated the appointment.	IdNamePair	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "subject": "sample string 2",
  "meetingTime": null,
  "notes": "sample string 3",
  "customerVendors": [
    {
      "id": 1,
      "number": "sample string 2",
      "name": "sample string 3"
    },
    {
      "id": 1,
      "number": "sample string 2",
      "name": "sample string 3"
    }
  ],
  "organizer": {
    "id": 1,
    "type": "sample string 2",
    "name": "sample string 3",
    "email": {
      "id": 1,
      "email": "sample string 2",
      "isPrimary": true,
      "active": true
    },
    "phone": {
      "id": 1,
      "phoneType": {
        "id": 1,
        "name": "sample string 2"
      },
      "countryDialCode": 2,
      "number": "sample string 3",
      "extension": "sample string 4",
      "isPreferred": true,
      "active": true
    }
  },
  "attendees": [
    {
      "id": 1,
      "type": "sample string 2",
      "name": "sample string 3",
      "email": {
        "id": 1,
        "email": "sample string 2",
        "isPrimary": true,
        "active": true
      },
      "phone": {
        "id": 1,
        "phoneType": {
          "id": 1,
          "name": "sample string 2"
        },
        "countryDialCode": 2,
        "number": "sample string 3",
        "extension": "sample string 4",
        "isPreferred": true,
        "active": true
      }
    },
    {
      "id": 1,
      "type": "sample string 2",
      "name": "sample string 3",
      "email": {
        "id": 1,
        "email": "sample string 2",
        "isPrimary": true,
        "active": true
      },
      "phone": {
        "id": 1,
        "phoneType": {
          "id": 1,
          "name": "sample string 2"
        },
        "countryDialCode": 2,
        "number": "sample string 3",
        "extension": "sample string 4",
        "isPreferred": true,
        "active": true
      }
    }
  ],
  "dateCreated": "2024-04-26T04:02:52.2635819-04:00",
  "createdBy": {
    "id": 1,
    "name": "sample string 2"
  },
  "lastUpdatedDate": "2024-04-26T04:02:52.2635819-04:00",
  "lastUpdatedBy": {
    "id": 1,
    "name": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<Appointment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.HR">
  <Attendees>
    <Attendee>
      <Email xmlns:d4p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
        <d4p1:Active>true</d4p1:Active>
        <d4p1:Email>sample string 2</d4p1:Email>
        <d4p1:Id>1</d4p1:Id>
        <d4p1:IsPrimary>true</d4p1:IsPrimary>
      </Email>
      <Id>1</Id>
      <Name>sample string 3</Name>
      <Phone xmlns:d4p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
        <d4p1:Active>true</d4p1:Active>
        <d4p1:CountryDialCode>2</d4p1:CountryDialCode>
        <d4p1:Extension>sample string 4</d4p1:Extension>
        <d4p1:Id>1</d4p1:Id>
        <d4p1:IsPreferred>true</d4p1:IsPreferred>
        <d4p1:Number>sample string 3</d4p1:Number>
        <d4p1:PhoneType xmlns:d5p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
          <d5p1:_x003C_Id_x003E_k__BackingField>1</d5p1:_x003C_Id_x003E_k__BackingField>
          <d5p1:_x003C_Name_x003E_k__BackingField>sample string 2</d5p1:_x003C_Name_x003E_k__BackingField>
        </d4p1:PhoneType>
      </Phone>
      <Type>sample string 2</Type>
    </Attendee>
    <Attendee>
      <Email xmlns:d4p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
        <d4p1:Active>true</d4p1:Active>
        <d4p1:Email>sample string 2</d4p1:Email>
        <d4p1:Id>1</d4p1:Id>
        <d4p1:IsPrimary>true</d4p1:IsPrimary>
      </Email>
      <Id>1</Id>
      <Name>sample string 3</Name>
      <Phone xmlns:d4p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
        <d4p1:Active>true</d4p1:Active>
        <d4p1:CountryDialCode>2</d4p1:CountryDialCode>
        <d4p1:Extension>sample string 4</d4p1:Extension>
        <d4p1:Id>1</d4p1:Id>
        <d4p1:IsPreferred>true</d4p1:IsPreferred>
        <d4p1:Number>sample string 3</d4p1:Number>
        <d4p1:PhoneType xmlns:d5p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
          <d5p1:_x003C_Id_x003E_k__BackingField>1</d5p1:_x003C_Id_x003E_k__BackingField>
          <d5p1:_x003C_Name_x003E_k__BackingField>sample string 2</d5p1:_x003C_Name_x003E_k__BackingField>
        </d4p1:PhoneType>
      </Phone>
      <Type>sample string 2</Type>
    </Attendee>
  </Attendees>
  <CreatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </CreatedBy>
  <CustomerVendors xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:AccountRef>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:Number>sample string 2</d2p1:Number>
    </d2p1:AccountRef>
    <d2p1:AccountRef>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:Number>sample string 2</d2p1:Number>
    </d2p1:AccountRef>
  </CustomerVendors>
  <DateCreated>2024-04-26T04:02:52.2635819-04:00</DateCreated>
  <Id>1</Id>
  <LastUpdatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </LastUpdatedBy>
  <LastUpdatedDate>2024-04-26T04:02:52.2635819-04:00</LastUpdatedDate>
  <MeetingTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <Notes>sample string 3</Notes>
  <Organizer>
    <Email xmlns:d3p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
      <d3p1:Active>true</d3p1:Active>
      <d3p1:Email>sample string 2</d3p1:Email>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:IsPrimary>true</d3p1:IsPrimary>
    </Email>
    <Id>1</Id>
    <Name>sample string 3</Name>
    <Phone xmlns:d3p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
      <d3p1:Active>true</d3p1:Active>
      <d3p1:CountryDialCode>2</d3p1:CountryDialCode>
      <d3p1:Extension>sample string 4</d3p1:Extension>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:IsPreferred>true</d3p1:IsPreferred>
      <d3p1:Number>sample string 3</d3p1:Number>
      <d3p1:PhoneType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d3p1:PhoneType>
    </Phone>
    <Type>sample string 2</Type>
  </Organizer>
  <Subject>sample string 2</Subject>
</Appointment>