ServiceChannel AIAgents API

openapi: 3.2.0
info:
  version: bearer.v1
  title: Fixxbook.Bearer.Api.V1 AfterHours AI Agents API
  isOdataApi: false
  relativePath: ''
  discoveryPath: docs/bearer.v1
  _isAuthorizedAccess: true
servers:
- url: https://sb2fixxbook.servicechannel.com:443/api
security:
- oauth2: []
tags:
- name: AIAgents
paths:
  /aiagents/locations/{locationId}/InitConversation:
    get:
      tags:
      - AIAgents
      summary: "Initializes a new conversation with the necessary setup by creating\n            and configuring the required resources for interaction."
      operationId: GETv3_aiagents_locations_{locationId}_InitConversation?setupId={setupId}
      parameters:
      - name: locationId
        in: path
        description: The unique identifier of the location.
        required: true
        schema:
          type: integer
          format: int32
      - name: setupId
        in: query
        description: The identifier of the dashboard setup.
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Request succeeded and the requested information is in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.AzureOpenAI.Assistant.ChatSessionModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.AzureOpenAI.Assistant.ChatSessionModel'
        '400':
          description: "Access denied.\n            <br>Error codes:\n            1000 - The setupId does not belong to the Subscriber;"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\n            <br>Error codes:\n            504 - API call rejected by security permissions;"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '403':
          description: "You are not authorized to request this resource, or the resource is unavailable for some reason.\n            <br/>Error codes: \n            100 — User has no rights to perform this action."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\n            <br/>Error codes:\n            501 - Unspecified internal server error occurred"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /aiagents/SendMessage:
    post:
      tags:
      - AIAgents
      summary: "Sends a message to the specified thread.\n            This method ensures that the message is delivered\n            according to the provided parameters, including thread and message data."
      operationId: POSTv3_aiagents_SendMessage?threadId={threadId}&message={message}
      parameters:
      - name: threadId
        in: query
        description: The unique identifier of the conversation.
        required: true
        schema:
          type: string
      - name: message
        in: query
        description: The content of the message to be sent.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Indicates that the message has been sent.
        '400':
          description: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\n            <br>Error codes:\n            504 - API call rejected by security permissions;"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\n            <br/>Error codes:\n            501 - Unspecified internal server error occurred"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /aiagents/SendImage:
    post:
      tags:
      - AIAgents
      summary: "Sends an image to the specified thread.\n            This method ensures that the image content is delivered\n            according to the provided parameters, including thread and image data."
      operationId: POSTv3_aiagents_SendImage?threadId={threadId}&setupId={setupId}
      parameters:
      - name: threadId
        in: query
        description: The unique identifier of the conversation.
        required: true
        schema:
          type: string
      - name: setupId
        in: query
        description: The identifier of the dashboard setup.
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Indicates that the image data has been sent.
        '401':
          description: "Indicates that the requested resource requires authentication.\n            <br>Error codes:\n            504 - API call rejected by security permissions;"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\n            <br/>Error codes:\n            501 - Unspecified internal server error occurred"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: Photo to attach the conversation
                  format: binary
              required:
              - file
  /aiagents/locations/{locationId}/ProcessMessageStream:
    get:
      tags:
      - AIAgents
      summary: "Retrieves a stream of messages for a specific thread.\n            This method establishes and manages a stream to receive continuous messages."
      operationId: GETv3_aiagents_locations_{locationId}_ProcessMessageStream?setupId={setupId}&threadId={threadId}&assistantId={assistantId}&enableMetrics={enableMetrics}
      parameters:
      - name: locationId
        in: path
        description: The unique identifier of the location.
        required: true
        schema:
          type: integer
          format: int32
      - name: setupId
        in: query
        description: The identifier of the dashboard setup.
        required: true
        schema:
          type: integer
          format: int32
      - name: threadId
        in: query
        description: The unique identifier of the conversation.
        required: true
        schema:
          type: string
      - name: assistantId
        in: query
        description: The unique identifier of the AI agent.
        required: true
        schema:
          type: string
      - name: enableMetrics
        in: query
        description: Indicates whether metrics should be enabled. Defaults to false if not specified.
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Message stream successfully received.
        '401':
          description: "Indicates that the requested resource requires authentication.\n            <br>Error codes:\n            504 - API call rejected by security permissions;"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /aiagents/DeleteConversation:
    delete:
      tags:
      - AIAgents
      summary: "Deletes a specific conversation from the system.\n            This method removes the conversation and all its associated data permanently."
      operationId: DELETEv3_aiagents_DeleteConversation?threadId={threadId}
      parameters:
      - name: threadId
        in: query
        description: The unique identifier of the thread to be deleted.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Indicates that the conversation has been deleted.
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\n            <br/>Error codes:\n            <br/> 503 - Request is invalid"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\n            <br>Error codes:\n            504 - API call rejected by security permissions;"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /aiagents/CreateConversation:
    post:
      tags:
      - AIAgents
      summary: Creates a new conversation instance
      operationId: POSTv3_aiagents_CreateConversation
      responses:
        '201':
          description: Indicates that the conversation has been created.
          content:
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\n            <br/>Error codes:\n            <br/> 503 - Request is invalid"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\n            <br>Error codes:\n            504 - API call rejected by security permissions;"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /aiagents/ProblemDescription:
    get:
      tags:
      - AIAgents
      summary: Retrieves the description of a specific problem based on the provided issue choice.
      operationId: GETv3_aiagents_ProblemDescription?threadId={threadId}&assistantId={assistantId}&enableMetrics={enableMetrics}
      parameters:
      - name: threadId
        in: query
        description: The unique identifier of the conversation.
        required: true
        schema:
          type: string
      - name: assistantId
        in: query
        description: The unique identifier of the AI agent.
        required: true
        schema:
          type: string
      - name: enableMetrics
        in: query
        description: Indicates whether metrics should be enabled. Defaults to false if not specified.
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Request succeeded and the requested information is in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Api.Model.Dashboard.Assistant.AssistantResponse_System.String'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Api.Model.Dashboard.Assistant.AssistantResponse_System.String'
        '400':
          description: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.
        '401':
          description: "Indicates that the requested resource requires authentication.\n            <br>Error codes:\n            504 - API call rejected by security permissions;"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '403':
          description: "You are not authorized to request this resource, or the resource is unavailable for some reason.\n            <br/>Error codes: \n            100 — User has no rights to perform this action."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\n            <br/>Error codes:\n            501 - Unspecified internal server error occurred"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
  /aiagents/CreateFeedbackSession:
    post:
      tags:
      - AIAgents
      summary: Creates a new feedback session for a specific conversation and AI agent
      operationId: POSTv3_aiagents_CreateFeedbackSession
      responses:
        '200':
          description: Request succeeded and the requested information is in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Api.Model.Dashboard.WorkOrdersAi.WoAiFeedbackSessionResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Api.Model.Dashboard.WorkOrdersAi.WoAiFeedbackSessionResponse'
        '400':
          description: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.
        '401':
          description: "Indicates that the requested resource requires authentication.\n            <br>Error codes:\n            504 - API call rejected by security permissions;"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '403':
          description: "You are not authorized to request this resource, or the resource is unavailable for some reason.\n            <br/>Error codes: \n            100 — User has no rights to perform this action."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\n            <br/>Error codes:\n            501 - Unspecified internal server error occurred"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceChannel.Services.WebApi.Models.Request.DashboardAiAgents.WoAiCreateFeedbackSessionRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ServiceChannel.Services.WebApi.Models.Request.DashboardAiAgents.WoAiCreateFeedbackSessionRequest'
        description: Model to create a new feedback session
        required: true
  /aiagents/AddFeedback:
    post:
      tags:
      - AIAgents
      summary: Add a new feedback to exist session for a specific conversation and AI agent
      operationId: POSTv3_aiagents_AddFeedback
      responses:
        '200':
          description: Request succeeded and the requested information is in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Api.Model.Dashboard.WorkOrdersAi.WoAiFeedbackSessionResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Api.Model.Dashboard.WorkOrdersAi.WoAiFeedbackSessionResponse'
        '400':
          description: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.
        '401':
          description: "Indicates that the requested resource requires authentication.\n            <br>Error codes:\n            504 - API call rejected by security permissions;"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '403':
          description: "You are not authorized to request this resource, or the resource is unavailable for some reason.\n            <br/>Error codes: \n            100 — User has no rights to perform this action."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "The server was unable to complete the request due to an internal error.\n            <br/>Error codes:\n            501 - Unspecified internal server error occurred"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Subscribers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceChannel.Services.WebApi.Models.Request.DashboardAiAgents.WoAiAddFeedbackRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ServiceChannel.Services.WebApi.Models.Request.DashboardAiAgents.WoAiAddFeedbackRequest'
        description: Model to create a new feedback
        required: true
