http://github.com/org/folio/mod-users
This documents the API calls that can be made to query and manage proxy relationships for users
Collection of proxiesfor items.
Return a list of all proxy relationships
GET /proxiesfor
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
How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
none
Skip over a number of elements by specifying an offset value for the query
Example:
0
Limit the number of elements returned in the response
Example:
10
Returns a list of proxiesfor items
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",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ProxyFor Schema",
"description": "A proxy for a user",
"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": {
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"type": "object",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"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}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"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}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false
}
},
"totalRecords": {
"type": "integer",
"description": "Estimated or exact total number of records, see https://github.com/folio-org/raml-module-builder#estimated-totalrecords for details"
}
},
"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
}
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.
Media type: text/plain
Type: any
Example:
unable to list proxiesfor -- malformed parameter 'query', syntax error at column 6
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list proxiesfor -- unauthorized
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Create a proxyFor relationship
POST /proxiesfor
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": {
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"type": "object",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"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}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"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}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false
}
Example:
{
"id": "e22cd63e-a9a0-4ef8-b8a3-b2e2522fda93",
"userId": "dfeb378d-165f-43c6-8b53-204c2151fc63",
"proxyUserId": "f394a414-25dd-4a08-88d2-abc534c516cc"
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created proxiesfor item
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"
}
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.
Media type: text/plain
Type: any
Example:
"unable to add proxiesfor -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create proxiesfor -- unauthorized
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "errors.schema",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "error.schema",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "parameters.schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"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"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Retrieve proxiesfor item with given {proxiesforId}
GET /proxiesfor/{id}
Returns item with a given ID
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": {
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"type": "object",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"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}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"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}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false
}
Example:
{
"id": "e22cd63e-a9a0-4ef8-b8a3-b2e2522fda93",
"userId": "dfeb378d-165f-43c6-8b53-204c2151fc63",
"proxyUserId": "f394a414-25dd-4a08-88d2-abc534c516cc"
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"proxiesfor not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Delete proxiesfor item with given {proxiesforId}
DELETE /proxiesfor/{id}
Item deleted successfully
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.
Media type: text/plain
Type: any
Example:
"unable to delete proxiesfor -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"proxiesfor not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Update proxiesfor item with given {proxiesforId}
PUT /proxiesfor/{id}
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": {
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"type": "object",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"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}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"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}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false
}
Example:
{
"id": "e22cd63e-a9a0-4ef8-b8a3-b2e2522fda93",
"userId": "dfeb378d-165f-43c6-8b53-204c2151fc63",
"proxyUserId": "f394a414-25dd-4a08-88d2-abc534c516cc"
}
Item successfully updated
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.
Media type: text/plain
Type: any
Example:
"unable to update proxiesfor -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"proxiesfor not found"
Optimistic locking version conflict
Media type: text/plain
Type: any
Example:
version conflict
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator