openapi: 3.2.0
info:
  title: 701x API V1 Animal Check In API
  description: 701x API
  version: v1
tags:
- name: AnimalCheckIn
paths:
  /AnimalCheckIn/AnimalCheckInReport:
    get:
      tags:
      - AnimalCheckIn
      parameters:
      - name: top
        in: query
        schema:
          type:
          - integer
          - 'null'
          format: int32
      - name: UploadedByTagId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: CompanyId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: FarmId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: FarmVirtualFenceId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: FarmPointOfInterestId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: TagId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: AnimalId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: StartCheckInDateTime
        in: query
        schema:
          type:
          - string
          - 'null'
          format: date-time
      - name: EndCheckInDateTime
        in: query
        schema:
          type:
          - string
          - 'null'
          format: date-time
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Animal_CheckIn_Report'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Animal_CheckIn_Report'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Animal_CheckIn_Report'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Get animal check in animal check in report
      x-summary-source: derived
      operationId: getAnimalCheckInAnimalCheckInReport
      x-operation-id-source: derived
  /AnimalCheckIn/AnimalCheckInDataByFilter:
    get:
      tags:
      - AnimalCheckIn
      parameters:
      - name: top
        in: query
        schema:
          type:
          - integer
          - 'null'
          format: int32
      - name: UploadedByTagId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: CompanyId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: FarmId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: FarmVirtualFenceId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: FarmPointOfInterestId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: TagId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: AnimalId
        in: query
        schema:
          type:
          - string
          - 'null'
          format: uuid
      - name: StartCheckInDateTime
        in: query
        schema:
          type:
          - string
          - 'null'
          format: date-time
      - name: EndCheckInDateTime
        in: query
        schema:
          type:
          - string
          - 'null'
          format: date-time
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Animal_CheckIn'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Animal_CheckIn'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Animal_CheckIn'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Get animal check in animal check in data by filter
      x-summary-source: derived
      operationId: getAnimalCheckInAnimalCheckInDataByFilter
      x-operation-id-source: derived
  /AnimalCheckIn/{id}:
    get:
      tags:
      - AnimalCheckIn
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Animal_CheckIn'
            application/json:
              schema:
                $ref: '#/components/schemas/Animal_CheckIn'
            text/json:
              schema:
                $ref: '#/components/schemas/Animal_CheckIn'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Get animal check in by id
      x-summary-source: derived
      operationId: getAnimalCheckInById
      x-operation-id-source: derived
    put:
      tags:
      - AnimalCheckIn
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Animal_CheckIn'
          application/json:
            schema:
              $ref: '#/components/schemas/Animal_CheckIn'
          text/json:
            schema:
              $ref: '#/components/schemas/Animal_CheckIn'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Animal_CheckIn'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Animal_CheckIn'
            application/json:
              schema:
                $ref: '#/components/schemas/Animal_CheckIn'
            text/json:
              schema:
                $ref: '#/components/schemas/Animal_CheckIn'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Replace animal check in by id
      x-summary-source: derived
      operationId: putAnimalCheckInById
      x-operation-id-source: derived
    delete:
      tags:
      - AnimalCheckIn
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Animal_CheckIn'
            application/json:
              schema:
                $ref: '#/components/schemas/Animal_CheckIn'
            text/json:
              schema:
                $ref: '#/components/schemas/Animal_CheckIn'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Delete animal check in by id
      x-summary-source: derived
      operationId: deleteAnimalCheckInById
      x-operation-id-source: derived
  /AnimalCheckIn:
    post:
      tags:
      - AnimalCheckIn
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Animal_CheckIn'
          application/json:
            schema:
              $ref: '#/components/schemas/Animal_CheckIn'
          text/json:
            schema:
              $ref: '#/components/schemas/Animal_CheckIn'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Animal_CheckIn'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Animal_CheckIn'
            application/json:
              schema:
                $ref: '#/components/schemas/Animal_CheckIn'
            text/json:
              schema:
                $ref: '#/components/schemas/Animal_CheckIn'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Create animal check in
      x-summary-source: derived
      operationId: postAnimalCheckIn
      x-operation-id-source: derived
  /AnimalCheckIn/MassInsert:
    post:
      tags:
      - AnimalCheckIn
      requestBody:
        content:
          application/json-patch+json:
            schema:
              type:
              - array
              - 'null'
              items:
                $ref: '#/components/schemas/Animal_CheckIn'
          application/json:
            schema:
              type:
              - array
              - 'null'
              items:
                $ref: '#/components/schemas/Animal_CheckIn'
          text/json:
            schema:
              type:
              - array
              - 'null'
              items:
                $ref: '#/components/schemas/Animal_CheckIn'
          application/*+json:
            schema:
              type:
              - array
              - 'null'
              items:
                $ref: '#/components/schemas/Animal_CheckIn'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Animal_CheckIn'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Animal_CheckIn'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Animal_CheckIn'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Create animal check in mass insert
      x-summary-source: derived
      operationId: postAnimalCheckInMassInsert
      x-operation-id-source: derived
  /AnimalCheckIn/MassUpdate:
    post:
      tags:
      - AnimalCheckIn
      requestBody:
        content:
          application/json-patch+json:
            schema:
              type:
              - array
              - 'null'
              items:
                $ref: '#/components/schemas/Animal_CheckIn'
          application/json:
            schema:
              type:
              - array
              - 'null'
              items:
                $ref: '#/components/schemas/Animal_CheckIn'
          text/json:
            schema:
              type:
              - array
              - 'null'
              items:
                $ref: '#/components/schemas/Animal_CheckIn'
          application/*+json:
            schema:
              type:
              - array
              - 'null'
              items:
                $ref: '#/components/schemas/Animal_CheckIn'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Animal_CheckIn'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Animal_CheckIn'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Animal_CheckIn'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Create animal check in mass update
      x-summary-source: derived
      operationId: postAnimalCheckInMassUpdate
      x-operation-id-source: derived
  /AnimalCheckIn/MassDelete:
    post:
      tags:
      - AnimalCheckIn
      requestBody:
        content:
          application/json-patch+json:
            schema:
              type:
              - array
              - 'null'
              items:
                $ref: '#/components/schemas/Animal_CheckIn'
          application/json:
            schema:
              type:
              - array
              - 'null'
              items:
                $ref: '#/components/schemas/Animal_CheckIn'
          text/json:
            schema:
              type:
              - array
              - 'null'
              items:
                $ref: '#/components/schemas/Animal_CheckIn'
          application/*+json:
            schema:
              type:
              - array
              - 'null'
              items:
                $ref: '#/components/schemas/Animal_CheckIn'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Animal_CheckIn'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Animal_CheckIn'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Animal_CheckIn'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - API701x
      summary: Create animal check in mass delete
      x-summary-source: derived
      operationId: postAnimalCheckInMassDelete
      x-operation-id-source: derived
components:
  schemas:
    Animal_CheckIn:
      type: object
      properties:
        id:
          type: string
          format: uuid
        companyId:
          type:
          - string
          - 'null'
          format: uuid
        farmId:
          type:
          - string
          - 'null'
          format: uuid
        farmVirtualFenceId:
          type:
          - string
          - 'null'
          format: uuid
        farmPointOfInterestId:
          type:
          - string
          - 'null'
          format: uuid
        animalId:
          type:
          - string
          - 'null'
          format: uuid
        tagId:
          type:
          - string
          - 'null'
          format: uuid
        uploadedByTagId:
          type:
          - string
          - 'null'
          format: uuid
        checkInDateTime:
          type:
          - string
          - 'null'
          format: date-time
        createdByDate:
          type:
          - string
          - 'null'
          format: date-time
        createdByUserId:
          type:
          - string
          - 'null'
          format: uuid
        createdByName:
          type:
          - string
          - 'null'
        lastUpdatedByDate:
          type:
          - string
          - 'null'
          format: date-time
        lastUpdatedByUserId:
          type:
          - string
          - 'null'
          format: uuid
        lastUpdatedByName:
          type:
          - string
          - 'null'
        inActiveDate:
          type:
          - string
          - 'null'
          format: date-time
        isNew:
          type: boolean
        isUpdate:
          type: boolean
        isDelete:
          type: boolean
        error:
          type:
          - string
          - 'null'
      additionalProperties: false
    Animal_CheckIn_Report:
      type: object
      properties:
        uploadedByTagId:
          type:
          - string
          - 'null'
          format: uuid
        forDate:
          type:
          - string
          - 'null'
          format: date-time
        onHour:
          type:
          - integer
          - 'null'
          format: int32
        numberOfAnimals:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.701x.com/connect/authorize
          tokenUrl: https://login.701x.com/connect/token
          scopes:
            api1: Demo API - full access