Skip to content

Interu API (v2_28)

Download OpenAPI description
Languages
Servers
Mock server
https://developer.interu.io/_mock/reference/api/
UAT
https://api.uat.interu.io/

Validation

Apis related to Validation.

Operations

Get Validation StatusProposed Endpoint

Request

Retrieve validation status for given records.

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
recordsArray of stringsrequired

List of record URIs that you want to confirm are valid based on provided Criteria.

includeRulesetsbooleanrequired

List of criteria to apply for validation.

includedRiskAssessmentsArray of strings(Assessment.RiskAssessmentType)

If Risk Assessments are included in Criteria, this allows definition of which types of Risk Assessment are included in the check. If not included then risk assessments will be ignored.

Items Enum"COUNTRY""DELIVERY""LOCATION""MATERIAL""ORGANISTION""PRODUCT"
treatMissingAsErrorboolean

If this is set to true then if a risk assessment is missing (or has expired - effectively missing) then it will cause validation to fail.

Default false
curl -i -X POST \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/validation/status' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "records": [
      "string"
    ],
    "includeRulesets": true,
    "includedRiskAssessments": [
      "COUNTRY"
    ],
    "treatMissingAsError": false
  }'

Responses

The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.

Headers
Locationstring

Location of the created resource

Bodyapplication/json
recordsArray of objects(Assessment.ValidationStatus)required

List of records that have been evaluated.

records[].​recordUristring(uri)required

URI of the record whose status you want to confirm

records[].​validatedbooleanrequired

The validation status. If true it means that the record passes the provided Criteria.

records[].​failingRulesetsArray of strings

If rulesets applicable to the record have not validated, this returns the name of the rulesets that have failed.

records[].​failingRiskAssessmentsArray of objects(Assessment.FailingRiskAssessment)

If Risk Assessments were included in the request then this contains the list of risk assessment types that have not passed the validation.

Response
application/json
{ "records": [ {} ] }

Base Units

Apis related to Base Units.

Operations

Country List

Apis related to Country List.

Operations

Standards

Apis related to Standards.

Operations

Document Types

Apis related to Document Types.

Operations

Location Types

Apis related to Location Types.

Operations

Process Types

Apis related to Process Types.

Operations

Attachments

Apis related to Attachments.

Operations

Documents

Apis related to Documents.

Operations

EUDR

Apis related to EUDR and Due Diligence Statement Submission.

Operations

Connections

Apis related to Connections.

Operations

Locations

Apis related to Locations.

Operations

Materials

Apis related to Materials.

Operations

Products

Apis related to Products.

Operations

Deliveries

Apis related to Deliveries.

Operations

Items

Apis related to Items.

Operations

Orders

Apis related to Orders.

Operations

Processes

Apis related to Processes.

Operations

Outbound Delivery Workflow

Operations