Farmbrite Nutrients API

openapi: 3.2.0
info:
  title: Farmbrite API Developers Documentation Nutrients 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: Nutrients
  description: 'Nutrients are embedded resources that are used by a variety of different core resources. Specifically, you can access treatments for resources:


    - Grow Locations `/plots`

    - Plantings `/crops`


    Nutrient records represent both soil amendments (nutrients added) and soil samples - see details in the Create a Nutrient Record section.


    To create or access a nutrient record, simply append ''/nutrients'' to the end of the resource path. For example: \[GET\] /crops/:id/nutrients will fetch the nutrient records for this planting.'
paths:
  /{resource_name}/{resource_id}/nutrients:
    post:
      tags:
      - Nutrients
      summary: Create a Nutrient Record
      description: 'Create a soil sample or amendment record


        ### Parameters


        **amount** `OPTIONAL`


        A string value of the amount applied, for example "1,000 lbs" or "200 gallons"


        * * *


        **application_method** `OPTIONAL`


        Details about how the amendment was applied, typically one of the following options, but could be a custom value:


        > "Broadcast", "Compost - Solids", "Compost - Tea", "Granules", "Liquid", "Manure", "Pellets", "Spray", "Other"


        * * *


        **boron** `OPTIONAL`


        A positive numeric value indicating the amount of boron applied or measured (depending on if this is additive or a sample)


        * * *


        **calcium** `OPTIONAL`


        A positive numeric value indicating the amount of calcium applied or measured (depending on if this is additive or a sample)


        * * *


        **copper** `OPTIONAL`


        A positive numeric value indicating the amount of copper applied or measured (depending on if this is additive or a sample)


        * * *


        **date** `OPTIONAL`


        The date of the amendment or sample. Defaults to today.


        * * *


        **iron** `OPTIONAL`


        A positive numeric value indicating the amount of iron applied or measured (depending on if this is additive or a sample)


        * * *


        **is_additive** `OPTIONAL`


        Boolean value indicating is this is an amendment or a soil sample. `true` indicates that this is an amendment, `false` a soil sample. Defaults to `false`.


        * * *


        **latitude** `OPTIONAL`


        An optional latitude value for the location of the amendment or sample


        * * *


        **longitude** `OPTIONAL`


        An optional longitude value for the location of the amendment or sample


        * * *


        **magnesium** `OPTIONAL`


        A positive numeric value indicating the amount of magnesium applied or measured (depending on if this is additive or a sample)


        * * *


        manganese `OPTIONAL`


        A positive numeric value indicating the amount of magnesium applied or measured (depending on if this is additive or a sample)


        * * *


        **nitrogen** `OPTIONAL`


        A positive numeric value indicating the amount of nitrogen applied or measured (depending on if this is additive or a sample)


        * * *


        **ph** `OPTIONAL`


        A numeric (float) value for the Ph measured. Typically used with a soil sample.


        * * *


        **phosphorus** `OPTIONAL`


        A positive numeric value indicating the amount of phosphorus applied or measured (depending on if this is additive or a sample)


        * * *


        **potassium** `OPTIONAL`


        A positive numeric value indicating the amount of potassium applied or measured (depending on if this is additive or a sample)


        * * *


        **product** `OPTIONAL`


        Details or name of the product applied, typically used with an amendment.


        * * *


        **sulfur** `OPTIONAL`


        A positive numeric value indicating the amount of sulfur applied or measured (depending on if this is additive or a sample)


        * * *


        **zinc** `OPTIONAL`


        A positive numeric value indicating the amount of zinc applied or measured (depending on if this is additive or a sample)'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                amount: null
                application_method: null
                boron: 7
                calcium: 6
                copper: 8
                date: '2022-03-26'
                is_additive: false
                iron: 9
                latitude: null
                longitude: null
                magnesium: 4
                manganese: 11
                nitrogen: 1
                ph: 9
                phosphorus: 2
                potassium: 3
                product: null
                sulfur: 5
                zinc: 10
      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: postByResourceNameByResourceIdNutrients
      x-operation-id-source: derived
    get:
      tags:
      - Nutrients
      summary: List Nutrients
      parameters:
      - name: resource_name
        in: path
        schema:
          type: string
        required: true
      - name: resource_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                - id: GUID
                  amount: 50 lbs
                  application_method: Broadcast
                  boron: null
                  calcium: null
                  copper: null
                  created_at: '2021-03-27 05:29:23'
                  created_by: User
                  date: '2021-03-26'
                  is_additive: true
                  latitude: null
                  longitude: null
                  magnesium: null
                  nitrogen: 50
                  ph: null
                  phosphorus: 40
                  potassium: 30
                  product: Compost
                  sulfur: null
                  updated_at: '2021-03-27 05:29:23'
      operationId: getByResourceNameByResourceIdNutrients
      x-operation-id-source: derived
  /{resource_name}/{resource_id}/nutrients/{nutrient_id}:
    get:
      tags:
      - Nutrients
      summary: Retrieve a Nutrient Record
      parameters:
      - name: resource_name
        in: path
        schema:
          type: string
        required: true
      - name: resource_id
        in: path
        schema:
          type: string
        required: true
      - name: nutrient_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                id: GUID
                amount: '99'
                application_method: ''
                boron: 5
                calcium: 6
                copper: 4
                created_at: '2022-09-02 03:38:34'
                created_by: User
                date: '2022-09-02'
                iron: 3
                is_additive: true
                latitude: null
                longitude: null
                magnesium: 8
                manganese: 1
                nitrogen: 11
                ph: null
                phosphorus: 10
                potassium: 9
                product: more sutff
                sulfur: 7
                updated_at: '2022-09-02 03:38:34'
                zinc: 2
      operationId: getByResourceNameByResourceIdNutrientsByNutrientId
      x-operation-id-source: derived
    put:
      tags:
      - Nutrients
      summary: Update a Nutrient Record
      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: nutrient_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: putByResourceNameByResourceIdNutrientsByNutrientId
      x-operation-id-source: derived
    delete:
      tags:
      - Nutrients
      summary: Delete a Nutrient Record
      parameters:
      - name: resource_name
        in: path
        schema:
          type: string
        required: true
      - name: resource_id
        in: path
        schema:
          type: string
        required: true
      - name: nutrient_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: deleteByResourceNameByResourceIdNutrientsByNutrientId
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer