JoinData

https://production.join-data.net/api/docs
Admin
JoinData is a data-sharing platform for the agricultural sector that enables secure, standardized...
Tokens:54,895
Snippets:265
Trust Score:4.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /v1/company-mapping/download

Source: https://production.join-data.net/api/docs

Downloads company mappings as a CSV file.

```APIDOC
## GET /v1/company-mapping/download

### Description
Download company mappings as a CSV file.

### Method
GET

### Endpoint
/api/company-mapping-service/v1/company-mapping/download

### Response
#### Success Response (200)
Returns a CSV file containing company mappings.
```

--------------------------------

### GET /schemes

Source: https://production.join-data.net/api/docs

Retrieves the available schemes from the Source Registry API.

```APIDOC
## GET /schemes

### Description
Get the available Schemes.

### Method
GET

### Endpoint
https://production.join-data.net/api/source-registry/v2/schemes

### Response
#### Success Response (200)
Returns a list of schemes.
```

--------------------------------

### GET /v1/partner-purpose-reviews/{id}

Source: https://production.join-data.net/api/docs/spec/joindata-purpose.json

Fetches a single purpose review by its ID.

```APIDOC
## GET /v1/partner-purpose-reviews/{id}

### Description
Gets a specific purpose review by its unique identifier.

### Method
GET

### Endpoint
/v1/partner-purpose-reviews/{id}

### Parameters
#### Path Parameters
- **id** (string, uuid) - Required - The purpose review id.

### Response
#### Success Response (200)
- Returns a `PurposeReviewModelResponseModel` object.

#### Error Responses
- **404** - Not Found (returns `ProblemDetails`)
- **401** - Unauthorized
- **403** - Forbidden

### Security
- Client_Credentials
- Authorization_Code
```

--------------------------------

### GET /management-strategies

Source: https://production.join-data.net/api/docs

Retrieves the available management strategies from the Source Registry API.

```APIDOC
## GET /management-strategies

### Description
Get the available ManagementStrategies.

### Method
GET

### Endpoint
https://production.join-data.net/api/source-registry/v2/management-strategies

### Response
#### Success Response (200)
Returns a list of management strategies.
```

--------------------------------

### GET /v1/scheme-description

Source: https://production.join-data.net/api/docs

Retrieves a list of previously stored scheme descriptions.

```APIDOC
## GET /v1/scheme-description

### Description
Get a list of previously stored Scheme Descriptions.

### Method
GET

### Endpoint
/api/company-mapping-service/v1/scheme-description

### Response
#### Success Response (200)
Returns a list of scheme descriptions.
```

--------------------------------

### GET /v1/mapping-suggestions

Source: https://production.join-data.net/api/docs

Returns mapping suggestions ordered by value, with a default take of 20.

```APIDOC
## GET /v1/mapping-suggestions

### Description
Return suggestions ordered by value, take 20.

### Method
GET

### Endpoint
/api/company-mapping-service/v1/mapping-suggestions

### Parameters
#### Query Parameters
- **order-by** (string) - Optional - Order by field.
- **take** (integer) - Optional - Number of suggestions to take.

### Response
#### Success Response (200)
Returns a list of mapping suggestions.

#### Response Example
[
  {}
]
```

--------------------------------

### GET /v1/purposes/{purposeId}/participations-by-location/{locationScheme}/{locationValue}

Source: https://production.join-data.net/api/docs/spec/joindata-purpose.json

Get Participations for the location using schema nl.ubn.

```APIDOC
## GET /v1/purposes/{purposeId}/participations-by-location/{locationScheme}/{locationValue}

### Description
Get Participations for the location using schema nl.ubn.

### Method
GET

### Endpoint
/v1/purposes/{purposeId}/participations-by-location/{locationScheme}/{locationValue}

### Parameters
#### Path Parameters
- **purposeId** (string, uuid) - Required - Purpose unique identifier
- **locationScheme** (string) - Required - Scheme for the location. Available value is: nl.ubn.
- **locationValue** (string) - Required - Ubn location identifier

#### Query Parameters
- **statuses** (string) - Optional - A comma separated list of statuses. Possible values are: active, granted, refused, revoked, expired, pending, almostExpired.

### Response
#### Success Response (200)
- **ResponseModel** (object) - Success response

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden
- **409** - Conflict

### Security
- Client_Credentials
- Authorization_Code
```

--------------------------------

### GET /companies

Source: https://production.join-data.net/api/docs

Retrieves the available companies from the Source Registry API.

```APIDOC
## GET /companies

### Description
Get the available Companies.

### Method
GET

### Endpoint
https://production.join-data.net/api/source-registry/v2/companies

### Response
#### Success Response (200)
Returns a list of companies.
```

--------------------------------

### GET /v1/partner-purpose-reviews

Source: https://production.join-data.net/api/docs/spec/joindata-purpose.json

Retrieves a list of purpose reviews with optional filtering and pagination.

```APIDOC
## GET /v1/partner-purpose-reviews

### Description
Get purpose reviews.

### Method
GET

### Endpoint
/v1/partner-purpose-reviews

### Parameters
#### Query Parameters
- **state** (PurposeReviewState) - Optional - Filter by state.
- **Skip** (integer, int32) - Optional - The number of items to skip before taking.
- **Take** (integer, int32) - Optional - The number of items to take.

### Response
#### Success Response (200)
- **Success** - Success

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **409** - Conflict
```

--------------------------------

### GET /data-sets

Source: https://production.join-data.net/api/docs

Retrieves the available data sets from the Source Registry API.

```APIDOC
## GET /data-sets

### Description
Get the available DataSets.

### Method
GET

### Endpoint
https://production.join-data.net/api/source-registry/v2/data-sets

### Response
#### Success Response (200)
Returns a list of data sets.
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/identification-tags

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Returns the identification tags for a location. Examples are Nedap, SCR and Gallagher identification tags (EIDs) for animals.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/identification-tags

### Description
Returns the identification tags for a location. Examples are Nedap, SCR and Gallagher identification tags (EIDs) for animals.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/identification-tags

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme id for the location identifier. Possible values: nl.ubn, be.pen
- **location-id** (string) - Required - The location identifier.

#### Query Parameters
- **provider-company-scheme** (string) - Optional - The scheme of the provider company.
- **provider-company-id** (string) - Optional - The ID of the provider company.
- **providing-companies** (string) - Optional - Filter by providing companies.
- **omit-providing-companies** (string) - Optional - Omit providing companies.

### Response
#### Success Response (200)
- **icarIdentificationTagsResponse** (object) - The response containing the current identification tags available on the location.

#### Response Example
```json
{
  "identificationTags": "example"
}
```

### Error Response
- **default** - Error response.
```

--------------------------------

### GET /v1/partner-purpose-reviews

Source: https://production.join-data.net/api/docs/spec/joindata-purpose.json

Retrieves a paginated list of purpose reviews with optional filtering, sorting, and count omission.

```APIDOC
## GET /v1/partner-purpose-reviews

### Description
Retrieves a list of purpose reviews with optional filtering, sorting, and pagination.

### Method
GET

### Endpoint
/v1/partner-purpose-reviews

### Parameters
#### Query Parameters
- **Page** (integer) - Optional - Page number.
- **PageSize** (integer) - Optional - Number of items per page.
- **OrderBy** (string) - Optional - Order by column name.
- **IsDescending** (boolean) - Optional - True for descending order; otherwise false.
- **OmitCount** (boolean) - Optional - Does not include the total count in the result.

### Response
#### Success Response (200)
- Returns a `PurposeReviewModelPageResultModelResponseModel` object.

#### Error Responses
- **401** - Unauthorized
- **403** - Forbidden

### Security
- Client_Credentials
- Authorization_Code
```

--------------------------------

### GET /v1/company-dataset

Source: https://production.join-data.net/api/docs

Retrieves the logged-in company's default DataSet preference.

```APIDOC
## GET /v1/company-dataset

### Description
Get the logged in company's preference for default DataSet.

### Method
GET

### Endpoint
/api/company-mapping-service/v1/company-dataset

### Response
#### Success Response (200)
Returns the company's default DataSet preference.

#### Response Example
{
  "companyDataSet": {}
}
```

--------------------------------

### GET /v1/statistics/usage-statistics

Source: https://production.join-data.net/api/docs

Retrieves usage statistics about active company mappings on a reference date.

```APIDOC
## GET /v1/statistics/usage-statistics

### Description
Gets statistics about active companymappings on the reference date.

### Method
GET

### Endpoint
/api/company-mapping-service/v1/statistics/usage-statistics

### Parameters
#### Query Parameters
- **referenceDate** (string) - Optional - The reference date for the statistics.

### Response
#### Success Response (200)
Returns usage statistics.
```

--------------------------------

### GET /v1/partner-review-purposes

Source: https://production.join-data.net/api/docs/spec/joindata-purpose.json

Retrieves a paginated list of purpose review purposes with optional filtering, sorting, and paging parameters.

