Appointment Service (Deprecated)

Service to capture events such as meetings or appointments that occur at a specific time and appear on a user's calendar. WARNING: This service has been deprecated and is being replaced with ActivityService.

Life Cycle Status: Deprecated. This service is deprecated and replaced by .

QName: {http://xmlns.oracle.com/apps/crmCommon/activities/activitiesService/transient}ActivityAppointmentService

Service WSDL URL: https://servername/crmService/ActivityAppointmentService?WSDL

Relationships

The following table describes how this service data object is related to other service data objects or business object services.

Relationship Type	Object or Service
Next version is	Activity Service
Handles	Note Descriptive Flexfields
Handles	Appointment Contact
Handles	Appointment Transient SDO
Handles	Appointment Deletion Exception
Handles	Appointment Transient Assignee SDO
Handles	Common Attachment SDO
Handles	Appointment Transient Contact SDO
Handles	Appointment Assignee
Handles	Appointment Transient Note SDO
Handles	Appointment Category
Handles	Note
Handles	Appointment Transient Category SDO

Operations

• mergeAppointment

• copyAttachment

• createAttachment

• deleteAttachment

• getAttachment

• getAppointment

• createAppointment

• createActivityContact

• deleteActivityContact

• getActivityContact

• updateActivityContact

• createActivityAssignee

• deleteActivityAssignee

• getActivityAssignee

• updateActivityAssignee

• updateAppointment

• deleteAppointment

• findActivityAssignee

• getActivityCategories

• createActivityCategories

• updateActivityCategories

• deleteActivityCategories

• findActivityCategories

• findActivityContact

• getNotes

• createNotes

• updateNotes

• deleteNotes

• findNotes

• findAppointment

• getAppointmentDeleteException

• createAppointmentDeleteException

• updateAppointmentDeleteException

• deleteAppointmentDeleteException

• findAppointmentDeleteException

• getDfltObjAttrHints

• getServiceLastUpdateTime

• getEntityList

mergeAppointment

Merge operation for appointment.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
appointmentRow	Appointment Transient	Appointment ID to be merged.

Response Payload

Element Name	Type	Description
result	Appointment Transient	Merged appointment.

copyAttachment

Copy operation for appointment attachment.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
attachmentVORows	Common Attachment	The list of attachment objects to be copied or created.
commitData	string	Indicates whether data should be committed to the database.

Response Payload

Element Name	Type	Description
result	string	A list of warnings or informational messages encountered when deleting the appointment attachment.

createAttachment

Creates an appointment attachment.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
attachmentVORows	Common Attachment	The list of attachment objects to be copied or created.
commitData	string	Indicates whether data should be committed to the database.

Response Payload

Element Name	Type	Description
result	string	A list of warnings or informational messages encountered when deleting the appointment attachment.

deleteAttachment

Deletes an appointment attachment.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
deleteParams	Common Attachment	Parameters driving the delete operation for appointment attachment.
commitData	string	Indicates whether data should be committed to the database.

Response Payload

Element Name	Type	Description
result	string	A list of warnings or informational messages encountered when deleting the appointment attachment.

getAttachment

Retrieves an appointment attachment.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
getParameters	Common Attachment	Parameters driving the get operation for appointment attachment.

Response Payload

Element Name	Type	Description
result	Common Attachment	The retrieved appointment attachment.

getAppointment

Get operation for appointment transient SDO.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
activityId	long	Identifier of the appointment to retrieved.

Response Payload

Element Name	Type	Description
result	Appointment Transient	Appointment transient SDO that matches the inbound key attributes.

createAppointment

Create operation for appointment transient SDO.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
appointment	Appointment Transient	Appointment transient SDO to be created.

Response Payload

Element Name	Type	Description
result	Appointment Transient	Created appointment transient SDO.

createActivityContact

Creates an appointment contact.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
activityContact	Appointment Contact	appointment contact to be created.

Response Payload

Element Name	Type	Description
result	Appointment Contact	Created appointment contact.

deleteActivityContact

Deletes an appointment contact.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
activityContact	Appointment Contact	Appointment contact to be deleted.

Response Payload

Element Name	Type	Description
result	void

getActivityContact

Retrieves an appointment contact.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
activityContactId	long	Unique identifier for activity contact record.

Response Payload

Element Name	Type	Description
result	Appointment Contact	Appointment contact that matches the inbound key attributes.

updateActivityContact

Updates appointment contact.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
activityContact	Appointment Contact	Appointment contact to be updated.

Response Payload

Element Name	Type	Description
result	Appointment Contact	Updated appointment contact.

createActivityAssignee

Creates an appointment assignee.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
activityAssignee	Appointment Assignee	Appointment assignee to be created.

Response Payload

Element Name	Type	Description
result	Appointment Assignee	Created appointment assignee.

deleteActivityAssignee

Deletes an appointment assignee.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
activityAssignee	Appointment Assignee	Appointment assignee to be deleted.

Response Payload

Element Name	Type	Description
result	void

getActivityAssignee

Retrieves an appointment assignee.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
activityAssigneeId	long	Unique identifier for activity assignee record.

Response Payload

Element Name	Type	Description
result	Appointment Assignee	Appointment assignee that matches the inbound key attributes.

updateActivityAssignee

Updates an appointment assignee.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
activityAssignee	Appointment Assignee	Appointment assignee to be updated.

Response Payload

Element Name	Type	Description
result	Appointment Assignee	Updated appointment assignee.

updateAppointment

Updates an appointment.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
appointmentRow	Appointment Transient	Identifier of the appointment to be updated.

Response Payload

Element Name	Type	Description
result	Appointment Transient	Updated appointment.

deleteAppointment

Deletes an appointment.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
appointmentRow	Appointment Transient	Identifier of the appointment to be deleted.

Response Payload

Element Name	Type	Description
result	void

findActivityAssignee

Find operation for appointment assignee.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	The criteria used to limit your query result, such as the filter (where clause), the fetch size, and so on.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	Find Control. Not currently used.

Response Payload

Element Name	Type	Description
result	Appointment Assignee	A list of appointment assignee that satisfy the inbound criteria.

getActivityCategories

Retrieves an appointment category.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
activityCategoryId	long	Identifier of the appointment category.

Response Payload

Element Name	Type	Description
result	Appointment Category	Appointment category that matches the inbound key attributes.

createActivityCategories

Creates an appointment category.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
activityCategories	Appointment Category	Appointment category to be created.

Response Payload

Element Name	Type	Description
result	Appointment Category	Created appointment category.

updateActivityCategories

Updates an appointment category.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
activityCategories	Appointment Category	Appointment category to be updated.

Response Payload

Element Name	Type	Description
result	Appointment Category	Updated appointment category.

deleteActivityCategories

Delete an appointment category.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
activityCategories	Appointment Category	Appointment category to be deleted.

Response Payload

Element Name	Type	Description
result	void

findActivityCategories

Find operation for appointment category.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	The criteria used to limit your query result, such as the filter (where clause), the fetch size, and so on.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	Find Control. Not currently used.

Response Payload

Element Name	Type	Description
result	Appointment Category	A list of appointment category that satisfy the inbound criteria.

findActivityContact

Find operation for appointment contact.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	The criteria used to limit your query result, such as the filter (where clause), the fetch size, and so on.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	Find Control. Not currently used.

Response Payload

Element Name	Type	Description
result	Appointment Contact	A list of appointment contact that satisfy the inbound criteria.

getNotes

Retrieves a note.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
noteId	long	Unique note identifier. This is the primary key of the notes table.

Response Payload

Element Name	Type	Description
result	Note	Note that matches the inbound key attributes.

createNotes

Creates a note.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
notes	Note	Note to be created.

Response Payload

Element Name	Type	Description
result	Note	Created note.

updateNotes

Updates a note.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
notes	Note	Note to be updated.

Response Payload

Element Name	Type	Description
result	Note	Updated note.

deleteNotes

Deletes a note.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
notes	Note	Note to be deleted.

Response Payload

Element Name	Type	Description
result	void

findNotes

Find operation for note.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	The criteria used to limit your query result, such as the filter (where clause), the fetch size, and so on.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	Find Control. Not currently used..

Response Payload

Element Name	Type	Description
result	Note	A list of notes that satisfy the inbound criteria.

findAppointment

Find operation for appointment transient SDO.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	The criteria used to limit your query result, such as the filter (where clause), the fetch size, and so on.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	Find Control. Not currently used.

Response Payload

Element Name	Type	Description
result	Appointment Transient	A list of appointment transient SDO that satisfy the inbound criteria.

getAppointmentDeleteException

Retrieves an appointment deletion exception.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
activityChildId	long	Retrieves an appointment deletion exception given the ID of an appointment child object.

Response Payload

Element Name	Type	Description
result	Appointment Deletion Exception	Appointment deletion exception that matches the inbound key attributes.

createAppointmentDeleteException

Creates an appointment deletion exception.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
appointmentDeleteException	Appointment Deletion Exception	Appointment deletion exception to be created.

Response Payload

Element Name	Type	Description
result	Appointment Deletion Exception	Created Appointment Deletion Exception.

updateAppointmentDeleteException

Updates an appointment deletion exception.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
appointmentDeleteException	Appointment Deletion Exception	Appointment deletion exception to be updated.

Response Payload

Element Name	Type	Description
result	Appointment Deletion Exception	Updated appointment deletion exception.

deleteAppointmentDeleteException

Deletes an appointment deletion exception.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
appointmentDeleteException	Appointment Deletion Exception	Appointment deletion exception to be deleted.

Response Payload

Element Name	Type	Description
result	void

findAppointmentDeleteException

Find operation for appointment deletion exception.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	The criteria used to limit your query result, such as the filter (where clause), the fetch size, and so on.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	Find Control. Not currently used.

Response Payload

Element Name	Type	Description
result	Appointment Deletion Exception	A list of appointment deletion exception that satisfy the inbound criteria.

getDfltObjAttrHints

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
viewName	string
localeName	string

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints

getServiceLastUpdateTime

Life Cycle Status: Active

Request Payload

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp

getEntityList

Life Cycle Status: Active

Request Payload

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo