openapi: 3.2.0
info:
  title: Automile Resource Owner Place API
  version: v1
tags:
- name: ResourceOwnerPlace
paths:
  /v1/resourceowner/place:
    get:
      tags:
      - ResourceOwnerPlace
      summary: Get places
      description: Only places that the user has access to are accessible.
      operationId: GetResourceOwnerPlaces
      responses:
        '200':
          description: The places are returned
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlaceModel'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlaceModel'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlaceModel'
        '500':
          description: Internal server error
      security:
      - oauth2: []
    post:
      tags:
      - ResourceOwnerPlace
      summary: Creates a new place
      description: This will create a new place and associate it with a vehicle.
      operationId: CreateResourceOwnerPlace
      responses:
        '200':
          description: A link in the header is returned to the newly created place
        '500':
          description: Internal server error
        '400':
          description: Bad request, could occur for a number of cases, see returned message
        '403':
          description: Request is forbidden, could occur for a number of reasons, see returned message
      security:
      - oauth2: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlaceCreateModel'
          text/json:
            schema:
              $ref: '#/components/schemas/PlaceCreateModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/PlaceCreateModel'
        description: The place model
  /v1/resourceowner/place/{placeId}:
    get:
      tags:
      - ResourceOwnerPlace
      summary: Get place
      description: Only places that the user has access to are accessible.
      operationId: GetResourceOwnerPlace
      parameters:
      - in: path
        name: placeId
        description: The places id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The place details are returned
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PlaceModel'
            application/json:
              schema:
                $ref: '#/components/schemas/PlaceModel'
            text/json:
              schema:
                $ref: '#/components/schemas/PlaceModel'
        '500':
          description: Internal server error
        '403':
          description: Request is forbidden, meaning you don't have access to this places
      security:
      - oauth2: []
    put:
      tags:
      - ResourceOwnerPlace
      summary: Updates the given place with new model
      description: This will update the given place id with a new model.
      operationId: EditResourceOwnerPlace
      parameters:
      - in: path
        name: placeId
        description: The vehicle id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The given place was saved
        '500':
          description: Internal server error
        '400':
          description: Bad request, could occur for a number of cases, see returned message
        '403':
          description: Request is forbidden, could occur for a number of reasons, see returned message
      security:
      - oauth2: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlaceEditModel'
          text/json:
            schema:
              $ref: '#/components/schemas/PlaceEditModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/PlaceEditModel'
        description: The new place model
    delete:
      tags:
      - ResourceOwnerPlace
      summary: Removes the given company
      description: Removes the given place.
      operationId: DeleteResourceOwnerPlace
      parameters:
      - in: path
        name: placeId
        description: The place id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The place has been deleted
        '500':
          description: Internal server error
        '404':
          description: Not found, the place you tried to remove can't be found
        '403':
          description: Request is forbidden, could occur for a number of reasons, see returned message
      security:
      - oauth2: []
components:
  schemas:
    PositionPointModel:
      type: object
      properties:
        Longitude:
          format: double
          type: number
        Latitude:
          format: double
          type: number
      additionalProperties: false
    PlaceEditModel:
      required:
      - Name
      - PositionPoint
      type: object
      properties:
        Name:
          minLength: 1
          type: string
        PositionPoint:
          $ref: '#/components/schemas/PositionPointModel'
      additionalProperties: false
    PlaceModel:
      type: object
      properties:
        PlaceId:
          format: int32
          type: integer
        Name:
          type: string
        Description:
          type: string
        PositionPoint:
          $ref: '#/components/schemas/PositionPointModel'
        TripType:
          format: int32
          enum:
          - 0
          - 1
          - 2
          - 3
          type: integer
        TripTypeTrigger:
          format: int32
          enum:
          - 0
          - 1
          - 2
          - 3
          type: integer
        Radius:
          format: int32
          type: integer
        IsEditable:
          type: boolean
        VehicleIds:
          type: array
          items:
            format: int32
            type: integer
        DrivesBetweenAnotherPlaceId:
          format: int32
          type: integer
      additionalProperties: false
    PlaceCreateModel:
      required:
      - Name
      - PositionPoint
      - Radius
      - VehicleId
      type: object
      properties:
        Name:
          minLength: 1
          type: string
        VehicleId:
          format: int32
          type: integer
        Radius:
          format: int32
          type: integer
        PositionPoint:
          $ref: '#/components/schemas/PositionPointModel'
        Description:
          type: string
        TripType:
          format: int32
          enum:
          - 0
          - 1
          - 2
          - 3
          type: integer
        TripTypeTrigger:
          format: int32
          enum:
          - 0
          - 1
          - 2
          - 3
          type: integer
        DrivesBetweenAnotherPlaceId:
          format: int32
          type: integer
      additionalProperties: false
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          scopes:
            read: Read access to protected resources
            write: Write access to protected resources
          authorizationUrl: https://api.automile.com/login/
      description: OAuth2 Implicit Grant
x-provenance:
  method: harvested
  publisher: Automileab
  source: https://api.automile.com/swagger/v1/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)