```APIDOC
## GET /v1/partner-review-purposes

### Description
Get a page of purpose review purposes.

### Method
GET

### Endpoint
/v1/partner-review-purposes

### Parameters
#### Query Parameters
- **state** (PurposeReviewState) - Optional - Filter by state.
- **Skip** (integer) - Optional - The number of items to skip before taking.
- **Take** (integer) - Optional - The number of items to take.
- **OrderBy** (string) - Optional - Order by column name.
- **IsDescending** (boolean) - Optional - True for descending order; otherwise false.
- **OmitCount** (boolean) - Optional - Does not include the total count in the result.

### Response
#### Success Response (200)
- **PurposeReviewPurposeModelPageResultModelResponseModel** - The response model.

#### Response Example
```json
{
  "items": [],
  "totalCount": 0
}
```

#### Error Responses
- **401** - Unauthorized
- **403** - Forbidden

### Security
- Client_Credentials
- Authorization_Code
```

--------------------------------

### GET /v1/company-mapping

Source: https://production.join-data.net/api/docs

Retrieves a paged list of company mappings.

```APIDOC
## GET /v1/company-mapping

### Description
Get a paged list of company mappings.

### Method
GET

### Endpoint
/api/company-mapping-service/v1/company-mapping

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number.
- **pageSize** (integer) - Optional - Number of items per page.

### Response
#### Success Response (200)
Returns a paged list of company mappings.

#### Response Example
{
  "companyMappingPagedList": {}
}
```

--------------------------------

### GET /data-types

Source: https://production.join-data.net/api/docs

Retrieves the available data types from the Source Registry API.

```APIDOC
## GET /data-types

### Description
Get the available DataTypes.

### Method
GET

### Endpoint
https://production.join-data.net/api/source-registry/v2/data-types

### Response
#### Success Response (200)
Returns a list of data types.
```

--------------------------------

### GET /v1/company-mapping/mine

Source: https://production.join-data.net/api/docs

Retrieves a paged list of company mappings for the logged-in company.

```APIDOC
## GET /v1/company-mapping/mine

### Description
Get a paged list of company mappings.

### Method
GET

### Endpoint
/api/company-mapping-service/v1/company-mapping/mine

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number.
- **pageSize** (integer) - Optional - Number of items per page.

### Response
#### Success Response (200)
Returns a paged list of company mappings.

#### Response Example
{
  "companyMappingPagedList": {}
}
```

--------------------------------

### GET /v1/company-mapping/{id}

Source: https://production.join-data.net/api/docs

Retrieves a single company mapping by its id.

```APIDOC
## GET /v1/company-mapping/{id}

### Description
Get a single Company Mapping by its id.

### Method
GET

### Endpoint
/api/company-mapping-service/v1/company-mapping/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The id of the company mapping.

### Response
#### Success Response (200)
Returns the company mapping with the specified id.

#### Response Example
{
  "companyMapping": {}
}
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/births

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Provides the born animals on a location. The response contains the births for the given location.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/births

### Description
Provides the born animals on a location. The response contains the births for the given location.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/births

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme id for the location identifier. Allowed values: nl.ubn, be.pen.
- **location-id** (string) - Required - The unique identifier for the location.

#### Query Parameters
- **start-date-time** (string, date-time) - Optional - The start of the date-time range for the data to get in the request.
- **end-date-time** (string, date-time) - Optional - The end of the date-time range for the data to get in the request.
- **modified-since** (string, date-time) - Optional - Query parameter for filtering by modification date.

### Response
#### Success Response (200)
- Returns an array of icarMovementArrivalResponse objects.

#### Response Example
```json
[
  {
    "id": "string",
    "animal": {},
    "location": {}
  }
]
```
```

--------------------------------

### GET /v1/company-mapping/historic

Source: https://production.join-data.net/api/docs

Retrieves a paged list of company mappings for a given historic date.

