Farmbrite Treatments API

openapi: 3.2.0
info:
  title: Farmbrite API Developers Documentation Treatments API
  description: '# Overview


    Welcome to the Farmbrite API. You can find out more about Farmbrite at

    www.farmbrite.com


    If you need help, check out our help center at help.farmbrite.com or email us at dev@farmbrite.com. ## API Reference


    The Farmbrite API allows authorized users programatic access to their account data in order to facilitate the integration of this data with other systems and service. The API is organized around REST standards. The API uses resource-oriented URLs and returns JSON-encoded responses. It uses standard HTTP response codes, authentication, and verbs. > Base URL


    ```

    https://api.farmbrite.com/v1


    ```


    # Authentication


    Farmbrite offers 2 authentication options for accessing the API both utilizing Personal Access Tokens (PATs) for enabling access to the API. Access Tokens (API Keys) are associated with an individual user in your account and inherit that user''s role and permissions. You can find the Access Token on the user profile page under API Key. When building an integration we recommend setting up a separate API user for the integration and changing the API KEY on a regular basis. Remember to keep your Access Tokens secret; treat them just like passwords! They act on your behalf when interacting with the API, with the same permissions and access as the user has. _Don''t hardcode them into your programs_. Instead, choose to store them as environment variables. ### Bearer Token


    To make a request to the API include the Authorization Bearer header with your request and include your Access Token (API KEY) as the value. Access Token and API KEY are used interchangeably through out the documentation. > Example cURL request authenticating with Bearer Token authentication


    ```

    curl https://api.farmbrite.com/v1/tasks \

    -H "Authorization: Bearer ACCESS_TOKEN"


    ```


    ### API Key


    Alternatively to using the Bearer Token authorization method, you can provide an API KEY as a header with your request. Use the header `api_key` with a value of your Access Token (API KEY). > Example cURL request authenticating with API Key header authentication


    ```

    curl https://api.farmbrite.com/v1/tasks \

    -H "api_key: ACCESS_TOKEN"


    ```


    # Errors


    Sadly, sometimes requests to the API fail. Failures can occur for a wide range of reasons. In all cases, the API should return an HTTP Status Code indicating the nature of the failure. | Code | Meaning | Description |

    | --- | --- | --- |

    | 200 | Success | The request was successful. If applicable the data it will be available in the data field at the top level of the response body. |

    | 400 | Bad Request | Typically caused by a missing or malformed parameter. Check the documentation and your request and try again. |

    | 401 | Unauthorized | No access token or an invalid access token was provided with the request. The error can also occur if the user or account is invalid or does not have access to this resource. |

    | 403 | Forbidden | The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you access resources that the user or account does not have access to. |

    | 404 | Not Found | Either the method and path supplied do not specify a known action or the object related to the request does not exist. |

    | 429 | Too Many Requests | You have exceeded one of the rate limits in the API. See the Rate Limits section for more information. |

    | 500 | Internal Server Error | There was a problem on Farmbrite''s side which was logged and reported to our technical team. You can retry, but if the problem continues please contact support. |


    Details about errors can sometimes also be found in the ''message'' property at the root level of the JSON response body. # Pagination


    In order to optimize performance, all list methods in the API will limit the total response data to a certain number of records and return the data in chunks (pages). API responses will include information about the total records available, the current page and total pages.'
  version: 1.0.0
  x-logo:
    url: https://static.farmbrite.com/assets/www/images/logo.png
    backgroundColor: '#FFFFFF'
    altText: Farmbrite
  termsOfService: https://www.farmbrite.com/terms
  contact:
    name: Farmbrite
    url: https://developers.farmbrite.com
    email: dev@farmbrite.com
servers:
- url: https://api.farmbrite.com/v1
security:
- bearerAuth: []
tags:
- name: Treatments
  description: 'Treatments are embedded resources that are used by a variety of core resources. Specifically, you can access treatments for resources:


    - Livestock `/animals`

    - Livestock Groups (Create Only) `/livestock_groups`

    - Grow Locations `/plots`

    - Plantings `/crops`


    To create or access treatments for a record, simply append ''/treatments'' to the end of the resource path. For example: \[GET\] /animals/:animal_id/treatments will fetch the records for this animal.'
