Circulation (v0.1)

http://localhost:9130

Table of contents

Loan Anonymization API

Loan Anonymization API

/loan-anonymization

POST /loan-anonymization/by-user/{userId}

POST /loan-anonymization/by-user/{userId}
URI Parameters
  • userId: required (string)

Response 200

Chosen loans have been successfully anonymized

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Response schema for anonymize loans request",
  "type": "object",
  "properties": {
    "anonymizedLoans": {
      "description": "Successfully anonymized loan ids",
      "type": "array",
      "items":{
        "type": "string"
      }
    },
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "../raml-util/schemas/error.schema"
      }
    }
  },
  "additionalProperties": false
}

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator