Livestock Information Ltd API

openapi: 3.1.0
info:
  title: Livestock Information Ltd API
  version: '2026-11-09'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-09: 9 operation(s) read from 1 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Livestock Information Ltd has published no machine-readable contract
    that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 9
    pages-with-code: 0
    pages-read: 1
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-09'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developers.livestockinformation.org.uk/apis/cla-public-ext
paths:
  /Holdings/ValidHoldings:
    post:
      operationId: post_Holdings_ValidHoldings
      tags:
      - Holdings
      summary: POST /Holdings/ValidHoldings endpoint returns results indicating whether the CPHs in the request are valid or not.
      x-source: https://developers.livestockinformation.org.uk/apis/cla-public-ext
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostHoldingsValidholdingsRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostHoldingsValidholdingsResponse'
      x-evidence:
        kind: documentation
  /v1/CorrectTransferRequests:
    get:
      operationId: get_v1_CorrectTransferRequests
      tags:
      - Correcttransferrequests
      summary: GET CorrectTransferRequests returns all requests to correct an existing movement made by the registered user.
      x-source: https://developers.livestockinformation.org.uk/apis/cla-public-ext
      parameters:
      - name: $select
        in: query
        required: false
        schema:
          type: string
        description: Limits the entities to be included in the response.
      - name: $expand
        in: query
        required: false
        schema:
          type: string
        description: Indicates related entities to be represented inline (max depth 2).
      - name: $filter
        in: query
        required: false
        schema:
          type: string
        description: Filters the results set.
      - name: $orderby
        in: query
        required: false
        schema:
          type: string
        description: Specifies the order of returned items.
      - name: $top
        in: query
        required: false
        schema:
          type: integer
        description: Limits the number of results returned.
      - name: $skip
        in: query
        required: false
        schema:
          type: integer
        description: Excludes the specified number of items from the results set.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1CorrecttransferrequestsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_CorrectTransferRequests
      tags:
      - Correcttransferrequests
      summary: POST CorrectTransferRequests amends movement data submitted using TransferRequests after it has been accepted.
      x-source: https://developers.livestockinformation.org.uk/apis/cla-public-ext
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1CorrecttransferrequestsRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1CorrecttransferrequestsResponse'
      x-evidence:
        kind: documentation
  /v1/ReviewHoldingMovementRequests:
    get:
      operationId: get_v1_ReviewHoldingMovementRequests
      tags:
      - Reviewholdingmovementrequests
      summary: GET ReviewHoldingMovementRequests returns a paged list of movement entities requiring review.
      x-source: https://developers.livestockinformation.org.uk/apis/cla-public-ext
      parameters:
      - name: $top
        in: query
        required: false
        schema:
          type: integer
        description: Limits the number of results returned.
      - name: $skip
        in: query
        required: false
        schema:
          type: integer
        description: Excludes the specified number of items from the results set.
      - name: $select
        in: query
        required: false
        schema:
          type: string
        description: Limits the entities to be included in the response.
      - name: $filter
        in: query
        required: false
        schema:
          type: string
        description: Filters the results set.
      - name: $orderby
        in: query
        required: false
        schema:
          type: string
        description: Specifies the order of returned items.
      - name: $expand
        in: query
        required: false
        schema:
          type: string
        description: Indicates related entities to be represented inline (max depth 2).
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1ReviewholdingmovementrequestsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_ReviewHoldingMovementRequests
      tags:
      - Reviewholdingmovementrequests
      summary: POST ReviewHoldingMovementRequests confirms or rejects a movement after it has been retrieved for review.
      x-source: https://developers.livestockinformation.org.uk/apis/cla-public-ext
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1ReviewholdingmovementrequestsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1ReviewholdingmovementrequestsResponse'
      x-evidence:
        kind: documentation
  /v1/TransferRequests:
    get:
      operationId: get_v1_TransferRequests
      tags:
      - Transferrequests
      summary: GET TransferRequests returns all requests made by the registered user to register the movement of animals.
      x-source: https://developers.livestockinformation.org.uk/apis/cla-public-ext
      parameters:
      - name: $select
        in: query
        required: false
        schema:
          type: string
        description: Limits the entities to be included in the response.
      - name: $expand
        in: query
        required: false
        schema:
          type: string
        description: Indicates related entities to be represented inline (max depth 2).
      - name: $filter
        in: query
        required: false
        schema:
          type: string
        description: Filters the results set.
      - name: $orderby
        in: query
        required: false
        schema:
          type: string
        description: Specifies the order of returned items.
      - name: $top
        in: query
        required: false
        schema:
          type: integer
        description: Limits the number of results returned.
      - name: $skip
        in: query
        required: false
        schema:
          type: integer
        description: Excludes the specified number of items from the results set.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1TransferrequestsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_TransferRequests
      tags:
      - Transferrequests
      summary: POST TransferRequests registers the movement of animals between two holdings.
      x-source: https://developers.livestockinformation.org.uk/apis/cla-public-ext
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1TransferrequestsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1TransferrequestsResponse'
      x-evidence:
        kind: documentation
  /v1/UndoRequests:
    get:
      operationId: get_v1_UndoRequests
      tags:
      - Undorequests
      summary: GET UndoRequests returns all previously submitted undo requests made by the registered user.
      x-source: https://developers.livestockinformation.org.uk/apis/cla-public-ext
      parameters:
      - name: $select
        in: query
        required: false
        schema:
          type: string
        description: Limits the entities to be included in the response.
      - name: $expand
        in: query
        required: false
        schema:
          type: string
        description: Indicates related entities to be represented inline (max depth 2).
      - name: $filter
        in: query
        required: false
        schema:
          type: string
        description: Filters the results set.
      - name: $orderby
        in: query
        required: false
        schema:
          type: string
        description: Specifies the order of returned items.
      - name: $top
        in: query
        required: false
        schema:
          type: integer
        description: Limits the number of results returned.
      - name: $skip
        in: query
        required: false
        schema:
          type: integer
        description: Excludes the specified number of items from the results set.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1UndorequestsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_UndoRequests
      tags:
      - Undorequests
      summary: POST UndoRequests supports the ability for users to undo or rollback requests that have previously been submitted.
      x-source: https://developers.livestockinformation.org.uk/apis/cla-public-ext
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1UndorequestsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1UndorequestsResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostHoldingsValidholdingsRequest:
      type: object
      properties:
        holdings:
          type: array
          description: List of CPH identifiers to validate.
        $select:
          type: string
          description: Limits the entities to be included in the response.
        $expand:
          type: string
          description: Indicates related entities to be represented inline (max depth 2).
        $filter:
          type: string
          description: Filters the results set.
        $orderby:
          type: string
          description: Specifies the order of returned items.
        $top:
          type: integer
          description: Limits the number of results returned.
        $skip:
          type: integer
          description: Excludes the specified number of items from the results set.
      required:
      - holdings
    PostHoldingsValidholdingsResponse:
      type: object
      properties:
        value:
          type: array
          description: Array indicating validity of each supplied CPH.
    GetV1CorrecttransferrequestsResponse:
      type: object
      properties:
        value:
          type: array
          description: Array of correct transfer request entities.
    PostV1CorrecttransferrequestsRequest:
      type: object
      properties:
        requestId:
          type: integer
          description: Identifier of the original TransferRequests request being corrected.
        movementDocument:
          type: object
          description: Full details of the corrected movement.
        trackingId:
          type: string
          description: Optional client‑generated tracking identifier (max 36 characters).
      required:
      - requestId
      - movementDocument
    PostV1CorrecttransferrequestsResponse:
      type: object
      properties:
        requestId:
          type: integer
          description: Identifier of the correction request.
        requestStatus:
          type: string
          description: Current processing status of the correction.
    GetV1ReviewholdingmovementrequestsResponse:
      type: object
      properties:
        '@odata.context':
          type: string
          description: Metadata URL.
        value:
          type: array
          description: Array of movement entities.
        '@odata.nextLink':
          type: string
          description: URL for the next page of results, if present.
    PostV1ReviewholdingmovementrequestsRequest:
      type: object
      properties:
        requestId:
          type: integer
          description: The identifier of the movement to confirm or reject.
        tagOrBatchNumbers:
          type: array
          description: List of tag or batch numbers being accepted or rejected.
        trackingId:
          type: string
          description: Optional client‑generated tracking identifier (max 36 characters).
      required:
      - requestId
      - tagOrBatchNumbers
    PostV1ReviewholdingmovementrequestsResponse:
      type: object
      properties:
        requestId:
          type: integer
          description: Identifier of the confirmation/rejection request.
        requestStatus:
          type: string
          description: Current processing status of the request.
    GetV1TransferrequestsResponse:
      type: object
      properties:
        value:
          type: array
          description: Array of transfer request entities.
    PostV1TransferrequestsRequest:
      type: object
      properties:
        movementDocument:
          type: object
          description: Details of the movement, including mandatory fields.
        userHolding:
          type: string
          description: Holding of the submitting user (must match source or destination depending on movement type).
        trackingId:
          type: string
          description: Optional client‑generated tracking identifier (max 36 characters).
      required:
      - movementDocument
      - userHolding
    PostV1TransferrequestsResponse:
      type: object
      properties:
        requestId:
          type: integer
          description: Unique identifier for tracking the request.
        requestStatus:
          type: string
          description: Current processing status (e.g., Pending, Processing, Success, Fail).
    GetV1UndorequestsResponse:
      type: object
      properties:
        value:
          type: array
          description: Array of undo request entities.
    PostV1UndorequestsRequest:
      type: object
      properties:
        undoRequestId:
          type: integer
          description: The requestId of the original request to be rolled back.
        trackingId:
          type: string
          description: Optional client‑generated tracking identifier (max 36 characters).
      required:
      - undoRequestId
    PostV1UndorequestsResponse:
      type: object
      properties:
        requestId:
          type: integer
          description: Identifier of the undo request.
        requestStatus:
          type: string
          description: Current processing status of the undo request.
tags:
- name: Correcttransferrequests
- name: Holdings
- name: Reviewholdingmovementrequests
- name: Transferrequests
- name: Undorequests