```APIDOC
## GET /v1/company-mapping/historic

### Description
Get a paged list of company mappings for a given historic date.

### Method
GET

### Endpoint
/api/company-mapping-service/v1/company-mapping/historic

### Parameters
#### Query Parameters
- **date** (string) - Required - The historic date.
- **page** (integer) - Optional - Page number.
- **pageSize** (integer) - Optional - Number of items per page.

### Response
#### Success Response (200)
Returns a paged list of company mappings for the historic date.

#### Response Example
{
  "companyMappingPagedList": {}
}
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/lactations

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Retrieves lactation information for animals on the specified location.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/lactations

### Description
Lactation information of an animal.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/lactations

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme id for the location identifier. Allowed values: nl.ubn, be.pen
- **location-id** (string) - Required - The unique identifier for the location.

### Response
#### Success Response (200)
- **icarLactationResponse** (object) - The response contains lactation information.

#### Response Example
{
  "icarLactationResponse": {}
}

### Error Handling
Default error response is returned for errors.
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/arrivals

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Retrieves the arrival events for a given location. The response contains the births for the given location.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/arrivals

### Description
Retrieves the arrival events for a given location. The response contains the births for the given location.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/arrivals

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme id for the location identifier. Allowed values: nl.ubn, be.pen.
- **location-id** (string) - Required - The unique identifier for the location.

#### Query Parameters
- **start-date-time** (string, date-time) - Optional - The start of the date-time range for the data to get in the request.
- **end-date-time** (string, date-time) - Optional - The end of the date-time range for the data to get in the request.
- **modified-since** (string, date-time) - Optional - Query parameter for filtering by modification date.
- **omit-providing-companies** (boolean) - Optional - Query parameter to omit providing companies.

### Response
#### Success Response (200)
- Returns an array of icarMovementArrivalResponse objects.

#### Response Example
```json
[
  {
    "id": "string",
    "animal": {},
    "location": {}
  }
]
```
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/milk-predictions

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Provides a prediction of the lactation peak and persistence of the animals on the location.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/milk-predictions

### Description
Provides a prediction of the lactation peak and persistence of the animals on the location.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/milk-predictions

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme id for the location identifier. Allowed values: nl.ubn, be.pen.
- **location-id** (string) - Required - The unique identifier for the location.

#### Query Parameters
- **modified-since** (string) - Optional - Filter on modified since date and time.

### Response
#### Success Response (200)
- **milkPredictionsResponse** (object) - The response contains the milk predictions for the given location.

#### Response Example
{
  "milkPredictionsResponse": {}
}

### Error Handling
- **default** - Error response.
```

--------------------------------

### GET /data-sets/{data-set-id}/providers

Source: https://production.join-data.net/api/docs

Retrieves the registered providers for a specific data set.

```APIDOC
## GET /data-sets/{data-set-id}/providers

### Description
Get the registered Providers per DataSet.

### Method
GET

### Endpoint
https://production.join-data.net/api/source-registry/v2/data-sets/{data-set-id}/providers

### Parameters
#### Path Parameters
- **data-set-id** (string) - Required - The id of the data set.

### Response
#### Success Response (200)
Returns a list of providers for the data set.
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/herd-list

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Returns the herd list for a location. The response contains the animal identifiers for the location.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/herd-list

### Description
Returns the herd list for a location. The response contains the animal identifiers for the location.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/herd-list

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme id for the location identifier.
- **location-id** (string) - Required - The location identifier.

#### Query Parameters
- **start-date-time** (string) - Optional - Start date and time for filtering.
- **end-date-time** (string) - Optional - End date and time for filtering.
- **provider-company-scheme** (string) - Optional - The scheme of the provider company.
- **provider-company-id** (string) - Optional - The ID of the provider company.
- **providing-companies** (string) - Optional - Filter by providing companies.
- **omit-providing-companies** (string) - Optional - Omit providing companies.

### Response
#### Success Response (200)
- **icarHerdListResponse** (object) - The herd list response containing animal identifiers.

#### Response Example
```json
{
  "herdList": "example"
}
```

### Error Response
- **default** - Error response.
```

--------------------------------

### GET /v1/statistics/trustlevel-statistics

Source: https://production.join-data.net/api/docs

Retrieves trust level statistics about active company mappings on a reference date.

```APIDOC
## GET /v1/statistics/trustlevel-statistics

### Description
Gets statistics about active companymappings on the reference date.

### Method
GET

### Endpoint
/api/company-mapping-service/v1/statistics/trustlevel-statistics

### Parameters
#### Query Parameters
- **referenceDate** (string) - Optional - The reference date for the statistics.

### Response
#### Success Response (200)
Returns trust level statistics.
```

--------------------------------

### GET /v1/purposes/{id}

Source: https://production.join-data.net/api/docs/spec/joindata-purpose.json

Retrieves a specific purpose by its unique identifier. The purpose ID is provided as a path parameter.

```APIDOC
## GET /v1/purposes/{id}

### Description
Get a purpose by its unique identifier.

### Method
GET

### Endpoint
/v1/purposes/{id}

### Parameters
#### Path Parameters
- **purposeId** (string, uuid) - Required - The purpose id.

### Response
#### Success Response (200)
- Returns a RestrictionModelIEnumerableResponseModel.

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden
- **409** - Conflict

### Security
- Client_Credentials
- Authorization_Code
```