components:
  schemas:
    ServiceChannel.Api.Model.Dashboard.Assistant.UsageTokens:
      type: object
      properties:
        PromptTokens:
          format: int32
          type: integer
        CompletionTokens:
          format: int32
          type: integer
        TotalTokens:
          format: int32
          type: integer
    ServiceChannel.Services.Messaging.AzureOpenAI.Assistant.ChatSessionModel:
      type: object
      properties:
        AssistantId:
          type: string
        ThreadId:
          description: OpenAi thread identifier for the conversation
          type: string
        ClientSessionId:
          description: Client-generated session identifier used by the WO Core team as TargetId.
          type: string
    ServiceChannel.Api.Model.Dashboard.Assistant.AssistantResponse_System.String:
      type: object
      properties:
        Result:
          type: string
        Metrics:
          $ref: '#/components/schemas/ServiceChannel.Api.Model.Dashboard.Assistant.AssistantMetrics'
    ServiceChannel.Api.Model.Dashboard.WorkOrdersAi.WoAiFeedbackEntryResponse:
      type: object
      properties:
        Sequence:
          format: int32
          type: integer
        SubmittedAt:
          format: date-time
          type: string
        Rating:
          format: int32
          type: integer
        Reaction:
          enum:
          - Negative
          - Neutral
          - Positive
          type: string
        Feedback:
          type: string
        Extensions:
          type: object
          additionalProperties:
            type: string
    System.Object:
      type: object
      properties: {}
    ServiceChannel.Api.Model.Dashboard.WorkOrdersAi.WoAiFeedbackSessionResponse:
      type: object
      properties:
        SessionId:
          type: string
        Type:
          type: string
        TargetId:
          type: string
        EntryCount:
          format: int32
          type: integer
        CreatedAt:
          format: date-time
          type: string
        UpdatedAt:
          format: date-time
          type: string
        LatestEntry:
          $ref: '#/components/schemas/ServiceChannel.Api.Model.Dashboard.WorkOrdersAi.WoAiFeedbackEntryResponse'
        History:
          type: array
          items:
            $ref: '#/components/schemas/ServiceChannel.Api.Model.Dashboard.WorkOrdersAi.WoAiFeedbackEntryResponse'
    ServiceChannel.Services.WebApi.Models.Request.DashboardAiAgents.WoAiCreateFeedbackSessionRequest:
      description: Model for first step of creating a feedback session, which is to create the session and return the session id. The session id will be used for adding feedbacks in the following steps.
      required:
      - ClientSessionId
      - AssistantStep
      - ThreadId
      type: object
      properties:
        ClientSessionId:
          description: Id of the session, generated at initialization of assistant session
          type: string
        Rating:
          format: int32
          description: Rating provided by the user for the assistant's response, typically on a scale (e.g., 1-5).
          maximum: 5
          minimum: 1
          type: integer
        Reaction:
          description: Reaction provided by the user, indicating their sentiment towards the assistant's response (e.g., Positive = 3, Negative = 1, Neutral = 2).
          enum:
          - Negative
          - Neutral
          - Positive
          type: string
        Feedback:
          description: Textual feedback provided by the user, offering more detailed insights into their experience with the assistant's response.
          type: string
        AssistantStep:
          description: Step of the assistant's response of creating work order process (issueChoice, assets, duplicates, troubleshooting, summary)
          type: string
        ThreadId:
          description: Identifier for the conversation thread, allowing feedback to be associated with a specific interaction session with the assistant.
          type: string
        TotalTokens:
          format: int32
          description: Total number of tokens used in the assistant's response
          maximum: 2147483647
          minimum: 1
          type: integer
        ElapsedSeconds:
          format: int32
          description: Time taken in seconds for the assistant to generate the response
          maximum: 2147483647
          minimum: 0
          type: integer
        LocationId:
          format: int32
          description: LocationId associated with the work order
          maximum: 2147483647
          minimum: 1
          type: integer
    ServiceChannel.Services.WebApi.Models.Request.DashboardAiAgents.WoAiAddFeedbackRequest:
      description: Model for adding feedback to an existing WoAI feedback session.
      required:
      - SessionId
      - AssistantStep
      - ThreadId
      type: object
      properties:
        SessionId:
          description: SessionId of the existing feedback session to which the feedback will be added.
          type: string
        Rating:
          format: int32
          description: Rating provided by the user for the assistant's response, typically on a scale (e.g., 1-5).
          maximum: 5
          minimum: 1
          type: integer
        Reaction:
          description: Reaction provided by the user, indicating their sentiment towards the assistant's response (e.g., Positive = 3, Negative = 1, Neutral = 2).
          enum:
          - Negative
          - Neutral
          - Positive
          type: string
        Feedback:
          description: Textual feedback provided by the user, offering more detailed insights into their experience with the assistant's response.
          type: string
        AssistantStep:
          description: Step of the assistant's response of creating work order process (issueChoice, assets, duplicates, troubleshooting, summary)
          type: string
        ThreadId:
          description: Identifier for the conversation thread, allowing feedback to be associated with a specific interaction session with the assistant.
          type: string
        TotalTokens:
          format: int32
          description: Total number of tokens used in the assistant's response
          maximum: 2147483647
          minimum: 1
          type: integer
        ElapsedSeconds:
          format: int32
          description: Time taken in seconds for the assistant to generate the response
          maximum: 2147483647
          minimum: 0
          type: integer
        LocationId:
          format: int32
          description: LocationId associated with the work order
          maximum: 2147483647
          minimum: 1
          type: integer
    ServiceChannel.Services.Messaging.ErrorResponse:
      description: The error response object
      type: object
      properties:
        ErrorCodes:
          description: The list of error codes. Go to /basics/general/response-codes/#internal-error-codes-and-messages to map error codes to error reasons.
          type: array
          items:
            enum:
            - NotAllowed
            - EmptyProvider
            - InvalidProviderId
            - UnknownProvider
            - ProviderAlreadyExists
            - ProviderIdNotExists
            - TimeoutExpiredError
            - EmptyContract
            - ContractUndefined
            - EmptySubscriber
            - InvalidSubscriberId
            - UnknownSubscriber
            - InactiveSubscriber
            - EmptySubscriberId
            - SubscriberIdNotExists
            - InternalError
            - DataNotFound
            - BadRequest
            - UnAuthorized
            - UnSupportedApplication
            - SubsidiaryUserDisabled
            - EmptyLocation
            - InvalidLocationId
            - UnknownLocation
            - LocationNotBelongsToSubscriber
            - EmptyLocationCountry
            - LocationAlreadyExists
            - InvalidStoreId
            - LocationEmptyState
            - NoAccessToLocation
            - LocationAddressValidationError
            - LocationAddressRequestValidationError
            - InvalidLocationNoteHeader
            - NoAccessToUpdateProtectedNote
            - InvalidBusinessHoursFormat
            - WorkingHoursIntersect
            - InvalidDayOfWeek
            - DuplicateDayOfWeek
            - InvalidBusinessHoursInitialSetup
            - BusinessHoursIsEmpty
            - InvalidHolidayRepeatByType
            - EmptyHolidayListOfDays
            - EmptyHolidayListOfMonths
            - InvalidHolidayMonthName
            - InvalidHolidayNameLength
            - InvalidHolidayRepeatEvery
            - DuplicateMonth
            - InvalidHolidayFrequency
            - InvalidHolidayStartDate
            - InvalidCloseAllDay
            - HolidayDoesNotExist
            - InvalidFormatParameter
            - InvalidLocationCity
            - InvalidLocationZip
            - InvalidLocationLatitude
            - InvalidLocationLongitude
            - InvalidLocationEmail
            - InvalidLocationName
            - InvalidLocationState
            - InvalidLocationAddlAddress
            - InvalidLocationMainAddress
            - InvalidLocationCountry
            - InvalidLocationRegion
            - InvalidLocationDistrict
            - InvalidLocationPhone
            - InvalidLocationContact
            - InvalidLocationFaxNumber
            - LocationCountryNotFound
            - LocationStateNotFound
            - LocationCityNotFound
            - LocationIdNotExists
            - InvalidLocationEmailLength
            - LocationStateIdNotFound
            - IncorrectCombinationStateAndStateId
            - InvalidSubscriberIds
            - InvalidLocalizationSettings
            - LandlordResponsibilityNotFound
            - LandlordResponsibilityAlreadyExists
            - EmptyLocationIds
            - AttachmentNotExist
            - InvalidTradeId
            - InvalidCategoryId
            - InvalidOverrideCategoryId
            - InvalidOverridePriorityId
            - LeaseNoteExceedMaxLength
            - InvalidOverrideProviderRank
            - InvalidOverrideNTE
            - DuplicateRows
            - InvalidPriorityId
            - LocationNotFound
            - EmptyTrade
            - InvalidTrade
            - TradeNotBelongsToSubscriber
            - InvalidPrimaryTrade
            - InvalidTradeForSubscriber
            - InvalidCategoryForSubscriber
            - GlCodeAlreadyExists
            - GlCodeNotExists
            - InvalidGlCodeUpdate
 

# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/servicechannel/refs/heads/main/openapi/servicechannel-aiagents-api-openapi.yml