POST v1/appointments/search

Search for appointments using the search filters.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Subject		string	None.
AppointmentTypeIds	Search by Appointment Type Ids.	Collection of integer	None.
EmployeeIds	Search by Employee Ids.	Collection of integer	None.
MeetingTime	The appointment meeting time (in company time zone).	DateRange	None.
Status	Searches by the Appointment Status (45 - Scheduled, Done - 46, Cancelled - 47)	integer	None.
PageIndex	zero-based page number	integer	None.
PageSize	Default value is 100	integer	Range: inclusive between 1 and 1000
SortExpression	Specify the field name to sort the result set by. It can be one of the fields returned by the search.	string	None.
SortOrder	Specify Sort Order. Ascending=1, Descending=2. Default value is 1 (Ascending)	integer	Range: inclusive between 1 and 2

Request Formats

application/json, text/json

Sample:

{
  "subject": "sample string 1",
  "appointmentTypeIds": [
    1,
    2
  ],
  "employeeIds": [
    1,
    2
  ],
  "meetingTime": null,
  "status": 1,
  "pageIndex": 2,
  "pageSize": 3,
  "sortExpression": "sample string 4",
  "sortOrder": 5
}

application/xml, text/xml

Sample:

<AppointmentSearchParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.HR">
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">2</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">3</PageSize>
  <SortExpression xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">sample string 4</SortExpression>
  <SortOrder xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">5</SortOrder>
  <AppointmentTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </AppointmentTypeIds>
  <EmployeeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </EmployeeIds>
  <MeetingTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <Status>1</Status>
  <Subject>sample string 1</Subject>
</AppointmentSearchParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchResultOfAppointmentSearchResult

Name	Description	Type	Additional information
TotalCount		integer	None.
Data		Collection of AppointmentSearchResult	None.

Response Formats

application/json, text/json

Sample:

{
  "totalCount": 1,
  "data": [
    {
      "id": 1,
      "subject": "sample string 2",
      "type": {
        "id": 1,
        "name": "sample string 2"
      },
      "status": {
        "id": 1,
        "name": "sample string 2"
      },
      "meetingTime": null,
      "dateCreated": "2024-04-24T19:12:57.2520127-04:00",
      "lastUpdatedDate": "2024-04-24T19:12:57.2520127-04:00"
    },
    {
      "id": 1,
      "subject": "sample string 2",
      "type": {
        "id": 1,
        "name": "sample string 2"
      },
      "status": {
        "id": 1,
        "name": "sample string 2"
      },
      "meetingTime": null,
      "dateCreated": "2024-04-24T19:12:57.2520127-04:00",
      "lastUpdatedDate": "2024-04-24T19:12:57.2520127-04:00"
    }
  ]
}

application/xml, text/xml

Sample:

<SearchResultOfAppointmentSearchResultIwd5Rtbp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.HR">
    <d2p1:AppointmentSearchResult>
      <d2p1:DateCreated>2024-04-24T19:12:57.2520127-04:00</d2p1:DateCreated>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LastUpdatedDate>2024-04-24T19:12:57.2520127-04:00</d2p1:LastUpdatedDate>
      <d2p1:MeetingTime i:nil="true" />
      <d2p1:Status 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>
      </d2p1:Status>
      <d2p1:Subject>sample string 2</d2p1:Subject>
      <d2p1:Type 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>
      </d2p1:Type>
    </d2p1:AppointmentSearchResult>
    <d2p1:AppointmentSearchResult>
      <d2p1:DateCreated>2024-04-24T19:12:57.2520127-04:00</d2p1:DateCreated>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LastUpdatedDate>2024-04-24T19:12:57.2520127-04:00</d2p1:LastUpdatedDate>
      <d2p1:MeetingTime i:nil="true" />
      <d2p1:Status 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>
      </d2p1:Status>
      <d2p1:Subject>sample string 2</d2p1:Subject>
      <d2p1:Type 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>
      </d2p1:Type>
    </d2p1:AppointmentSearchResult>
  </Data>
  <TotalCount>1</TotalCount>
</SearchResultOfAppointmentSearchResultIwd5Rtbp>