--------------------------------

### GET /data-sets/{data-set-id}/data-types

Source: https://production.join-data.net/api/docs

Retrieves the registered data types for a specific data set.

```APIDOC
## GET /data-sets/{data-set-id}/data-types

### Description
Get the registered DataTypes for a DataSet.

### Method
GET

### Endpoint
https://production.join-data.net/api/source-registry/v2/data-sets/{data-set-id}/data-types

### Parameters
#### Path Parameters
- **data-set-id** (string) - Required - The id of the data set.

### Response
#### Success Response (200)
Returns a list of data types for the data set.
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/breeding-values

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Provides breeding values of the animals present on a farm. The response contains the breeding value resource.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/breeding-values

### Description
Provides breeding values of the animals present on a farm. The response contains the breeding value resource.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/breeding-values

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme id for the location identifier. Allowed values: nl.ubn, be.pen.
- **location-id** (string) - Required - The unique identifier for the location.

#### Query Parameters
- **modified-since** (string, date-time) - Optional - Only return breeding values modified since this date-time.
- **breeding-value-base** (string) - Optional - The base for the breeding values.

### Response
#### Success Response (200)
- Returns an icarBreedingValueResource object.

#### Response Example
```json
{
  "breedingValue": {}
}
```

### Error Response
- **default** - Error response as defined by the error component.
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/grazing

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Retrieves eDairy grazing data for the specified location. Requires a start date-time parameter.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/grazing

### Description
Returns the eDairy grazing data for the location specified.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/grazing

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme id for the location identifier. The scheme be.pen is only available for providing company FrieslandCampina Nederland B.V. Allowed values: nl.ubn, be.pen.
- **location-id** (string) - Required - The unique identifier for the location.

#### Query Parameters
- **start-date-time** (string, date-time) - Required - The start of the date-time range for the data to get in the request. Format 2022-12-31T23:59:59.999Z.

### Response
#### Success Response (200)
- **ediXmlResponse** - The response contains the intake data for the location.

#### Response Example
{
  "ediXmlResponse": {}
}

### Error Response
- **default** - An error has occurred while handling the request. Check the content of the message for the error details.
```

--------------------------------

### OPTIONS /v1/purposes

Source: https://production.join-data.net/api/docs/spec/joindata-purpose.json

Returns the available options for the purposes resource.

```APIDOC
## OPTIONS /v1/purposes

### Description
Return the available options for this resource.

### Method
OPTIONS

### Endpoint
/v1/purposes

### Response
#### Success Response (200)
- Success

#### Error Responses
- **401** - Unauthorized
- **403** - Forbidden

### Security
- Client_Credentials
- Authorization_Code
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/semen-deliveries

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Retrieves semen deliveries for a specified location. Requires location scheme and ID, start and end date-time range, and pagination parameters.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/semen-deliveries

### Description
Retrieves semen deliveries for the specified location.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/semen-deliveries

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme of the location.
- **location-id** (string) - Required - The identifier of the location.

#### Query Parameters
- **start-date-time** (string, date-time) - Required - The start of the date-time range for the data to get in the request.
- **end-date-time** (string, date-time) - Required - The end of the date-time range for the data to get in the request.
- **limit** (integer, int32) - Required - The limit option allows you to limit the number of rows returned up to a maximum of 50 rows per request.
- **offset** (integer, int32) - Required - The offset option allows you to omit a specified number of rows before the beginning of the result set.

### Response
#### Success Response (200)
- **semenDeliveriesResponse** - The response contains the semen deliveries for the location.

#### Response Example
{
  "semenDeliveriesResponse": {}
}

#### Error Response (default)
- **errors** (array of error) - A list of errors.

#### Error Example
{
  "errors": []
}
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/available-eartags

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Provides a list of the free ear tags that the farmer has in possession and can use to tag a calf.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/available-eartags

### Description
This provides a list of the free ear tags – the farmer has these in his possession and can use them to tag a calf.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/available-eartags

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme id for the location identifier. Allowed values: nl.ubn, be.pen.
- **location-id** (string) - Required - The unique identifier for the location.

### Response
#### Success Response (200)
- **AvailableEartagsResponse** - The response contains a list of the free ear tags for the location.

#### Response Example
{
  "eartags": []
}

### Error Response
Default - An error has occurred while handling the request. Check the content of the message for the error details.
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/fuel-deliveries

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Retrieves fuel deliveries for a specific location. The endpoint requires path parameters for the location scheme and ID, and accepts optional query parameters for start and end date-time to filter the results.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/fuel-deliveries

### Description
Retrieves fuel deliveries for a specific location. The response contains the fuel deliveries for the location.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/fuel-deliveries

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme id for the location identifier.
- **location-id** (string) - Required - The unique identifier for the location.

#### Query Parameters
- **start-date-time** (string, date-time) - Optional - The start date-time for filtering fuel deliveries.
- **end-date-time** (string, date-time) - Optional - The end date-time for filtering fuel deliveries.

### Response
#### Success Response (200)
- **ediXmlResponse** (object) - The response contains the fuel deliveries for the location.

#### Response Example
{
  "ediXmlResponse": {}
}

### Error Handling
- **default** - Error response.
```