paths:
  /{resource_name}/{resource_id}/treatments:
    post:
      tags:
      - Treatments
      summary: Create a Treatment
      description: 'Create a treatment record


        ### Parameters


        **type** `REQUIRED`


        The type of treatment performed. These varies by resource type, but custom values can be supplied as well.


        **For livestock, support options are:**


        > "Alternative Therapy", "Artificial Insemination", "Branding", "Castration", "Dehorning", "Dental Procedure", "Deworming", "Ear Notching", "Euthanasia", "Grooming", "Hoof Trim", "Medication", "Mites", "Parasite Treatment", "Surgical Procedure", "Tagging", "Tattoo", "Vaccination", "Other Procedure"


        **For plantings and grow locations, supported options are:**


        > "Blight","Fertilize","Fungus","Herbicide","Insect","Mildew","Mites","Mold","Nutrients","Pesticide","Virus","Other"


        * * *


        **date** `OPTIONAL`


        The date of the treatment, defaults to today


        * * *


        **amount** `OPTIONAL`


        An optional string representing the amount/quantity used. For example: 50ml


        * * *


        **batch** `OPTIONAL`


        Batch information for the product used in the treatment (if applicable)


        * * *


        **cost** `OPTIONAL`


        A positive numeric value (in your account currency) representing the cost of the treatment


        * * *


        **description** `OPTIONAL`


        Details or summary of the treatment provided


        * * *


        **keywords** `OPTIONAL`


        A comma-delimited string of keywords, tags or labels used to find similar treatments


        * * *


        **mode** `OPTIONAL`


        The method of application of the treatment performed. These vary by resource type, but custom values can be supplied as well.


        **For livestock, support options are:**


        > "Intramuscular (in the muscle)", "Intramammary (in the udder)", "Intrauterine (in the uterus)", "Intravenous (in the vein)", "Oral (in the mouth)", "Subcutaneous (under the skin)", "Topical (on the skin)", "Other"


        **For plantings and grow locations, supported options are:**


        > "Granules", "Spray", "Other"


        * * *


        **product** `OPTIONAL`


        The name of the product used (if applicable)


        * * *


        **retreat_date** `OPTIONAL`


        An optional date for when to retreat or provide a booster if required.


        * * *


        **site** `OPTIONAL`


        The location that the treatment was applied. These varies by resource type, but custom values can be supplied as well.


        **For livestock, support options are:**


        > "Rump", "Flank", "Neck"


        **For plantings and grow locations, supported options are:**


        > "Leaf", "Seed", "Soil"


        * * *


        **technician** `OPTIONAL`


        Details or name of the technician or company that performed the treatment.


        * * *


        **withdrawal_date** `OPTIONAL`


        An optional date for when to the crop or livestock will be safe to harvest after the treatment. Typically used for compliance and food safety requirements for meat or milk production after certain medication or treatments.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                amount: 2-mL
                batch: '123'
                cost: 0
                date: '2022-02-02'
                description: First dose
                keywords: ''
                mode: Intramuscular (in the muscle)
                product: BRSV Vaccine
                retreat_date: '2022-03-02'
                site: ''
                technician: ''
                type: Vaccination
                withdrawal_date: null
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: resource_name
        in: path
        schema:
          type: string
        required: true
      - name: resource_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: postByResourceNameByResourceIdTreatments
      x-operation-id-source: derived
    get:
      tags:
      - Treatments
      summary: List Treatments
      parameters:
      - name: resource_name
        in: path
        schema:
          type: string
        required: true
        example: '{{resource_name}}'
      - name: resource_id
        in: path
        schema:
          type: string
        required: true
        example: '{{resource_id}}'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                - id: GUID
                  amount: 2-mL
                  batch: '123'
                  cost: 0
                  created_at: '2022-02-02 15:23:18'
                  created_by: User
                  date: '2022-02-02'
                  description: ''
                  keywords: ''
                  mode: Intramuscular (in the muscle)
                  product: BRSV Vaccine
                  retreat_date: null
                  record_type: animal
                  record_id: 65a720572ba8ef1844234a57
                  record_name: Animal Name - breed [tag_number]
                  site: ''
                  technician: ''
                  type: Vaccination
                  updated_at: '2022-02-02 15:23:18'
                  withdrawal_date: null
      operationId: getByResourceNameByResourceIdTreatments
      x-operation-id-source: derived
  /{resource_name}/{resource_id}/treatments/{treatment_id}:
    get:
      tags:
      - Treatments
      summary: Retrieve a Treatment
      parameters:
      - name: resource_name
        in: path
        schema:
          type: string
        required: true
        example: '{{resource_name}}'
      - name: resource_id
        in: path
        schema:
          type: string
        required: true
        example: '{{resource_id}}'
      - name: treatment_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                id: GUID
                amount: ''
                batch: '123'
                cost: 0
                created_at: '2022-02-02 15:23:18'
                created_by: User
                date: '2022-02-02'
                description: ''
                keywords: ''
                mode: Intramuscular (in the muscle)
                product: BRSV Vaccine
                retreat_date: null
                record_type: animal
                record_id: 65a720572ba8ef1844234a57
                record_name: Animal Name - breed [tag_number]
                site: ''
                technician: ''
                type: Vaccination
                updated_at: '2022-02-02 15:23:18'
                withdrawal_date: null
      operationId: getByResourceNameByResourceIdTreatmentsByTreatmentId
      x-operation-id-source: derived
    put:
      tags:
      - Treatments
      summary: Update a Treatment
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                description: Updated Record
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: resource_name
        in: path
        schema:
          type: string
        required: true
      - name: resource_id
        in: path
        schema:
          type: string
        required: true
      - name: treatment_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: putByResourceNameByResourceIdTreatmentsByTreatmentId
      x-operation-id-source: derived
    delete:
      tags:
      - Treatments
      summary: Delete a Treatment
      parameters:
      - name: resource_name
        in: path
        schema:
          type: string
        required: true
      - name: resource_id
        in: path
        schema:
          type: string
        required: true
      - name: treatment_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: deleteByResourceNameByResourceIdTreatmentsByTreatmentId
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer