Proxies For (v0.1)

http://github.com/org/folio/mod-users

Table of contents

mod-users Proxy For API

This documents the API calls that can be made to query and manage proxy relationships for users

/proxiesfor

Collection of proxiesfor items.

GET /proxiesfor

Return a list of all proxy relationships

GET /proxiesfor
Query Parameters
  • 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=aaa
  • 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
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns a list of proxiesfor items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Collection of user proxies",
  "properties": {
    "proxiesFor": {
      "description": "List of user proxy items",
      "type": "array",
      "id": "proxyFor",
      "items": {
        "type": "object",
        "$ref": "proxyfor.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "proxiesFor",
    "totalRecords"
  ]
}

Example:

{
  "proxiesFor": [
    {
      "id": "e22cd63e-a9a0-4ef8-b8a3-b2e2522fda93",
      "userId": "dfeb378d-165f-43c6-8b53-204c2151fc63",
      "proxyUserId": "f394a414-25dd-4a08-88d2-abc534c516cc"
    }
  ],
  "totalRecords": 1
}

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 proxiesfor -- 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 proxiesfor -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /proxiesfor

Create a proxyFor relationship

POST /proxiesfor
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#",
  "title": "ProxyFor Schema",
  "description": "A proxy for a user",
  "type": "object",
  "properties": {
    "userId": {
      "description": "The id of the user for whom this proxy pertains",
      "type": "string"
    },
    "proxyUserId": {
      "description": "The id of the user acting as the proxy",
      "type": "string"
    },
    "id": {
      "description": "A UUID identifying this proxy relationship",
      "type": "string"
    },
    "requestForSponsor": {
      "description": "Can the user request a sponsor (yes/no)",
      "type": "string"
    },
    "createdDate": {
      "description": "Deprecated",
      "type": "string",
      "format": "date-time"
    },
    "notificationsTo": {
      "description": "Where notifications are sent",
      "type": "string"
    },
    "accrueTo": {
      "description": "Where fees and fines accrue",
      "type": "string"
    },
    "status": {
      "description": "Active or Inactive",
      "type": "string"
    },
    "expirationDate": {
      "description": "The date this proxy relationship expires",
      "type": "string",
      "format": "date-time"
    },
    "metadata" : {
      "$ref" : "raml-util/schemas/metadata.schema",
      "readonly" : true
    }
  },
  "additionalProperties": false
}

Example:

{
  "id": "e22cd63e-a9a0-4ef8-b8a3-b2e2522fda93",
  "userId": "dfeb378d-165f-43c6-8b53-204c2151fc63",
  "proxyUserId": "f394a414-25dd-4a08-88d2-abc534c516cc"
}

Response 201

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

Headers
  • Location: required (string)

    URI to the created proxiesfor item

Body

Media type: application/json

Type: any

Example:

{
  "id": "e22cd63e-a9a0-4ef8-b8a3-b2e2522fda93",
  "userId": "dfeb378d-165f-43c6-8b53-204c2151fc63",
  "proxyUserId": "f394a414-25dd-4a08-88d2-abc534c516cc"
}

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 proxiesfor -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create proxiesfor -- unauthorized

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "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

GET /proxiesfor/{id}

Retrieve proxiesfor item with given {proxiesforId}

GET /proxiesfor/{id}
URI Parameters
  • id: 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#",
  "title": "ProxyFor Schema",
  "description": "A proxy for a user",
  "type": "object",
  "properties": {
    "userId": {
      "description": "The id of the user for whom this proxy pertains",
      "type": "string"
    },
    "proxyUserId": {
      "description": "The id of the user acting as the proxy",
      "type": "string"
    },
    "id": {
      "description": "A UUID identifying this proxy relationship",
      "type": "string"
    },
    "requestForSponsor": {
      "description": "Can the user request a sponsor (yes/no)",
      "type": "string"
    },
    "createdDate": {
      "description": "Deprecated",
      "type": "string",
      "format": "date-time"
    },
    "notificationsTo": {
      "description": "Where notifications are sent",
      "type": "string"
    },
    "accrueTo": {
      "description": "Where fees and fines accrue",
      "type": "string"
    },
    "status": {
      "description": "Active or Inactive",
      "type": "string"
    },
    "expirationDate": {
      "description": "The date this proxy relationship expires",
      "type": "string",
      "format": "date-time"
    },
    "metadata" : {
      "$ref" : "raml-util/schemas/metadata.schema",
      "readonly" : true
    }
  },
  "additionalProperties": false
}

Example:

{
  "id": "e22cd63e-a9a0-4ef8-b8a3-b2e2522fda93",
  "userId": "dfeb378d-165f-43c6-8b53-204c2151fc63",
  "proxyUserId": "f394a414-25dd-4a08-88d2-abc534c516cc"
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"proxiesfor 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

DELETE /proxiesfor/{id}

Delete proxiesfor item with given {proxiesforId}

DELETE /proxiesfor/{id}
URI Parameters
  • id: 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 proxiesfor -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"proxiesfor 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

PUT /proxiesfor/{id}

Update proxiesfor item with given {proxiesforId}

PUT /proxiesfor/{id}
URI Parameters
  • id: 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#",
  "title": "ProxyFor Schema",
  "description": "A proxy for a user",
  "type": "object",
  "properties": {
    "userId": {
      "description": "The id of the user for whom this proxy pertains",
      "type": "string"
    },
    "proxyUserId": {
      "description": "The id of the user acting as the proxy",
      "type": "string"
    },
    "id": {
      "description": "A UUID identifying this proxy relationship",
      "type": "string"
    },
    "requestForSponsor": {
      "description": "Can the user request a sponsor (yes/no)",
      "type": "string"
    },
    "createdDate": {
      "description": "Deprecated",
      "type": "string",
      "format": "date-time"
    },
    "notificationsTo": {
      "description": "Where notifications are sent",
      "type": "string"
    },
    "accrueTo": {
      "description": "Where fees and fines accrue",
      "type": "string"
    },
    "status": {
      "description": "Active or Inactive",
      "type": "string"
    },
    "expirationDate": {
      "description": "The date this proxy relationship expires",
      "type": "string",
      "format": "date-time"
    },
    "metadata" : {
      "$ref" : "raml-util/schemas/metadata.schema",
      "readonly" : true
    }
  },
  "additionalProperties": false
}

Example:

{
  "id": "e22cd63e-a9a0-4ef8-b8a3-b2e2522fda93",
  "userId": "dfeb378d-165f-43c6-8b53-204c2151fc63",
  "proxyUserId": "f394a414-25dd-4a08-88d2-abc534c516cc"
}

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 proxiesfor -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"proxiesfor 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