--------------------------------

### GET /v1/purposes/{purpose_id}/participations/{participation_id}/restrictions

Source: https://production.join-data.net/api/docs/spec/joindata-purpose.json

Get all restrictions for a specific participation in a purpose.

```APIDOC
## GET /v1/purposes/{purpose_id}/participations/{participation_id}/restrictions

### Description
Get all restrictions for a specific participation in a purpose.

### Method
GET

### Endpoint
/v1/purposes/{purpose_id}/participations/{participation_id}/restrictions

### Parameters
#### Path Parameters
- **purpose_id** (string, uuid) - Required - Purpose unique identifier
- **participation_id** (string, uuid) - Required - Participation unique identifier

### Response
#### Success Response (200)
- **RestrictionModelIEnumerableResponseModel** (object) - List of restrictions

#### Success Response (204)
- No Content

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden
- **409** - Conflict

### Security
- Client_Credentials
- Authorization_Code
```

--------------------------------

### POST /v1/mapping-suggestions

Source: https://production.join-data.net/api/docs/spec/joindata-company-mapping-service.json

Creates a new company mapping suggestion.

```APIDOC
## POST /v1/mapping-suggestions

### Description
Creates a new company mapping suggestion.

### Method
POST

### Endpoint
/v1/mapping-suggestions

### Parameters
#### Request Body
- **CreateSuggestions** (object) - Required - The company mapping to add

### Response
#### Success Response (200)
Returns the created MappingSuggestion object.

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **500** - Internal Server Error
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/drying-offs

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Gets the drying off for a certain location. Provides the drying off on a location.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/drying-offs

### Description
Gets the drying off for a certain location. Provides the drying off on a location.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/drying-offs

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme id for the location identifier. Allowed values: nl.ubn, be.pen.
- **location-id** (string) - Required - The unique identifier for the location.

#### Query Parameters
- **providerCompanyScheme** (string) - Optional - The scheme of the provider company.
- **providerCompanyId** (string) - Optional - The identifier of the provider company.
- **providingCompanies** (array) - Optional - List of providing companies to filter by.
- **omitProvidingCompanies** (array) - Optional - List of providing companies to exclude.

### Response
#### Success Response (200)
- **icarMilkingDryOffResponse** (object) - The response containing the drying off records.

#### Response Example
{
  "icarMilkingDryOffResponse": {}
}

### Error Response
- **default** - Error response as defined by the error component.
```

--------------------------------

### POST /v1/mapping-suggestions

Source: https://production.join-data.net/api/docs

Creates a new mapping suggestion.

```APIDOC
## POST /v1/mapping-suggestions

### Description
Create a new company mapping.

### Method
POST

### Endpoint
/api/company-mapping-service/v1/mapping-suggestions

### Parameters
#### Request Body
- **createSuggestions** (object) - Required - The suggestion to create.

### Response
#### Success Response (200)
Returns the created mapping suggestion.

#### Response Example
{
  "mappingSuggestion": {}
}
```

--------------------------------

### POST /companies

Source: https://production.join-data.net/api/docs

Creates a new company in the Source Registry API.

```APIDOC
## POST /companies

### Description
Create a new Company.

### Method
POST

### Endpoint
https://production.join-data.net/api/source-registry/v2/companies

### Parameters
#### Request Body
- **company** (object) - Required - The company to create.

### Response
#### Success Response (200)
Returns the created company.
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/do-not-breeds

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Gets the Do-not-breed events for a certain location. Provides the do-not-breed events on a location.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/do-not-breeds

### Description
Gets the Do-not-breed events for a certain location. Provides the do-not-breed events on a location.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/do-not-breeds

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme id for the location identifier. Allowed values: nl.ubn, be.pen.
- **location-id** (string) - Required - The unique identifier for the location.

#### Query Parameters
- **modifiedSince** (string) - Optional - Filter to only return records modified since the given timestamp.
- **providerCompanyScheme** (string) - Optional - The scheme of the provider company.
- **providerCompanyId** (string) - Optional - The identifier of the provider company.
- **providingCompanies** (array) - Optional - List of providing companies to filter by.
- **omitProvidingCompanies** (array) - Optional - List of providing companies to exclude.

### Response
#### Success Response (200)
- **icarReproDoNotBreedResponse** (object) - The response containing the Do-not-breed events.

#### Response Example
{
  "icarReproDoNotBreedResponse": {}
}

### Error Response
- **default** - Error response as defined by the error component.
```

