Fixed Due Date Schedule (v2.0)

http://localhost:9130

Table of contents

Fixed Due Date Schedule Storage API

Storage for fixed due date schedules

/fixed-due-date-schedule-storage

GET /fixed-due-date-schedule-storage/fixed-due-date-schedules

Retrieve a list of fixed-due-date-schedule items.

GET /fixed-due-date-schedule-storage/fixed-due-date-schedules
Query Parameters
  • offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)

    Skip over a number of elements by specifying an offset value for the query

    Example:

    0
  • limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)

    Limit the number of elements returned in the response

    Example:

    10
  • query: (string)

    A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

    with valid searchable fields

    Example:

    (username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
    
    name=semester
    
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns a list of fixed-due-date-schedule items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of fixedDueDateSchedules",
  "type": "object",
  "properties": {
    "fixedDueDateSchedules": {
      "description": "List of items",
      "id": "fixedDueDateSchedules",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "fixed-due-date-schedule.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "fixedDueDateSchedules",
    "totalRecords"
  ]
}

Example:

{
  "fixedDueDateSchedules": [
    {
      "id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
      "name": "Fall Semester Due Date Schedule",
      "description": "An example fixed due date schedule",
      "schedules": [
        {
          "from": "2017-08-18T17:00:00Z",
          "to": "2017-12-14T17:00:00Z",
          "due": "2018-01-25T17:00:00Z"
        },
        {
          "from": "2018-08-17T17:00:00Z",
          "to": "2018-12-15T17:00:00Z",
          "due": "2018-01-23T17:00:00Z"
        }
      ]
    },
    {
      "id": "0df935eb-f3f4-4741-9ac6-33c500174b96",
      "name": "Winter Intersession 2017 Due Date Schedule",
      "description": "Another example fixed due date schedule",
      "schedules": [
        {
          "from": "2017-12-06T17:00:00Z",
          "to": "2018-01-17T17:00:00Z",
          "due": "2018-01-28T17:00:00Z"
        }
      ]
    }
  ],
  "totalRecords": 2
}

Response 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 fixed-due-date-schedules -- malformed parameter 'query', syntax error at column 6

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list fixed-due-date-schedules -- unauthorized

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": {
      "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

Response 501

Not implemented yet

POST /fixed-due-date-schedule-storage/fixed-due-date-schedules

Create a new fixed-due-date-schedule item.

POST /fixed-due-date-schedule-storage/fixed-due-date-schedules
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "A set of date ranges for materials checkout and their associated due dates.",
  "properties": {
    "id": {
      "description": "Unique ID (generated UUID)",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "schedules": {
      "id": "schedules",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "schedule.json"
      }
    },
    "metadata": {
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

Example:

{
  "id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
  "name": "Fall Semester Due Date Schedule",
  "description": "An example fixed due date schedule",
  "schedules": [
    {
      "from": "2017-08-18T17:00:00Z",
      "to": "2017-12-14T17:00:00Z",
      "due": "2018-01-25T17:00:00Z"
    },
    {
      "from": "2018-08-17T17:00:00Z",
      "to": "2018-12-15T17:00:00Z",
      "due": "2018-01-23T17:00:00Z"
    }
  ]
}

Response 201

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

Headers
  • Location: required (string)

    URI to the created fixed-due-date-schedule item

Body

Media type: application/json

Type: any

Example:

{
  "id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
  "name": "Fall Semester Due Date Schedule",
  "description": "An example fixed due date schedule",
  "schedules": [
    {
      "from": "2017-08-18T17:00:00Z",
      "to": "2017-12-14T17:00:00Z",
      "due": "2018-01-25T17:00:00Z"
    },
    {
      "from": "2018-08-17T17:00:00Z",
      "to": "2018-12-15T17:00:00Z",
      "due": "2018-01-23T17:00:00Z"
    }
  ]
}

Response 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 fixed-due-date-schedule -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create fixed-due-date-schedules -- unauthorized

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": {
      "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

Response 501

Not implemented yet

DELETE /fixed-due-date-schedule-storage/fixed-due-date-schedules

DELETE /fixed-due-date-schedule-storage/fixed-due-date-schedules
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

All fixed due date schedules deleted

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

Response 501

Not implemented yet

GET /fixed-due-date-schedule-storage/fixed-due-date-schedules/{fixedDueDateScheduleId}

Retrieve fixed-due-date-schedule item with given {fixed-due-date-scheduleId}

GET /fixed-due-date-schedule-storage/fixed-due-date-schedules/{fixedDueDateScheduleId}
URI Parameters
  • fixedDueDateScheduleId: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "A set of date ranges for materials checkout and their associated due dates.",
  "properties": {
    "id": {
      "description": "Unique ID (generated UUID)",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "schedules": {
      "id": "schedules",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "schedule.json"
      }
    },
    "metadata": {
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

Example:

{
  "id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
  "name": "Fall Semester Due Date Schedule",
  "description": "An example fixed due date schedule",
  "schedules": [
    {
      "from": "2017-08-18T17:00:00Z",
      "to": "2017-12-14T17:00:00Z",
      "due": "2018-01-25T17:00:00Z"
    },
    {
      "from": "2018-08-17T17:00:00Z",
      "to": "2018-12-15T17:00:00Z",
      "due": "2018-01-23T17:00:00Z"
    }
  ]
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"fixed-due-date-schedule not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Response 501

Not implemented yet

PUT /fixed-due-date-schedule-storage/fixed-due-date-schedules/{fixedDueDateScheduleId}

Update fixed-due-date-schedule item with given {fixed-due-date-scheduleId}

PUT /fixed-due-date-schedule-storage/fixed-due-date-schedules/{fixedDueDateScheduleId}
URI Parameters
  • fixedDueDateScheduleId: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "A set of date ranges for materials checkout and their associated due dates.",
  "properties": {
    "id": {
      "description": "Unique ID (generated UUID)",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "schedules": {
      "id": "schedules",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "schedule.json"
      }
    },
    "metadata": {
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

Example:

{
  "id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
  "name": "Fall Semester Due Date Schedule",
  "description": "An example fixed due date schedule",
  "schedules": [
    {
      "from": "2017-08-18T17:00:00Z",
      "to": "2017-12-14T17:00:00Z",
      "due": "2018-01-25T17:00:00Z"
    },
    {
      "from": "2018-08-17T17:00:00Z",
      "to": "2018-12-15T17:00:00Z",
      "due": "2018-01-23T17:00:00Z"
    }
  ]
}

Response 204

Item successfully updated

Response 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 fixed-due-date-schedule -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"fixed-due-date-schedule not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Response 501

Not implemented yet

DELETE /fixed-due-date-schedule-storage/fixed-due-date-schedules/{fixedDueDateScheduleId}

Delete fixed-due-date-schedule item with given {fixed-due-date-scheduleId}

DELETE /fixed-due-date-schedule-storage/fixed-due-date-schedules/{fixedDueDateScheduleId}
URI Parameters
  • fixedDueDateScheduleId: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

Item deleted successfully

Response 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 fixed-due-date-schedule -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"fixed-due-date-schedule not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

Response 501

Not implemented yet