openapi: 3.1.0 info: title: Helpcenter Appointments S API version: 1.0.0 tags: - name: Appointments S paths: /Appointments__s: get: summary: GET /Appointments__s description: appointment records get operationId: getAppointmentsS responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/GetappointmentssResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore1604218709' - $ref: '#/components/schemas/ErrorResponseCore1875045219' security: - iam-oauth2-schema: - ZohoCRM.modules.appointments.READ tags: - Appointments S put: summary: PUT /Appointments__s description: appointment module records update operationId: putAppointmentsS requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PutappointmentssRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PutappointmentssResponse200' '207': description: Multi-Status — Response contains mixed status results content: application/json: schema: type: object additionalProperties: false description: Wrapped response containing data properties: data: type: array allOf: - contains: $ref: '#/components/schemas/Post207multistatusResponse207' description: success response in data minContains: 1 - contains: $ref: '#/components/schemas/ErrorResponseCore1544688711' description: error response in data minContains: 1 description: Array of success or failure data items items: oneOf: - $ref: '#/components/schemas/Post207multistatusResponse207' - $ref: '#/components/schemas/ErrorResponseCore1544688711' maxItems: 200 minItems: 2 required: - data '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - type: object additionalProperties: false description: Wrapped error response with data properties: data: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore1720623915' - $ref: '#/components/schemas/ErrorResponseCore622374562' - $ref: '#/components/schemas/ErrorResponseCore261228299' - $ref: '#/components/schemas/ErrorResponseCore1207168962' - $ref: '#/components/schemas/ErrorResponseCore1818284114' - $ref: '#/components/schemas/ErrorResponseCore1277582131' - $ref: '#/components/schemas/ErrorResponseCore1593946428' - $ref: '#/components/schemas/ErrorResponseCore2114620743' - $ref: '#/components/schemas/ErrorResponseCore1332683101' - $ref: '#/components/schemas/ErrorResponseCore1090893661' - $ref: '#/components/schemas/ErrorResponseCore653152835' - $ref: '#/components/schemas/ErrorResponseCore899638570' - $ref: '#/components/schemas/ErrorResponseCore496791912' - $ref: '#/components/schemas/ErrorResponseCore201487910' - $ref: '#/components/schemas/ErrorResponseCore55175210' maxItems: 25 required: - data - $ref: '#/components/schemas/ErrorResponseCore1009543207' security: - iam-oauth2-schema: - ZohoCRM.modules.appointments.UPDATE tags: - Appointments S post: summary: POST /Appointments__s description: appointment module records creation operationId: postAppointmentsS requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PostappointmentssRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PostappointmentssResponse200' '207': description: Multi-Status — Response contains mixed status results content: application/json: schema: type: object additionalProperties: false description: Wrapped response containing data properties: data: type: array allOf: - contains: $ref: '#/components/schemas/Post207multistatusResponse207' description: success response in data minContains: 1 - contains: $ref: '#/components/schemas/ErrorResponseCore1168955151' description: error response in data minContains: 1 description: Array of success or failure data items items: oneOf: - $ref: '#/components/schemas/Post207multistatusResponse207' - $ref: '#/components/schemas/ErrorResponseCore1168955151' maxItems: 200 minItems: 2 required: - data '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - type: object additionalProperties: false description: Wrapped error response with data properties: data: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore1720623915' - $ref: '#/components/schemas/ErrorResponseCore622374562' - $ref: '#/components/schemas/ErrorResponseCore261228299' - $ref: '#/components/schemas/ErrorResponseCore1207168962' - $ref: '#/components/schemas/ErrorResponseCore1818284114' - $ref: '#/components/schemas/ErrorResponseCore1277582131' - $ref: '#/components/schemas/ErrorResponseCore1593946428' - $ref: '#/components/schemas/ErrorResponseCore2114620743' - $ref: '#/components/schemas/ErrorResponseCore1332683101' - $ref: '#/components/schemas/ErrorResponseCore1090893661' - $ref: '#/components/schemas/ErrorResponseCore653152835' - $ref: '#/components/schemas/ErrorResponseCore899638570' - $ref: '#/components/schemas/ErrorResponseCore496791912' - $ref: '#/components/schemas/ErrorResponseCore201487910' - $ref: '#/components/schemas/ErrorResponseCore55175210' maxItems: 25 required: - data - $ref: '#/components/schemas/ErrorResponseCore1009543207' security: - iam-oauth2-schema: - ZohoCRM.modules.appointments.CREATE tags: - Appointments S delete: summary: DELETE /Appointments__s/{ids} description: appointment module record delete operationId: deleteAppointmentsS parameters: - $ref: '#/components/parameters/ParamQueryIds' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/DeleteappointmentssResponse200' '207': description: Multi-Status — Response contains mixed status results content: application/json: schema: type: object additionalProperties: false description: Wrapped response containing data properties: data: type: array allOf: - contains: $ref: '#/components/schemas/Delete207SuccessResponse' description: success response in data minContains: 1 - contains: $ref: '#/components/schemas/ErrorResponseCore2137699283' description: error response in data minContains: 1 description: Array of success or failure data items items: oneOf: - $ref: '#/components/schemas/Delete207SuccessResponse' maxItems: 200 minItems: 2 required: - data '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - type: object additionalProperties: false description: Wrapped error response with data properties: data: type: array description: Array of error objects items: $ref: '#/components/schemas/ErrorResponseCore2137699283' maxItems: 25 required: - data - $ref: '#/components/schemas/ErrorResponseCore1875045219' - $ref: '#/components/schemas/ErrorResponseCore1604218709' security: - iam-oauth2-schema: - ZohoCRM.modules.appointments.DELETE tags: - Appointments S /Appointments__s/{appointmentId}: get: summary: GET /Appointments__s/{appointmentId} description: appointment mode record get by id operationId: getAppointmentById parameters: - $ref: '#/components/parameters/ParamPathAppointmentid' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/GetappointmentssResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore1604218709' security: - iam-oauth2-schema: - ZohoCRM.modules.appointments.READ tags: - Appointments S put: summary: PUT /Appointments__s/{id} description: appointment module records update by appointment id operationId: updateAppointmentById parameters: - $ref: '#/components/parameters/ParamQueryId' - $ref: '#/components/parameters/ParamPathAppointmentid' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PutappointmentssRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PutappointmentssResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - type: object additionalProperties: false description: Wrapped error response with data properties: data: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore1720623915' - $ref: '#/components/schemas/ErrorResponseCore622374562' - $ref: '#/components/schemas/ErrorResponseCore261228299' - $ref: '#/components/schemas/ErrorResponseCore1207168962' - $ref: '#/components/schemas/ErrorResponseCore1818284114' - $ref: '#/components/schemas/ErrorResponseCore1277582131' - $ref: '#/components/schemas/ErrorResponseCore1593946428' - $ref: '#/components/schemas/ErrorResponseCore2114620743' - $ref: '#/components/schemas/ErrorResponseCore1332683101' - $ref: '#/components/schemas/ErrorResponseCore1090893661' - $ref: '#/components/schemas/ErrorResponseCore653152835' - $ref: '#/components/schemas/ErrorResponseCore899638570' - $ref: '#/components/schemas/ErrorResponseCore496791912' - $ref: '#/components/schemas/ErrorResponseCore201487910' - $ref: '#/components/schemas/ErrorResponseCore55175210' maxItems: 25 required: - data - $ref: '#/components/schemas/ErrorResponseCore1944579470' security: - iam-oauth2-schema: - ZohoCRM.modules.appointments.UPDATE tags: - Appointments S delete: summary: DELETE /Appointments__s/id description: appointment module record delete by id operationId: deleteId parameters: - $ref: '#/components/parameters/ParamPathAppointmentid' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/DeleteidResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - type: object additionalProperties: false description: Wrapped error response with data properties: data: type: array description: Array of error objects items: $ref: '#/components/schemas/ErrorResponseCore2137699283' maxItems: 25 required: - data - $ref: '#/components/schemas/ErrorResponseCore1875045219' - $ref: '#/components/schemas/ErrorResponseCore1604218709' security: - iam-oauth2-schema: - ZohoCRM.modules.appointments.DELETE tags: - Appointments S components: schemas: ErrorResponseCore1944579470: type: object additionalProperties: false description: the id given seems to be invalid properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: 'Detail field: resource_path_index' required: - resource_path_index message: type: string description: Error message enum: - the id given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore201487910: type: object additionalProperties: false description: Appointment cannot be scheduled for past dates properties: code: type: string description: Error code enum: - DEPENDENT_MISMATCH details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 required: - api_name - json_path api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - dependee - json_path message: type: string description: Error message enum: - Appointment cannot be scheduled for past dates status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core DataNested1: type: object additionalProperties: false description: Nested schema for data properties: code: type: string description: 'Field: code' maxLength: 255 details: $ref: '#/components/schemas/DetailsNested' message: type: string description: 'Field: message' maxLength: 255 status: type: string description: 'Field: status' maxLength: 255 PutappointmentssRequest: type: object additionalProperties: false description: Request body schema properties: data: type: array description: data array contains post request body (Required) items: $ref: '#/components/schemas/DataNested' maxItems: 4 required: - data ErrorResponseCore1604218709: type: object additionalProperties: false description: invalid module properties: code: type: string description: Error code enum: - INVALID_MODULE details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: 'Detail field: resource_path_index' required: - resource_path_index message: type: string description: Error message enum: - the module name given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore1544688711: type: object additionalProperties: false description: Auto-generated from 207 Multi-Status error item properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - the id given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GETOwnerNested: type: object additionalProperties: false description: Nested schema for Owner properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 email: type: string description: 'Field: email' maxLength: 255 required: - email - id - name ErrorResponseCore2137699283: type: object additionalProperties: false description: Auto-generated from 207 Multi-Status error item properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: id: type: string description: 'Detail field: id' maxLength: 255 required: - id message: type: string description: Error message enum: - record not deleted status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core PostappointmentssResponse200: type: object additionalProperties: false description: appointment creation success response properties: data: type: array description: 'Field: data' items: $ref: '#/components/schemas/DataNested1' maxItems: 4 ErrorResponseCore1875045219: type: object additionalProperties: false description: invalid method request properties: code: type: string description: Error code enum: - INVALID_REQUEST_METHOD details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - The http request method type is not a valid one status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core AppointmentForNested: type: object additionalProperties: false description: Contains the name, ID and the module's API name of the customer for whom you are creating the appointment. properties: name: type: - string - 'null' description: name maxLength: 2 id: type: - string - 'null' description: id maxLength: 18 module: $ref: '#/components/schemas/ModuleNested' description: module name ErrorResponseCore1277582131: type: object additionalProperties: false description: Appointment Owner is not a part of Service Members properties: code: type: string description: Error code enum: - DEPENDENT_MISMATCH details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 required: - api_name - json_path api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - dependee - json_path message: type: string description: Error message enum: - Appointment Owner is not a part of Service Members status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore1168955151: type: object additionalProperties: false description: Auto-generated from 207 Multi-Status error item properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - Mandatory field data not found status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ModifiedByNested: type: object additionalProperties: false description: modified by properties: name: type: - string - 'null' description: name maxLength: 255 id: type: - string - 'null' description: id maxLength: 255 email: type: - string - 'null' format: email description: email maxLength: 33 CreatedByNested: type: object additionalProperties: false description: appointment created by properties: name: type: - string - 'null' description: name maxLength: 255 id: type: - string - 'null' description: id maxLength: 255 email: type: - string - 'null' format: email description: email maxLength: 33 ErrorResponseCore1009543207: type: object additionalProperties: false description: 'Invalid data type for field: data' properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path - maximum_length message: type: string description: Error message enum: - invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore2114620743: type: object additionalProperties: false description: the given module name is not exist in multimodulelookup for Appointment_For.module.api_name properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - the given module name is not exist in multimodulelookup status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GETDataNested: type: object additionalProperties: false description: Nested schema for data properties: Owner: $ref: '#/components/schemas/GETOwnerNested' $currency_symbol: type: string description: 'Field: $currency_symbol' maxLength: 255 Address: type: - 'null' - string description: 'Field: Address' maxLength: 255 Appointment_Start_Time: type: string description: 'Field: Appointment_Start_Time' maxLength: 120 Cancellation_Reason: type: - 'null' - string description: 'Field: Cancellation_Reason' maxLength: 120 $field_states: type: - 'null' - string maxLength: 255 description: 'Field: $field_states' Appointment_For: $ref: '#/components/schemas/GETAppointmentForNested' Rescheduled_To: type: - 'null' - string description: 'Field: Rescheduled_To' maxLength: 120 $sharing_permission: type: string description: 'Field: $sharing_permission' maxLength: 255 Reschedule_Reason: type: - 'null' - string description: 'Field: Reschedule_Reason' maxLength: 120 Job_Sheet_Name__s: type: - 'null' - string maxLength: 255 description: 'Field: Job_Sheet_Name__s' Additional_Information: type: - 'null' - string description: 'Field: Additional_Information' maxLength: 32000 Last_Activity_Time: type: - 'null' - string description: 'Field: Last_Activity_Time' maxLength: 120 Job_Sheet_Created__s: type: boolean description: 'Field: Job_Sheet_Created__s' Cancelled_Time: type: - 'null' - string description: 'Field: Cancelled_Time' maxLength: 120 Cancellation_Note: type: - 'null' - string description: 'Field: Cancellation_Note' maxLength: 2000 Modified_By: $ref: '#/components/schemas/GETModifiedByNested' Reschedule_Count: type: integer format: int32 description: 'Field: Reschedule_Count' Rescheduled_By: type: - 'null' - object description: 'Field: Rescheduled_By' Date_1: type: - 'null' - string description: 'Field: Date_1' maxLength: 20 id: type: string description: 'Field: id' maxLength: 255 Rescheduled_Time: type: - 'null' - string description: 'Field: Rescheduled_Time' maxLength: 120 Remind_At: type: - array - 'null' items: description: reminder time object properties: period: type: string description: unit of time for reminder enum: - minutes - hours - days unit: type: integer format: int32 description: value for reminder time description: Contains the list of units and period of when you want to get the reminders for the appointment. maxItems: 100 Appointment_End_Time: type: string description: Appointment End time maxLength: 120 Status: type: string description: Appointment Status maxLength: 120 Modified_Time: type: string description: 'Field: Modified_Time' maxLength: 120 Service_Name: $ref: '#/components/schemas/GETServiceNameNested' Created_Time: type: string description: 'Field: Created_Time' maxLength: 120 Rescheduled_From: type: - 'null' - string description: 'Field: Rescheduled_From' maxLength: 120 Cancelled_By: type: - 'null' - object description: 'Field: Cancelled_By' $editable: type: boolean description: 'Field: $editable' Appointment_Name: type: string description: 'Field: Appointment_Name' maxLength: 255 Duration: type: integer format: int32 description: 'Field: Duration' Job_Sheet_Section__s: type: string description: 'Field: Job_Sheet_Section__s' maxLength: 120 Record_Status__s: type: string description: 'Field: Record_Status__s' maxLength: 255 $status: type: string description: 'Field: $status' maxLength: 120 Job_Sheet_Description__s: type: - 'null' - string description: 'Field: Job_Sheet_Description__s' maxLength: 32000 Created_By: $ref: '#/components/schemas/GETCreatedByNested' Tag: type: array items: type: string description: Tag name maxLength: 2000 maxItems: 10 description: 'Field: Tag' Location: type: string description: 'Field: Location' maxLength: 120 Reschedule_Note: type: - 'null' - string description: 'Field: Reschedule_Note' maxLength: 2000 required: - Additional_Information - Address - Appointment_End_Time - Appointment_For - Appointment_Name - Appointment_Start_Time - Cancellation_Note - Cancellation_Reason - Cancelled_By - Cancelled_Time - Created_By - Created_Time - Date_1 - Duration - Job_Sheet_Created__s - Job_Sheet_Description__s - Job_Sheet_Name__s - Job_Sheet_Section__s - Last_Activity_Time - Location - Modified_By - Modified_Time - Owner - Remind_At - Reschedule_Count - Reschedule_Note - Reschedule_Reason - Rescheduled_By - Rescheduled_From - Rescheduled_Time - Rescheduled_To - Service_Name - Status - Tag - id ErrorResponseCore653152835: type: object additionalProperties: false description: Appointment cannot be marked as completed before the appointment ends properties: code: type: string description: Error code enum: - DEPENDENT_MISMATCH details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 required: - api_name - json_path api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - dependee - json_path message: type: string description: Error message enum: - Appointment cannot be marked as completed before the appointment ends status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore1720623915: type: object additionalProperties: false description: '"appointment for " mandatory not found ' properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - required field not found status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GETAppointmentForNested: type: object additionalProperties: false description: Nested schema for Appointment_For properties: module: $ref: '#/components/schemas/GETModuleNested' name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - id - module - name ErrorResponseCore1593946428: type: object additionalProperties: false description: invalid data expected "jsonobject" for Appointment_For.module properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - expected_data_type - json_path message: type: string description: Error message enum: - invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core DeleteappointmentssResponse200: type: object additionalProperties: false description: appointment delete success response properties: data: type: array description: 'Field: data' items: $ref: '#/components/schemas/DataNested1' maxItems: 3 ErrorResponseCore261228299: type: object additionalProperties: false description: Rescheduled_From cannot be empty properties: code: type: string description: Error code enum: - DEPENDENT_FIELD_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 required: - api_name - json_path api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - dependee - json_path message: type: string description: Error message enum: - Rescheduled_From cannot be empty status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core OwnerNested: type: object additionalProperties: false description: Represents the ID of the service member who will provide the service for this appointment. properties: name: type: - string - 'null' description: service owner name maxLength: 100 id: type: - string - 'null' description: id maxLength: 100 email: type: - string - 'null' format: email description: email maxLength: 100 PutappointmentssResponse200: type: object additionalProperties: false description: appointment update success response properties: data: type: array description: 'Field: data' items: $ref: '#/components/schemas/DataNested1' maxItems: 2 ModuleNested: type: object additionalProperties: false description: module name properties: api_name: type: - string - 'null' description: api name maxLength: 8 id: type: - string - 'null' description: id maxLength: 18 DeleteidResponse200: type: object additionalProperties: false description: appointment delete success response properties: data: type: array description: 'Field: data' items: $ref: '#/components/schemas/DataNested1' maxItems: 1 ErrorResponseCore1332683101: type: object additionalProperties: false description: To Update the fields of Cancellation Information Section, value of Status should be Cancelled properties: code: type: string description: Error code enum: - DEPENDENT_FIELD_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 required: - api_name - json_path api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - dependee - json_path message: type: string description: Error message enum: - To Update the fields of Cancellation Information Section, value of Status should be Cancelled status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore899638570: type: object additionalProperties: false description: Job Sheet can be created only for completed appointment properties: code: type: string description: Error code enum: - DEPENDENT_MISMATCH details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 required: - api_name - json_path api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - dependee - json_path message: type: string description: Error message enum: - Job Sheet can be created only for completed appointment status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore1090893661: type: object additionalProperties: false description: Appointment cannot be marked as completed without creating the jobsheet properties: code: type: string description: Error code enum: - NOT_ALLOWED details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - Appointment cannot be marked as completed without creating the jobsheet status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GETModifiedByNested: type: object additionalProperties: false description: Nested schema for Modified_By properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 email: type: string description: 'Field: email' maxLength: 255 required: - email - id - name GETServiceNameNested: type: object additionalProperties: false description: Nested schema for Service_Name properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - id - name GetappointmentssResponse200: type: object additionalProperties: false description: appointment records get , success response properties: data: type: array description: 'Field: data' items: $ref: '#/components/schemas/GETDataNested' maxItems: 2 required: - data PostappointmentssRequest: type: object additionalProperties: false description: Request body schema properties: data: type: array description: data array contains post request body (Required) items: $ref: '#/components/schemas/DataNested' maxItems: 4 required: - data ErrorResponseCore622374562: type: object additionalProperties: false description: Reschedule_From and Appointment_Start_Time cannot be same properties: code: type: string description: Error code enum: - DEPENDENT_FIELD_UNCHANGED details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 required: - api_name - json_path api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - dependee - json_path message: type: string description: Error message enum: - Reschedule_From and Appointment_Start_Time cannot be same status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore55175210: type: object additionalProperties: false description: mandatory key missing unit. properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - mandatory key missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ServiceNameNested: type: object additionalProperties: false description: Contains the name and distinctive ID of the service for which you are creating the appointment. properties: name: type: - string - 'null' description: name of the service , on which the appointment is created using maxLength: 100 id: type: - string - 'null' description: unique id of the service maxLength: 100 DetailsNested: type: object additionalProperties: false description: Nested schema for details properties: Modified_Time: type: string description: 'Field: Modified_Time' maxLength: 120 Modified_By: $ref: '#/components/schemas/ModifiedByNested' Created_Time: type: string description: 'Field: Created_Time' maxLength: 120 id: type: string description: 'Field: id' maxLength: 255 Created_By: $ref: '#/components/schemas/CreatedByNested' Delete207SuccessResponse: type: object additionalProperties: false description: Success response schema for DELETE 207 multi-status properties: code: type: string description: Response code maxLength: 255 details: type: object additionalProperties: false description: Details containing only the deleted record ID properties: id: type: string description: Deleted record ID maxLength: 255 required: - id message: type: string description: Response message maxLength: 255 status: type: string description: Response status maxLength: 255 required: - code - details - message - status ErrorResponseCore1207168962: type: object additionalProperties: false description: Service is not available on the given time properties: code: type: string description: Error code enum: - NOT_ALLOWED details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - Service is not available on the given time status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GETModuleNested: type: object additionalProperties: false description: Nested schema for module properties: api_name: type: string description: 'Field: api_name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - api_name - id GETCreatedByNested: type: object additionalProperties: false description: Nested schema for Created_By properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 email: type: string description: 'Field: email' maxLength: 255 required: - email - id - name ErrorResponseCore496791912: type: object additionalProperties: false description: Appointment cannot be marked as overdue before the appointment ends properties: code: type: string description: Error code enum: - DEPENDENT_MISMATCH details: type: object additionalProperties: false description: Error details with validation information properties: dependee: type: object additionalProperties: false description: 'Detail field: dependee' properties: api_name: type: string description: 'Nested detail field: api_name' maxLength: 255 json_path: type: string description: 'Nested detail field: json_path' maxLength: 1000 required: - api_name - json_path api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - dependee - json_path message: type: string description: Error message enum: - Appointment cannot be marked as overdue before the appointment ends status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core DataNested: type: object additionalProperties: false description: data array contains post request body properties: Owner: $ref: '#/components/schemas/OwnerNested' description: Represents the ID of the service member who will provide the service for this appointment. (Required) Address: type: - 'null' - string description: address where the appointment held ,(this field is mandatory when location is to client address) maxLength: 255 $currency_symbol: type: - string - 'null' description: currency symbol maxLength: 1 Appointment_Start_Time: type: string format: date-time description: Appointment start time (Required) maxLength: 120 Cancellation_Reason: type: - 'null' - string description: appointment cancellation reason maxLength: 120 Appointment_For: $ref: '#/components/schemas/AppointmentForNested' description: Contains the name, ID and the module's API name of the customer for whom you are creating the appointment. (Required) $field_states: type: - 'null' - string maxLength: 255 description: field status Rescheduled_To: type: - 'null' - string description: appointment rescheduled time maxLength: 120 $sharing_permission: type: - string - 'null' description: record sharing permission maxLength: 11 Reschedule_Reason: type: - 'null' - string description: rescheduled reason maxLength: 120 Job_Sheet_Name__s: type: - string - 'null' description: Job sheet name maxLength: 120 Additional_Information: type: - 'null' - string description: Additional informations maxLength: 32000 Last_Activity_Time: type: - 'null' - string description: last Activity time maxLength: 120 Job_Sheet_Created__s: type: - boolean - 'null' description: whether job sheet created for an appointment Cancelled_Time: type: - 'null' - string description: appointment cancelled time maxLength: 120 Cancellation_Note: type: - 'null' - string description: cancellation note maxLength: 2000 Modified_By: $ref: '#/components/schemas/ModifiedByNested' description: modified by Reschedule_Count: type: - integer - 'null' format: int32 description: the no of time the appointment has been rescheduled $state: type: - string - 'null' description: state maxLength: 4 Rescheduled_By: type: - 'null' - object properties: name: type: - string - 'null' description: name maxLength: 255 id: type: - string - 'null' description: id maxLength: 255 email: type: - string - 'null' format: email description: email maxLength: 33 description: rescheduled by Date_1: type: - 'null' - string description: date maxLength: 20 id: type: - string - 'null' description: appointment record id maxLength: 18 readOnly: true Rescheduled_Time: type: - 'null' - string description: rescheduled time maxLength: 120 Remind_At: type: - array - 'null' items: type: object description: reminder time object additionalProperties: false properties: period: type: string description: unit of time for reminder enum: - minutes - hours - days unit: type: integer format: int32 description: value for reminder time description: Contains the list of units and period of when you want to get the reminders for the appointment. maxItems: 100 Appointment_End_Time: type: - string - 'null' format: date-time description: Appointment end time maxLength: 120 Status: type: - string - 'null' description: Denotes the status of the appointment. maxLength: 120 Modified_Time: type: - string - 'null' format: date-time description: modified time maxLength: 120 Service_Name: $ref: '#/components/schemas/ServiceNameNested' description: Contains the name and distinctive ID of the service for which you are creating the appointment. (Required) Created_Time: type: - string - 'null' format: date-time description: created Time maxLength: 120 Rescheduled_From: type: - 'null' - string description: Appointment Rescheduled from (this field is mandatory when you want to create an rescheduled appointment) maxLength: 120 Cancelled_By: type: - 'null' - object description: cancelled by Duration: type: - integer - 'null' format: int32 description: Appointment duration Appointment_Name: type: - string - 'null' description: Appointment name maxLength: 225 $editable: type: - boolean - 'null' description: 'editable ' Job_Sheet_Section__s: type: - string - 'null' description: contains which job sheet section to be shown to the user maxLength: 120 Record_Status__s: type: - string - 'null' description: record status maxLength: 9 $status: type: - string - 'null' description: status maxLength: 7 Job_Sheet_Description__s: type: - string - 'null' description: job sheet description maxLength: 32000 Tag: type: - array - 'null' description: tags associated with this appointment items: description: tag object type: string maxLength: 2000 Created_By: $ref: '#/components/schemas/CreatedByNested' description: appointment created by Location: type: - string - 'null' description: Location where the appointment held enum: - Client Address - Business Address maxLength: 120 Reschedule_Note: type: - 'null' - string description: rescheduled note maxLength: 2000 required: - Appointment_For - Appointment_Start_Time - Owner - Service_Name Post207multistatusResponse207: type: object additionalProperties: false description: Generated schema for dataSuccess properties: details: $ref: '#/components/schemas/DetailsNested' code: type: string description: 'Field: code' maxLength: 255 message: type: string description: 'Field: message' maxLength: 255 status: type: string description: 'Field: status' maxLength: 255 ErrorResponseCore1818284114: type: object additionalProperties: false description: Appointment time does not falls under business hours properties: code: type: string description: Error code enum: - NOT_ALLOWED details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - Appointment time does not falls under business hours status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core parameters: ParamQueryId: name: id in: query description: holds the appointment id , which is going to be deleted required: false schema: type: number enum: - 111115000000147180 ParamPathAppointmentid: name: appointmentId in: path description: 'Path parameter: appointmentId' required: true schema: type: string maxLength: 100 ParamQueryIds: name: ids in: query description: contains appointment record ids , which are going to be deleted required: false schema: type: number enum: - 111115000000147280 - 111115000000147230 securitySchemes: iam-oauth2-schema: $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema x-entity: Helpcenter