--------------------------------

### POST /data-sets

Source: https://production.join-data.net/api/docs

Creates a new data set in the Source Registry API.

```APIDOC
## POST /data-sets

### Description
Create a new DataSet.

### Method
POST

### Endpoint
https://production.join-data.net/api/source-registry/v2/data-sets

### Parameters
#### Request Body
- **dataSet** (object) - Required - The data set to create.

### Response
#### Success Response (200)
Returns the created data set.
```

--------------------------------

### GET /v1/mandates/{id}

Source: https://production.join-data.net/api/docs/spec/joindata-purpose.json

Retrieves a specific mandate by its unique identifier.

```APIDOC
## GET /v1/mandates/{id}

### Description
Get a specific mandate.

### Method
GET

### Endpoint
/v1/mandates/{id}

### Parameters
#### Path Parameters
- **id** (string, uuid) - Required - The mandate id.

### Response
#### Success Response (200)
- **MandateModelResponseModel** - Success

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **409** - Conflict

### Security
- Client_Credentials
- Authorization_Code
```

--------------------------------

### GET /v1/mandates/{id}

Source: https://production.join-data.net/api/docs/spec/joindata-purpose.json

Retrieves a specific mandate by its unique identifier.

```APIDOC
## GET /v1/mandates/{id}

### Description
Get a specific mandate.

### Method
GET

### Endpoint
/v1/mandates/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the mandate.

### Response
#### Success Response (200)
- **MandateModel** - Success

#### Response Example
```json
{
  "id": "string",
  "dataset": "string",
  "purpose": "string",
  "status": "string",
  "companies": [
    {
      "role": "string",
      "value": "string",
      "scheme": "string"
    }
  ]
}
```

#### Error Responses
- **400** - Bad Request (ProblemDetails)
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found (ProblemDetails)
- **409** - Conflict (ProblemDetails)

### Security
- Client_Credentials
- Authorization_Code
```

--------------------------------

### GET /v1/scheme-restriction

Source: https://production.join-data.net/api/docs/spec/joindata-company-mapping-service.json

Retrieves a list of all previously stored scheme restrictions.

```APIDOC
## GET /v1/scheme-restriction

### Description
Get a list of previously stored Scheme Restriction.

### Method
GET

### Endpoint
/v1/scheme-restriction

### Parameters
None

### Response
#### Success Response (200)
- Returns an array of SchemeRestriction objects.

#### Response Example
```json
[
  {
    "id": 0,
    "name": "string",
    "description": "string"
  }
]
```

#### Error Responses
- **401** - Unauthorized
- **400** - Bad Request
- **500** - Internal Server Error (returns ApiError object)
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/mating-recommendations

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Returns mating recommendations for the specified location. The endpoint accepts location identifiers and optional query parameters to filter results.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/mating-recommendations

### Description
Returns mating recommendations of the location specified.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/mating-recommendations

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme identifying the location.
- **location-id** (string) - Required - The unique identifier of the location.

#### Query Parameters
- **queryStartDateTime** - Optional - Referenced parameter.
- **queryEndDateTime** - Optional - Referenced parameter.
- **queryModifiedSince** - Optional - Referenced parameter.
- **queryProviderCompanyScheme** - Optional - Referenced parameter.
- **queryProviderCompanyId** - Optional - Referenced parameter.
- **queryProvidingCompanies** - Optional - Referenced parameter.
- **queryOmitProvidingCompanies** - Optional - Referenced parameter.

### Response
#### Success Response (200)
- **icarReproMatingRecommendationsResponse** - The response contains the milk delivery data for the location.

#### Response Example
{
  "icarReproMatingRecommendationsResponse": {}
}

#### Error Response (default)
- Referenced error response.
```

--------------------------------

### POST /locations/{location-scheme}/{location-id}/arrivals

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Pushes information regarding the arrived animals on a location. The request body contains the arrival event data.

