Orders Storage API documentation version v1

HTTP status code 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers

• Location: required (string)

  URI to the created unit item

Body

Media type: application/json

Type: any

Example:

{
  "name": "main",
  "protectCreate": true,
  "protectRead": false,
  "protectUpdate": true,
  "protectDelete": true
}

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to add unit -- malformed JSON at 13:3"

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create units -- unauthorized

HTTP status code 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": {
      "type": "integer"
    }
  }
}

Example:

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

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

HTTP status code 200

Returns a list of unit items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "collection of acquisitions unit records",
  "type": "object",
  "properties": {
    "acquisitionsUnits": {
      "description": "collection of acquisitions unit records",
      "type": "array",
      "id": "acquisitionsUnits",
      "items": {
        "type": "object",
        "$ref": "acquisitions_unit.json"
      }
    },
    "totalRecords": {
      "description": "The number of objects contained in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "acquisitionsUnits",
    "totalRecords"
  ]
}

Example:

{
   "acquisitionsUnits":
     [
       {
          "name": "main",
          "protectCreate": true,
          "protectRead": false,
          "protectUpdate": true,
          "protectDelete": true
       },
       {
          "name": "law",
          "protectCreate": true,
          "protectRead": true,
          "protectUpdate": true,
          "protectDelete": true
       }
     ],
   "totalRecords": 2
}

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

unable to list units -- malformed parameter 'query', syntax error at column 6

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list units -- unauthorized

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

HTTP status code 204

Item successfully updated

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to update unit -- malformed JSON at 13:4"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"unit not found"

HTTP status code 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": {
      "type": "integer"
    }
  }
}

Example:

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

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

HTTP status code 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Acquisitions Units",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this acquisitions unit record",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "name": {
      "description": "a name for this acquisitions unit",
      "type": "string"
    },
    "protectCreate": {
      "description": "if true, only members can create records associated with this acq unit.",
      "type": "boolean",
      "default": true
    },
    "protectRead": {
      "description": "if true, only members can read/view records associated with this acq unit.",
      "type": "boolean",
      "default": false
    },
    "protectUpdate": {
      "description": "if true, only members can update records associated with this acq unit.",
      "type": "boolean",
      "default": true
    },
    "protectDelete": {
      "description": "if true, only members can delete records associated with this acq unit.",
      "type": "boolean",
      "default": true
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

Example:

{
  "name": "main",
  "protectCreate": true,
  "protectRead": false,
  "protectUpdate": true,
  "protectDelete": true
}

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"unit not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

HTTP status code 204

Item deleted successfully

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to delete unit -- constraint violation"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"unit not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

HTTP status code 200

Returns a list of membership items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "collection of acquisition unit membership records",
  "type": "object",
  "properties": {
    "acquisitionsUnitMemberships": {
      "description": "collection of acquistitions unit membership records",
      "type": "array",
      "id": "acquisitionsUnitMemberships",
      "items": {
        "type": "object",
        "$ref": "acquisitions_unit_membership.json"
      }
    },
    "totalRecords": {
      "description": "The number of objects contained in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "acquisitionsUnitMemberships",
    "totalRecords"
  ]
}

Example:

{
  "acquisitionsUnitMemberships":
    [
     {
        "id": "39982f76-9738-4f49-b3a6-707d1e76853c",
        "userId": "6e076ac5-371e-4462-af79-187c54fe70de",
        "acquisitionsUnitId": "57c35c88-625d-4f0e-bc79-d22818d84d1c"
     },
     {
        "id": "567a6d67-460f-43ab-af28-8c730c9aa4da",
        "userId": "480dba68-ee84-4b9c-a374-7e824fc49227",
        "acquisitionsUnitId": "f6d2cc9d-82ca-437c-a4e6-e5c30323df00"
     },
     {
        "id": "874225ae-e3f5-4666-ae19-b35709ff0ee9",
        "userId": "301883b4-a87b-4fc8-a4c1-e13813db06b0",
        "acquisitionsUnitId": "aa0ec4e1-782f-45f6-a6f3-8e6b6c00599c"
     }
    ],
  "totalRecords": 3
}

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

unable to list memberships -- malformed parameter 'query', syntax error at column 6

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list memberships -- unauthorized

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

HTTP status code 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers

• Location: required (string)

  URI to the created membership item

Body

Media type: application/json

Type: any

Example:

{
   "userId": "6e076ac5-371e-4462-af79-187c54fe70de",
   "acquisitionsUnitId": "57c35c88-625d-4f0e-bc79-d22818d84d1c"
}

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to add membership -- malformed JSON at 13:3"

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create memberships -- unauthorized

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

HTTP status code 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Relationship between a user and an acquistions Unit",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this membership record",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "userId": {
      "description": "The UUID of the user to associate with the acquisitions unit",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "acquisitionsUnitId": {
      "description": "The acquisition unit the user is a member of",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "userId",
    "acquisitionsUnitId"
  ]
}

Example:

{
   "id": "39982f76-9738-4f49-b3a6-707d1e76853c",
   "userId": "6e076ac5-371e-4462-af79-187c54fe70de",
   "acquisitionsUnitId": "57c35c88-625d-4f0e-bc79-d22818d84d1c"
}

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"membership not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

HTTP status code 204

Item deleted successfully

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to delete membership -- constraint violation"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"membership not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

HTTP status code 204

Item successfully updated

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to update membership -- malformed JSON at 13:4"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"membership not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator