openapi: 3.0.1
info:
  title: EUExternalService
  description: This API schema defines endpoints for integrating Energy & Utilities Cloud applications with external systems
  version: "1.0.0"
tags:
  - name: ServicePoints
    description: Operations related to service points
paths:
  /api/v1/servicepoints:
    post:
      tags:
        - ServicePoints
      summary: Get Service Points By Address
      description: Returns a list of service points for a given address.
      operationId: getServicePointsByAddress
      requestBody:
        description: Address to search for service points
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServicePointRequest'
      responses:
        '200':
          description: A list of service points
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServicePoint'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ServicePointRequest:
      type: object
      properties:
        street:
          type: string
        state:
          type: string
        postalCode:
          type: string
        city:
          type: string
        country:
          type: string
      required:
        - street
        - state
        - postalCode
        - city
        - country
    ServicePoint:
      type: object
      properties:
        marketIdentifier:
          type: string
        serviceType:
          type: string
        servicePointId:
          type: string
        distributorCode:
          type: string
        distributionRegion:
          type: string
        tradingStatus:
          type: string
        status:
          type: string
          nullable: true
        address:
          $ref: '#/components/schemas/Address'
      required:
        - marketIdentifier
        - serviceType
        - servicePointId
        - distributorCode
        - distributionRegion
        - tradingStatus
        - address
    Address:
      type: object
      properties:
        street:
          type: string
        state:
          type: string
        postalCode:
          type: string
        city:
          type: string
        country:
          type: string
      required:
        - street
        - state
        - postalCode
        - city
        - country
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
        - message