```APIDOC
## POST /locations/{location-scheme}/{location-id}/arrivals

### Description
Pushes information regarding the arrived animals on a location. The request body contains the arrival event data.

### Method
POST

### Endpoint
/locations/{location-scheme}/{location-id}/arrivals

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme id for the location identifier. Allowed values: nl.ubn, be.pen.
- **location-id** (string) - Required - The unique identifier for the location.

#### Request Body
- **icarMovementArrivalResponse** (object) - Required - The arrival event data to be posted.

### Request Example
```json
{
  "id": "string",
  "animal": {},
  "location": {}
}
```

### Response
#### Success Response (202)
- Returns an object with a data property containing the icarMovementArrivalResponse.

#### Response Example
```json
{
  "data": {
    "id": "string",
    "animal": {},
    "location": {}
  }
}
```
```

--------------------------------

### POST /v1/upload

Source: https://production.join-data.net/api/docs/spec/joindata-company-mapping-service.json

Uploads a CSV file containing new company mappings.

```APIDOC
## POST /v1/upload

### Description
Upload a csv file with new company mappings.

### Method
POST

### Endpoint
/v1/upload

### Request Body
CSV file content (multipart/form-data).

### Response
#### Success Response (200)
Returns an UploadResult object.

#### Response Example
{
  "success": true,
  "message": "Upload successful"
}

#### Error Responses
- **400** - Bad Request
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/heat-activities

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Retrieves a list of in-heat activity information for female animals on a specified location. The response contains activity data filtered by the provided parameters.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/heat-activities

### Description
Returns a list with in-heat activity information for a location.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/heat-activities

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme id for the location identifier. Allowed values: nl.ubn, be.pen.
- **location-id** (string) - Required - The location identifier.

#### Query Parameters
- **startDateTime** (string) - Optional - Start date/time for filtering.
- **endDateTime** (string) - Optional - End date/time for filtering.
- **animalScheme** (string) - Optional - Scheme for the animal identifier.
- **animalId** (string) - Optional - Animal identifier.
- **providerCompanyScheme** (string) - Optional - Scheme for the provider company identifier.
- **providerCompanyId** (string) - Optional - Provider company identifier.
- **providingCompanies** (string) - Optional - List of providing companies.
- **omitProvidingCompanies** (string) - Optional - List of providing companies to omit.

### Response
#### Success Response (200)
- Returns in-heat activity data for the location.

#### Response Example
{
  "type": "icarHeatActivitiesResponse"
}

### Error Response
- **default** - Error response.
```

--------------------------------

### GET /locations/{location-scheme}/{location-id}/weights

Source: https://production.join-data.net/api/docs/spec/joindata-datahub/joindata-datahub.json

Returns a list of weight measurement events for a location. The response contains weight information for the specified location.

```APIDOC
## GET /locations/{location-scheme}/{location-id}/weights

### Description
Returns a list of weight measurement events for a location.

### Method
GET

### Endpoint
/locations/{location-scheme}/{location-id}/weights

### Parameters
#### Path Parameters
- **location-scheme** (string) - Required - The scheme of the location identifier.
- **location-id** (string) - Required - The identifier of the location.

#### Query Parameters
- **start-date-time** (string) - Optional - Start date and time for filtering weight events.
- **end-date-time** (string) - Optional - End date and time for filtering weight events.

### Response
#### Success Response (200)
- **weightMeasurementEvents** (array) - A list of weight measurement events.

#### Response Example
{
  "weightMeasurementEvents": []
}

#### Error Response (default)
- **error** (object) - An error object.

#### Error Example
{
  "error": {}
}
```

--------------------------------

### POST /v1/purposes/{purpose_id}/participations-by-location

Source: https://production.join-data.net/api/docs/spec/joindata-purpose.json

Creates participations for companies using the nl.ubn scheme for a specific purpose.

```APIDOC
## POST /v1/purposes/{purpose_id}/participations-by-location

### Description
Create participations for the given companies, using schema nl.ubn.

### Method
POST

### Endpoint
/v1/purposes/{purpose_id}/participations-by-location

### Parameters
#### Path Parameters
- **purpose_id** (string, uuid) - Required - Purpose unique identifier

#### Request Body
- **ParticipationsByLocationPostModel** (object) - Required - List of companies with nl.ubn scheme's and values

### Request Example
{
  "companies": [
    {
      "scheme": "nl.ubn",
      "value": "string"
    }
  ]
}

### Response
#### Success Response (200)
- **NewParticipationModelIListResponseModel** (object) - Success

#### Response Example
{
  "data": [
    {
      "id": "string"
    }
  ]
}

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden
- **409** - Conflict

### Security
- Client_Credentials
- Authorization_Code
```
Tokens:
Raw