openapi: 3.1.0 info: title: Helpcenter Services S API version: 1.0.0 tags: - name: Services S paths: /Services__s: get: summary: GET /services_s description: services records get operationId: getServicesS responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/GetservicessResponse200' '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/ErrorResponseCore1872678286' security: - iam-oauth2-schema: - ZohoCRM.modules.services.READ tags: - Services S put: summary: PUT /services_s description: update services api operationId: putServicesS parameters: - $ref: '#/components/parameters/ParamQueryAffectedData' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PutservicessRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PutservicessResponse200' '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/DataError' description: error response in data minContains: 1 description: Array of success or failure data items items: oneOf: - $ref: '#/components/schemas/Post207multistatusResponse207' - $ref: '#/components/schemas/DataError' maxItems: 200 minItems: 2 required: - data '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - $ref: '#/components/schemas/DataError' - $ref: '#/components/schemas/ErrorResponseCore564845355' - $ref: '#/components/schemas/ErrorResponseCore1569170772' - $ref: '#/components/schemas/ErrorResponseCore197782636' - $ref: '#/components/schemas/ErrorResponseCore1225158361' - $ref: '#/components/schemas/ErrorResponseCore695778820' - $ref: '#/components/schemas/ErrorResponseCore775669499' - $ref: '#/components/schemas/ErrorResponseCore1835963120' - $ref: '#/components/schemas/ErrorResponseCore1173663876' - $ref: '#/components/schemas/ErrorResponseCore542688165' - $ref: '#/components/schemas/ErrorResponseCore1924753111' - $ref: '#/components/schemas/ErrorResponseCore531684933' - $ref: '#/components/schemas/ErrorResponseCore1335501272' - $ref: '#/components/schemas/ErrorResponseCore964180820' - $ref: '#/components/schemas/ErrorResponseCore1604071034' - $ref: '#/components/schemas/ErrorResponseCore1484615382' - type: object additionalProperties: false description: Wrapped error response with data properties: data: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore591812267' - $ref: '#/components/schemas/ErrorResponseCore578559762' - $ref: '#/components/schemas/DataError' maxItems: 25 required: - data security: - iam-oauth2-schema: - ZohoCRM.modules.services.UPDATE tags: - Services S post: summary: POST /services_s description: create services api operationId: postServicesS requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PostservicessRequest' responses: '201': description: Created - Resource created successfully content: application/json: schema: $ref: '#/components/schemas/PostservicessResponse201' '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: - $ref: '#/components/schemas/ErrorResponseCore48783029' - $ref: '#/components/schemas/ErrorResponseCore564845355' - $ref: '#/components/schemas/ErrorResponseCore1569170772' - $ref: '#/components/schemas/ErrorResponseCore197782636' - $ref: '#/components/schemas/ErrorResponseCore815194988' - $ref: '#/components/schemas/ErrorResponseCore1915970813' - $ref: '#/components/schemas/ErrorResponseCore1225158361' - $ref: '#/components/schemas/ErrorResponseCore661033389' - $ref: '#/components/schemas/ErrorResponseCore695778820' - $ref: '#/components/schemas/ErrorResponseCore1805991557' - $ref: '#/components/schemas/ErrorResponseCore541683400' - $ref: '#/components/schemas/ErrorResponseCore775669499' - $ref: '#/components/schemas/ErrorResponseCore1835963120' - $ref: '#/components/schemas/ErrorResponseCore1173663876' - $ref: '#/components/schemas/ErrorResponseCore542688165' - $ref: '#/components/schemas/ErrorResponseCore1924753111' - $ref: '#/components/schemas/ErrorResponseCore531684933' - $ref: '#/components/schemas/ErrorResponseCore1335501272' - $ref: '#/components/schemas/ErrorResponseCore964180820' - $ref: '#/components/schemas/ErrorResponseCore2060249394' - $ref: '#/components/schemas/ErrorResponseCore1604071034' - $ref: '#/components/schemas/ErrorResponseCore1484615382' - $ref: '#/components/schemas/ErrorResponseCore416413920' - type: object additionalProperties: false description: Wrapped error response with data properties: data: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore591812267' - $ref: '#/components/schemas/ErrorResponseCore578559762' - $ref: '#/components/schemas/ErrorResponseCore1759680246' maxItems: 25 required: - data security: - iam-oauth2-schema: - ZohoCRM.modules.services.CREATE tags: - Services S delete: summary: DELETE /services_s description: services records delete operationId: deleteServicesS parameters: - $ref: '#/components/parameters/ParamQueryIds' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/DeleteservicessResponse200' '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/ErrorResponseCore297287888' description: error response in data minContains: 1 description: Array of success or failure data items items: oneOf: - $ref: '#/components/schemas/Post207multistatusResponse207' - $ref: '#/components/schemas/ErrorResponseCore297287888' maxItems: 200 minItems: 2 required: - data '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore1202290576' - $ref: '#/components/schemas/ErrorResponseCore1604218709' - $ref: '#/components/schemas/ErrorResponseCore980155013' - $ref: '#/components/schemas/DataError' security: - iam-oauth2-schema: - ZohoCRM.modules.services.DELETE tags: - Services S /Services__s/{id}: get: summary: GET /services_s/{id} description: services record get by id operationId: getServiceById parameters: - $ref: '#/components/parameters/ParamPathId' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/GetservicessResponse200' '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/ErrorResponseCore1872678286' security: - iam-oauth2-schema: - ZohoCRM.modules.services.READ tags: - Services S put: summary: PUT /services_s/{id} description: update services api operationId: putServiceById parameters: - $ref: '#/components/parameters/ParamQueryAffectedData' - $ref: '#/components/parameters/ParamPathId' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PutservicessRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PutservicessResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - $ref: '#/components/schemas/DataError' - $ref: '#/components/schemas/ErrorResponseCore564845355' - $ref: '#/components/schemas/ErrorResponseCore1569170772' - $ref: '#/components/schemas/ErrorResponseCore197782636' - $ref: '#/components/schemas/ErrorResponseCore1225158361' - $ref: '#/components/schemas/ErrorResponseCore695778820' - $ref: '#/components/schemas/ErrorResponseCore775669499' - $ref: '#/components/schemas/ErrorResponseCore1835963120' - $ref: '#/components/schemas/ErrorResponseCore1173663876' - $ref: '#/components/schemas/ErrorResponseCore542688165' - $ref: '#/components/schemas/ErrorResponseCore1924753111' - $ref: '#/components/schemas/ErrorResponseCore531684933' - $ref: '#/components/schemas/ErrorResponseCore1335501272' - $ref: '#/components/schemas/ErrorResponseCore964180820' - $ref: '#/components/schemas/ErrorResponseCore1604071034' - $ref: '#/components/schemas/ErrorResponseCore1484615382' - type: object additionalProperties: false description: Wrapped error response with data properties: data: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore591812267' - $ref: '#/components/schemas/ErrorResponseCore578559762' maxItems: 25 required: - data security: - iam-oauth2-schema: - ZohoCRM.modules.services.UPDATE tags: - Services S delete: summary: DELETE /services_s/{id} description: services record delete by id operationId: deleteServiceById parameters: - $ref: '#/components/parameters/ParamPathServiceId' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/DeleteservicessResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore1202290576' - $ref: '#/components/schemas/ErrorResponseCore1604218709' - $ref: '#/components/schemas/ErrorResponseCore980155013' - $ref: '#/components/schemas/DataError' security: - iam-oauth2-schema: - ZohoCRM.modules.services.DELETE tags: - Services S components: schemas: DataError: type: object description: Generated schema for dataError additionalProperties: true properties: code: description: error code maxLength: 255 type: string details: type: object additionalProperties: false description: error details with validation information properties: api_name: description: name of the invalid field type: string maxLength: 255 json_path: description: json path of the invalid field type: string maxLength: 1000 required: [] message: type: string description: error message maxLength: 1000 status: description: status type: string maxLength: 1000 required: - code - details - message - status ErrorResponseCore542688165: type: object additionalProperties: false description: More than 100 users cannot be associated properties: code: type: string description: Error code enum: - LIMIT_EXCEEDED details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 limit: type: integer format: int32 description: 'Detail field: limit' json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path - limit message: type: string description: Error message enum: - More than 100 users cannot be associated 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 GETHasMoreNested: type: object additionalProperties: false description: Nested schema for $has_more properties: Members: type: boolean description: 'Field: Members' required: - Members MembersNested: type: object additionalProperties: false description: contains member details properties: name: type: - string - 'null' description: name of the member maxLength: 8 Members: $ref: '#/components/schemas/MembersNested' description: contains member details id: type: - string - 'null' description: id of the member maxLength: 18 MembersBase: type: object additionalProperties: true description: Base schema for Members properties: module: type: - string - 'null' description: member module maxLength: 100 name: type: - string - 'null' description: name of the owner enum: - Madeshwaran G maxLength: 100 id: type: - string - 'null' description: id of the owner enum: - '4671651000000635001' maxLength: 100 ErrorResponseCore1604218709: type: object additionalProperties: false description: the module name given seems to be invalid 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 ErrorResponseCore1335501272: type: object additionalProperties: false description: To value must be Greater than From value 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: - To value must be Greater than From value 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 ErrorResponseCore1202290576: type: object additionalProperties: false description: record not deleted 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: - record not deleted status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core LayoutNested: type: object additionalProperties: false description: Layout id properties: id: type: - string - 'null' description: id maxLength: 18 ErrorResponseCore1225158361: type: object additionalProperties: false description: Duration does not satisfy the service timing 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: - Duration does not satisfy the service timing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore1835963120: type: object additionalProperties: false description: Unavailable Till must be greater than Unavailable From 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: - Unavailable Till must be greater than Unavailable From status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore1805991557: type: object additionalProperties: false description: Unavailable from must not be greater than current Time 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: - Unavailable from must not be greater than current Time status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core MembersitemBase: type: object additionalProperties: true description: Base schema for MembersItem properties: id: type: - string - 'null' description: id of the owner maxLength: 100 Members: $ref: '#/components/schemas/MembersBase' GETMembersNested: type: object additionalProperties: false description: Nested schema for Members properties: module: type: string description: 'Field: module' maxLength: 255 name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 required: - id - module - name ModifiedByNested: 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 ErrorResponseCore1168955151: type: object additionalProperties: true description: Auto-generated from 207 Multi-Status error item properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: true 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 maxLength: 100 status: type: string description: Error status maxLength: 100 required: - code - details - message - status title: Error Response Core CreatedByNested: 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 GetservicessResponse200: type: object additionalProperties: true description: services records get , success response properties: data: type: array description: 'Field: data' items: $ref: '#/components/schemas/GETDataNested' maxItems: 1 required: - data ErrorResponseCore591812267: type: object additionalProperties: false description: Auto-generated from ApiDefinition for INVALID_DATA 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 type status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore2060249394: type: object additionalProperties: false description: The given custom time is invalid 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 custom time is invalid' status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core AvailableTimingsNested: type: object additionalProperties: false description: contains the service availability timing properties: From: type: - string - 'null' description: service starts from time maxLength: 5 To: type: - string - 'null' description: 'service end time ' maxLength: 5 ErrorResponseCore564845355: type: object additionalProperties: false description: The given Available Days are not there in business days 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: - The given Available Days are not there in business days status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore815194988: type: object additionalProperties: false description: Duration value should not be greater than 24hrs or less than 5mins 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: - Duration value should not be greater than 24hrs or less than 5mins status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore964180820: type: object additionalProperties: false description: Available Dates value in holiday or Not in BusinessDays 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: - Available Dates value in holiday or Not in BusinessDays status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore197782636: type: object additionalProperties: false description: invalid data 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 GETDataNested: type: object additionalProperties: true description: Nested schema for data properties: Job_Sheet_Required: type: string description: 'Field: Job_Sheet_Required' maxLength: 255 Owner: $ref: '#/components/schemas/GETOwnerNested' Description: type: - string - 'null' description: 'Field: Description' maxLength: 32000 $currency_symbol: type: string description: 'Field: $currency_symbol' maxLength: 255 $field_states: type: 'null' description: 'Field: $field_states' $photo_id: type: 'null' description: 'Field: $photo_id' Available_Days: type: array items: {} maxItems: 100 description: 'Field: Available_Days' Tax: type: array items: {} maxItems: 100 description: 'Field: Tax' $sharing_permission: type: string description: 'Field: $sharing_permission' maxLength: 255 Unavailable_From: type: - string - 'null' maxLength: 255 description: 'Field: Unavailable_From' Last_Activity_Time: type: string description: 'Field: Last_Activity_Time' maxLength: 255 Record_Image: type: 'null' description: 'Field: Record_Image' Modified_By: $ref: '#/components/schemas/GETModifiedByNested' id: type: string description: 'Field: id' maxLength: 255 Available_Dates: type: array items: {} maxItems: 100 description: 'Field: Available_Dates' Status: type: string description: 'Field: Status' maxLength: 255 Modified_Time: type: string description: 'Field: Modified_Time' maxLength: 255 Available_Timings: type: - array - 'null' description: 'Field: Available_Timings' items: $ref: '#/components/schemas/GETAvailableTimingsNested' maxItems: 1 Service_Name: type: string description: 'Field: Service_Name' maxLength: 120 Available_From: type: string description: 'Field: Available_From' maxLength: 255 $data_source_details: $ref: '#/components/schemas/GETDataSourceDetailsNested' Created_Time: type: string description: 'Field: Created_Time' maxLength: 255 Available_Till: type: - string - 'null' description: 'Field: Available_Till' maxLength: 255 $editable: type: boolean description: 'Field: $editable' Duration: type: integer format: int32 description: 'Field: Duration' Job_Sheet_Section__s: type: 'null' description: 'Field: Job_Sheet_Section__s' Record_Status__s: type: string description: 'Field: Record_Status__s' maxLength: 255 Price: type: integer format: int32 description: 'Field: Price' $status: type: string description: 'Field: $status' maxLength: 255 Created_By: $ref: '#/components/schemas/GETCreatedByNested' Tag: type: - array - 'null' description: tags associated with this record items: type: string description: tag names maxLength: 2000 maxItems: 100 Availability_Type: type: string description: 'Field: Availability_Type' maxLength: 255 Members: type: array description: 'Field: Members' items: $ref: '#/components/schemas/GETMembersNested1' maxItems: 2 Location: type: string description: 'Field: Location' maxLength: 255 Unavailable_Till: type: 'null' description: 'Field: Unavailable_Till' $has_more: $ref: '#/components/schemas/GETHasMoreNested' required: - $editable - $field_states - $has_more - $photo_id - $sharing_permission - $status - Availability_Type - Available_Dates - Available_Days - Available_From - Available_Till - Available_Timings - Created_By - Created_Time - Description - Duration - Job_Sheet_Required - Job_Sheet_Section__s - Last_Activity_Time - Location - Members - Modified_By - Modified_Time - Owner - Price - Record_Image - Service_Name - Status - Tag - Tax - Unavailable_From - Unavailable_Till - id OwnerNestedV2: allOf: - $ref: '#/components/schemas/OwnerBase' - type: object additionalProperties: true description: Required fields for Owner in PUT required: - email description: Operation-specific schema for Owner in PUT ErrorResponseCore1569170772: type: object additionalProperties: false description: Service available time does not satisfy the business timing 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: - Service available time does not satisfy the business timing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GETAvailableTimingsNested: type: object additionalProperties: false description: Nested schema for Available_Timings properties: From: type: string description: 'Field: From' maxLength: 255 To: type: string description: 'Field: To' maxLength: 255 required: - From - To OwnerNested: type: object additionalProperties: false description: owner of the service properties: full_name: type: - string - 'null' description: full name of the owner maxLength: 8 name: type: - string - 'null' description: name of the owner maxLength: 8 id: type: - string - 'null' description: id of the owner maxLength: 18 ErrorResponseCore297287888: type: object additionalProperties: true description: Auto-generated from 207 Multi-Status error item properties: code: type: string description: Error code enum: - INVALID_DATA maxLength: 255 details: type: object additionalProperties: true description: Error details with validation information properties: id: type: string description: 'Detail field: id' maxLength: 255 required: [] message: type: string description: Error message maxLength: 100 status: type: string description: Error status maxLength: 100 required: - code - details - message - status title: Error Response Core ErrorResponseCore1173663876: type: object additionalProperties: false description: When the service status is available, either both unavailable till and unavailable from can be null or both unavailable from and unavailable till can have value 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: - When the service status is available, either both unavailable till and unavailable from can be null or both unavailable from and unavailable till can have value status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core GETDataSourceDetailsNested: type: object additionalProperties: false description: Nested schema for $data_source_details GETMembersNested1: type: object additionalProperties: false description: Nested schema for Members properties: id: type: string description: 'Field: id' maxLength: 255 Members: $ref: '#/components/schemas/GETMembersNested' required: - Members - id ErrorResponseCore1915970813: type: object additionalProperties: false description: Job Sheet is not configured in services preferences 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: - Job Sheet is not configured in services preferences 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 ErrorResponseCore1604071034: type: object additionalProperties: false description: Members is not Confirmed properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: user_status: type: string description: 'Detail field: user_status' 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 - json_path - user_status message: type: string description: Error message enum: - Members is not Confirmed status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core DeleteservicessResponse200: type: object additionalProperties: false description: services records delete , success response properties: data: type: array description: 'Field: data' items: $ref: '#/components/schemas/DataNested1' maxItems: 1 ErrorResponseCore541683400: type: object additionalProperties: false description: Unavailable From time does not fall within service availability 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: - Unavailable From time does not fall within service availability status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core OwnerBase: type: object additionalProperties: true description: Base schema for Owner properties: name: type: - string - 'null' description: name of the owner enum: - Madeshwaran G maxLength: 100 id: type: - string - 'null' description: id of the owner enum: - '4671651000000635001' maxLength: 100 email: type: - string - 'null' description: email enum: - madeshwaran.g@zohocorp.com maxLength: 100 ErrorResponseCore1484615382: type: object additionalProperties: false description: Members is not Active properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: user_status: type: string description: 'Detail field: user_status' 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 - json_path - user_status message: type: string description: Error message enum: - Members is not Active status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore48783029: type: object additionalProperties: false description: The given Availability Type is not in picklist 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 Availability Type is not in picklist status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core PostservicessResponse201: type: object additionalProperties: false description: services post response properties: data: type: array description: 'Field: data' items: $ref: '#/components/schemas/DataNested1' maxItems: 2 ErrorResponseCore578559762: type: object additionalProperties: false description: Auto-generated from ApiDefinition for INVALID_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 PostservicessRequest: type: object additionalProperties: false description: Request body schema properties: data: type: array description: data array (Required) items: $ref: '#/components/schemas/DataNested' maxItems: 5 skip_mandatory: type: - boolean - 'null' description: boolean required: - data ErrorResponseCore531684933: type: object additionalProperties: false description: Job_Sheet_Section__s can have value only when value of Job_Sheet_Required is Yes 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_Section__s can have value only when value of Job_Sheet_Required is Yes status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore695778820: type: object additionalProperties: false description: Dependent Field missing 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: - Dependent Field missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore1759680246: type: object additionalProperties: false description: Auto-generated from ApiDefinition 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 is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core DetailsNested: type: object additionalProperties: true description: Nested schema for details properties: Modified_Time: type: string description: 'Field: Modified_Time' maxLength: 255 Modified_By: $ref: '#/components/schemas/ModifiedByNested' Created_Time: type: string description: 'Field: Created_Time' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 Created_By: $ref: '#/components/schemas/CreatedByNested' ErrorResponseCore775669499: type: object additionalProperties: false description: When the service status is available, unavailable till must be lesser than current Time 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: - When the service status is available, unavailable till must be lesser than current Time status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore416413920: type: object additionalProperties: false description: As service availability is not valid, status cannot be changed 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: - As service availability is not valid, status cannot be changed status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core PutservicessResponse200: type: object additionalProperties: false description: services put success response properties: data: type: array description: 'Field: data' items: $ref: '#/components/schemas/DataNested1' maxItems: 2 TaxNested: type: object additionalProperties: false description: Contains the ID and value of the tax applied to the service cost properties: id: type: 'null' description: id value: type: - string - 'null' description: value to be applied maxLength: 100 ErrorResponseCore1872678286: type: object additionalProperties: false description: One of the expected parameter is missing properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 required: - param_name message: type: string description: Error message enum: - One of the expected parameter is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core DataNestedBase: type: object additionalProperties: true description: Base schema for array items properties: Job_Sheet_Required: type: - string - 'null' description: is job sheet required for the service enum: - 'No' maxLength: 3 Status: type: - string - 'null' description: Record Status enum: - Not in Use maxLength: 100 Owner: $ref: '#/components/schemas/OwnerBase' Description: type: - string - 'null' description: Represents the description of the service maxLength: 32000 Available_Timings: type: - string - 'null' description: contains the service availability timing maxLength: 4 Service_Name: type: - string - 'null' description: name of the service maxLength: 120 Available_From: type: - string - 'null' description: service availability start time (this field is mandatory when service availability type is specific date range) maxLength: 100 Available_Till: type: - string - 'null' description: service availability end time (this field is mandatory when service availability type is specific date range) enum: - '2026-01-13' - '2026-01-29' maxLength: 100 Available_Days: type: - array - 'null' description: contains days (this field is mandatory when availability type is set to specific days) items: type: string description: Array Fields maxLength: 255 maxItems: 4 Tax: type: - array - 'null' description: Contains the ID and value of the tax applied to the service cost items: description: Tax details type: string maxLength: 255 maxItems: 2 Duration: type: - integer - 'null' format: int32 description: duration of the service Job_Sheet_Section__s: type: - string - 'null' description: contains job sheet section information maxLength: 255 Unavailable_From: type: - string - 'null' description: service unavailable from maxLength: 25 Record_Image: type: - string - 'null' description: record image maxLength: 255 Price: type: - integer - 'null' format: int32 description: price of the service id: type: - string - 'null' description: id of the owner maxLength: 100 Tag: type: - array - 'null' description: tags associated with this record items: type: string description: tag names maxLength: 2000 maxItems: 100 Availability_Type: type: - string - 'null' description: 'service availability type i.e specific date range or specific days ' enum: - Specific Day(s) - Specific Date Range - Every Business Days - Specific Date(s) maxLength: 19 Available_Dates: type: - array - 'null' description: contains available date (this field is mandatory when availability type is specific dates ) items: type: string description: service available days maxLength: 255 maxItems: 3 Members: type: - array - 'null' description: members who does this service (contains multiple members) items: $ref: '#/components/schemas/MembersitemBase' maxItems: 5 Location: type: - string - 'null' description: Location where the service held enum: - Business Address maxLength: 1000 Unavailable_Till: type: - string - 'null' description: 'service unavailable till ' maxLength: 255 ErrorResponseCore980155013: type: object additionalProperties: false description: One of the expected parameter is missing properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: param: type: string description: 'Detail field: param' maxLength: 255 required: - param message: type: string description: Error message enum: - One of the expected parameter is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core 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 ErrorResponseCore1924753111: type: object additionalProperties: false description: You cannot create more than 500 active services properties: code: type: string description: Error code enum: - LIMIT_EXCEEDED details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: 'Detail field: api_name' maxLength: 255 limit: type: integer format: int32 description: 'Detail field: limit' json_path: type: string description: 'Detail field: json_path' maxLength: 1000 required: - api_name - json_path - limit message: type: string description: Error message enum: - You cannot create more than 500 active services 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 ' properties: Job_Sheet_Required: type: - string - 'null' description: is job sheet required for the service maxLength: 3 Owner: $ref: '#/components/schemas/OwnerNested' description: owner of the service Available_Timings: type: - array - 'null' description: contains the service availability timing items: $ref: '#/components/schemas/AvailableTimingsNested' maxItems: 4 Description: type: - string - 'null' description: Represents the description of the service maxLength: 32000 Available_From: type: - string - 'null' format: date description: service availability start time (this field is mandatory when service availability type is specific date range) maxLength: 100 Service_Name: type: string description: name of the service (Required) maxLength: 120 Available_Till: type: - string - 'null' format: date description: service availability end time (this field is mandatory when service availability type is specific date range) maxLength: 100 Available_Days: type: - array - 'null' description: contains days (this field is mandatory when availability type is set to specific days) items: type: string maxLength: 225 description: service available days maxItems: 7 Duration: type: integer format: int32 description: duration of the service (Required) Tax: type: - array - 'null' description: Contains the ID and value of the tax applied to the service cost items: $ref: '#/components/schemas/TaxNested' maxItems: 2 Price: type: integer format: int32 description: price of the service (Required) Layout: $ref: '#/components/schemas/LayoutNested' description: Layout id zia_suggested_users: type: - object - 'null' additionalProperties: false description: zia Availability_Type: type: string description: service availability type i.e specific date range or specific days (Required) maxLength: 100 $zia_owner_assignment: type: - string - 'null' description: zia maxLength: 32 Members: type: array description: members who does this service (contains multiple members) (Required) items: $ref: '#/components/schemas/MembersNested' maxItems: 5 Available_Dates: type: - array - 'null' description: contains available date (this field is mandatory when availability type is specific dates ) items: description: service available dates type: string maxLength: 255 maxItems: 3 Location: type: string description: Location where the service held (Required) maxLength: 100 required: - Availability_Type - Duration - Location - Members - Price - Service_Name DataNestedV2: allOf: - $ref: '#/components/schemas/DataNestedBase' - type: object additionalProperties: true description: Nested object overrides properties: Owner: $ref: '#/components/schemas/OwnerNestedV2' description: Operation-specific schema for PUT unevaluatedProperties: false 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 PutservicessRequest: type: object additionalProperties: false description: Request body schema properties: data: type: array description: a (Required) items: $ref: '#/components/schemas/DataNestedV2' maxItems: 100 required: - data ErrorResponseCore661033389: type: object additionalProperties: false description: required field 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 parameters: ParamPathId: name: id in: path description: 'Path parameter: id' required: true schema: type: string maxLength: 100 ParamPathServiceId: name: id in: path description: 'Path parameter: id' required: true schema: type: string maxLength: 100 ParamQueryIds: name: ids in: query description: contains service records id required: false schema: type: number minimum: 1 maximum: 100000000000000000 ParamQueryAffectedData: name: affected_data in: query description: adds the affected data in response required: false schema: type: boolean enum: - true securitySchemes: iam-oauth2-schema: $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema x-entity: Helpcenter