| Arguments: | None |
|---|
Returns the name, the version, and the build information for the WebCheckout server. Includes a list of active and inactive modules. Does not require authentication.
POST /rest/session/info HTTP/1.1
{
"headers": {
"Authorization": "Bearer eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0="
},
"postBody": {}
}
HTTP 200
{
"apiVersion": "2.0",
"uri": "/rest/session/info",
"session": {
"id": "S-80082",
"agent": {
"_class": "person",
"oid": 533,
"name": "Super",
"avatar": null,
"lastName": null,
"otherName": "",
"firstName": "Super",
"userid": "adminuser"
},
"checkoutCenter": null,
"organization": null,
"focusAllocation": null,
"editingAllocations": null,
"transientDocuments": null,
"resetTimeout": false,
"resetApproved": false
},
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"session": {
"id": "S-80082",
"agent": {
"_class": "person",
"oid": 533,
"name": "Super",
"avatar": null,
"lastName": null,
"otherName": "",
"firstName": "Super",
"userid": "adminuser"
},
"checkoutCenter": null,
"organization": null,
"focusAllocation": null,
"editingAllocations": null,
"transientDocuments": null,
"resetTimeout": false,
"resetApproved": false
},
"serverTime": "2023-07-07T15:59:54.416940-05:00",
"instanceName": "release",
"webcoVersion": "202307.00",
"features": {
"defaultHideEmptyProperties": true,
"patronPortalShowGroups": true,
"errorTimeout": 5,
"warningTimeout": 2,
"successTimeout": 2,
"attachmentLimit": 104857600,
"globalAdminName": "your WebCheckout administrator",
"globalAdminPhone": null,
"globalAdminEmail": "changeme@example.com",
"allowPasswordReset": true,
"allowOperatorPasswordManagement": true,
"passwordMinimumCharacters": 8,
"patronLogoutUrl": null,
"operatorLogoutUrl": null,
"staffLogoutUrl": null,
"enableRapidReturn": null,
"wcoLite": false,
"deprecatedTimeline": false,
"fees": true,
"messaging": true,
"media": true,
"personnelScheduling": true,
"patronPortal": true,
"rrt": true,
"bundles": true,
"patronIntegration": true,
"courseIntegration": true,
"ticketing": true,
"enterprise": false,
"authentication": true,
"certification": true,
"inventory": true,
"tasks": true,
"greenlighting": true
},
"webcoBuild": "36581_207625421a",
"motd": {
"patronPortal": "",
"WCO": null
},
"patches": null
},
"sessionToken": "eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0=",
"sessionid": "c9928243-c21a-4388-a2c0-ced72e96753d"
}
| Arguments: |
|
|---|
Attempt to authenticate the user userid with a password.
POST /rest/session/start HTTP/1.1
{
"headers": {
"Authorization": "Bearer Requested"
},
"postBody": {
"userid": "adminuser",
"password": "adminadmin"
}
}
HTTP 200
{
"apiVersion": "2.0",
"uri": "/rest/session/start",
"session": {
"id": "S-80046",
"agent": {
"_class": "person",
"oid": 533,
"name": "Super",
"avatar": null,
"lastName": null,
"otherName": "",
"firstName": "Super",
"userid": "adminuser"
},
"checkoutCenter": null,
"organization": null,
"focusAllocation": null,
"editingAllocations": null,
"transientDocuments": null,
"resetTimeout": false,
"resetApproved": false
},
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"capabilities": [
{
"_class": "systemCapability",
"oid": 47,
"name": "Alter System",
"key": "ALTER-SYSTEM"
}
],
"roles": {
"circulatingPatron": null,
"noncirculatingPatron": null,
"operator": [
{
"_class": "checkoutCenter",
"oid": 1,
"name": "WebCheckout",
"organization": {
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
},
"description": null
}
],
"employee": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"staff": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"inventory": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"manager": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"importer": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"facilitiesManager": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"projectsManager": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"admin": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
]
},
"focusAllocation": null,
"editingAllocations": null,
"timezone": "America/Chicago",
"locale": "en_US",
"logoutUri": null,
"timeout": 900,
"expiration": 899,
"twentyFourHourTime": false,
"publicBaseUri": "foo",
"messages": null
},
"sessionToken": "eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiZjY2YzdlYjgtZjVjNi00NTI5LThlZDgtZGU4ZjY5NWY2YTZlIn0=",
"sessionid": "f66c7eb8-f5c6-4529-8ed8-de8f695f6a6e"
}
| Arguments: | None |
|---|
Ends the current users session, unlocking any objects locked to the session.
POST /rest/session/logout HTTP/1.1
{
"headers": {
"Authorization": "Bearer eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiMjdjNzA1YWEtMGMwZC00NTRkLWFlOTgtMTFhYTcxNTlhYmYxIn0="
},
"postBody": {}
}
HTTP 200
{
"apiVersion": "2.0",
"uri": "/rest/session/logout",
"session": {
"id": "S-79932",
"agent": null,
"checkoutCenter": null,
"organization": null,
"focusAllocation": null,
"editingAllocations": null,
"transientDocuments": null,
"resetTimeout": false,
"resetApproved": false
},
"status": "unauthenticated",
"notifications": null,
"alert": null,
"payload": {
"message": "No authenticated session.",
"class": "REST-SERVER:NO-AUTHENTICATED-SESSION"
},
"sessionToken": "eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiMjdjNzA1YWEtMGMwZC00NTRkLWFlOTgtMTFhYTcxNTlhYmYxIn0=",
"sessionid": "27c705aa-0c0d-454d-ae98-11aa7159abf1"
}
| Arguments: | None |
|---|
Return the list of valid roles for the current authenticated user.
POST /rest/session/sessionRoles HTTP/1.1
{
"headers": {
"Authorization": "Bearer eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0="
},
"postBody": {}
}
HTTP 200
{
"apiVersion": "2.0",
"uri": "/rest/session/sessionRoles",
"session": {
"id": "S-80082",
"agent": {
"_class": "person",
"oid": 533,
"name": "Super",
"avatar": null,
"lastName": null,
"otherName": "",
"firstName": "Super",
"userid": "adminuser"
},
"checkoutCenter": null,
"organization": null,
"focusAllocation": null,
"editingAllocations": null,
"transientDocuments": null,
"resetTimeout": false,
"resetApproved": false
},
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"circulatingPatron": null,
"noncirculatingPatron": null,
"operator": [
{
"_class": "checkoutCenter",
"oid": 1,
"name": "WebCheckout",
"organization": {
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
},
"description": null
}
],
"employee": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"staff": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"inventory": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"manager": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"importer": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"facilitiesManager": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"projectsManager": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"admin": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
]
},
"sessionToken": "eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0=",
"sessionid": "c9928243-c21a-4388-a2c0-ced72e96753d"
}
| Arguments: |
|
|---|
Set the current scope for this session.
POST /rest/session/setSessionScope HTTP/1.1
{
"headers": {
"Authorization": "Bearer eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0="
},
"postBody": {
"checkoutCenter": {
"_class": "checkoutCenter",
"oid": 471
}
}
}
HTTP 200
{
"apiVersion": "2.0",
"uri": "/rest/session/setSessionScope",
"session": {
"id": "S-80082",
"agent": {
"_class": "person",
"oid": 533,
"name": "Super",
"avatar": null,
"lastName": null,
"otherName": "",
"firstName": "Super",
"userid": "adminuser"
},
"checkoutCenter": null,
"organization": null,
"focusAllocation": null,
"editingAllocations": null,
"transientDocuments": null,
"resetTimeout": false,
"resetApproved": false
},
"status": "error",
"notifications": null,
"alert": null,
"payload": {
"message": "Failed to deserialize {\"_class\":\"checkoutCenter\",\"oid\":471} as a CHECKOUT-CENTER from json",
"class": "SERIALIZATION:JSON-DESERIALIZATION-ERROR",
"value": {
"_class": "checkoutCenter",
"oid": 471
},
"type": "checkoutCenter",
"protocol": "json"
},
"sessionToken": "eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0=",
"sessionid": "c9928243-c21a-4388-a2c0-ced72e96753d"
}
| Arguments: | None |
|---|
Return information about the current session.
POST /rest/session/currentSession HTTP/1.1
{
"headers": {
"Authorization": "Bearer eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0="
},
"postBody": {}
}
HTTP 200
{
"apiVersion": "2.0",
"uri": "/rest/session/currentSession",
"session": {
"id": "S-80082",
"agent": {
"_class": "person",
"oid": 533,
"name": "Super",
"avatar": null,
"lastName": null,
"otherName": "",
"firstName": "Super",
"userid": "adminuser"
},
"checkoutCenter": null,
"organization": null,
"focusAllocation": null,
"editingAllocations": null,
"transientDocuments": null,
"resetTimeout": false,
"resetApproved": false
},
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"capabilities": [
{
"_class": "systemCapability",
"oid": 47,
"name": "Alter System",
"key": "ALTER-SYSTEM"
}
],
"roles": {
"circulatingPatron": null,
"noncirculatingPatron": null,
"operator": [
{
"_class": "checkoutCenter",
"oid": 1,
"name": "WebCheckout",
"organization": {
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
},
"description": null
}
],
"employee": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"staff": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"inventory": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"manager": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"importer": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"facilitiesManager": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"projectsManager": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
],
"admin": [
{
"_class": "organization",
"oid": 1,
"name": "WebCheckout"
}
]
},
"focusAllocation": null,
"editingAllocations": null,
"timezone": "America/Chicago",
"locale": "en_US",
"logoutUri": null,
"timeout": 900,
"expiration": 899,
"twentyFourHourTime": false,
"publicBaseUri": "foo",
"messages": null
},
"sessionToken": "eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0=",
"sessionid": "c9928243-c21a-4388-a2c0-ced72e96753d"
}
| Arguments: | None |
|---|
Return the servers current time.
POST /rest/session/currentTime HTTP/1.1
{
"headers": {
"Authorization": "Bearer eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0="
},
"postBody": {}
}
HTTP 200
{
"apiVersion": "2.0",
"uri": "/rest/session/currentTime",
"session": {
"id": "S-80082",
"agent": {
"_class": "person",
"oid": 533,
"name": "Super",
"avatar": null,
"lastName": null,
"otherName": "",
"firstName": "Super",
"userid": "adminuser"
},
"checkoutCenter": null,
"organization": null,
"focusAllocation": null,
"editingAllocations": null,
"transientDocuments": null,
"resetTimeout": false,
"resetApproved": false
},
"status": "ok",
"notifications": null,
"alert": null,
"payload": "2023-07-07T15:59:54.436259-05:00",
"sessionToken": "eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0=",
"sessionid": "c9928243-c21a-4388-a2c0-ced72e96753d"
}
| Arguments: |
|
|---|
Return the servers current time. Type is one of the following:
Return the current user's calendar token or null if no token has been granted.
POST /rest/session/currentUserCalendarToken HTTP/1.1
{
"headers": {
"Authorization": "Bearer eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0="
},
"postBody": {
"type": "OPERATOR"
}
}
HTTP 200
{
"apiVersion": "2.0",
"uri": "/rest/session/currentUserCalendarToken",
"session": {
"id": "S-80082",
"agent": {
"_class": "person",
"oid": 533,
"name": "Super",
"avatar": null,
"lastName": null,
"otherName": "",
"firstName": "Super",
"userid": "adminuser"
},
"checkoutCenter": null,
"organization": null,
"focusAllocation": null,
"editingAllocations": null,
"transientDocuments": null,
"resetTimeout": false,
"resetApproved": false
},
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"token": null
},
"sessionToken": "eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0=",
"sessionid": "c9928243-c21a-4388-a2c0-ced72e96753d"
}
| Arguments: | None |
|---|
Return a list of all entities locked in the current session. Currently only allocations are lockable entities. This command name assumes that the set of lockable entites may be expanded in the future.
POST /rest/session/lockedEntities HTTP/1.1
{
"headers": {
"Authorization": "Bearer eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0="
},
"postBody": {}
}
HTTP 200
{
"apiVersion": "2.0",
"uri": "/rest/session/lockedEntities",
"session": {
"id": "S-80082",
"agent": {
"_class": "person",
"oid": 533,
"name": "Super",
"avatar": null,
"lastName": null,
"otherName": "",
"firstName": "Super",
"userid": "adminuser"
},
"checkoutCenter": null,
"organization": null,
"focusAllocation": null,
"editingAllocations": null,
"transientDocuments": null,
"resetTimeout": false,
"resetApproved": false
},
"status": "ok",
"notifications": null,
"alert": null,
"payload": null,
"sessionToken": "eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0=",
"sessionid": "c9928243-c21a-4388-a2c0-ced72e96753d"
}
| Arguments: | None |
|---|
Return a list of all available normal (non-special) namespaces.
POST /rest/session/namespaces HTTP/1.1
{
"headers": {
"Authorization": "Bearer eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0="
},
"postBody": {}
}
HTTP 200
{
"apiVersion": "2.0",
"uri": "/rest/session/namespaces",
"session": {
"id": "S-80082",
"agent": {
"_class": "person",
"oid": 533,
"name": "Super",
"avatar": null,
"lastName": null,
"otherName": "",
"firstName": "Super",
"userid": "adminuser"
},
"checkoutCenter": null,
"organization": null,
"focusAllocation": null,
"editingAllocations": null,
"transientDocuments": null,
"resetTimeout": false,
"resetApproved": false
},
"status": "ok",
"notifications": null,
"alert": null,
"payload": [
{
"name": "systemCapability",
"label": "systemCapability",
"parent": null,
"children": null,
"documentation": "A single capability"
},
{
"name": "systemRole",
"label": "systemRole",
"parent": null,
"children": null,
"documentation": "An operator role"
},
{
"name": "systemRoleCapability",
"label": "systemRoleCapability",
"parent": null,
"children": null,
"documentation": "Joins a capability with a role"
},
{
"name": "personRole",
"label": "personRole",
"parent": null,
"children": null,
"documentation": "Main capability class. (organization_oid, person_oid) must be unique."
},
{
"name": "personRoleCapability",
"label": "personRoleCapability",
"parent": null,
"children": null,
"documentation": "Joins a person-role with zero or more supplemental system-capabilities (beyond those granted by the system role)"
},
{
"name": "personRoleCheckoutCenter",
"label": "personRoleCheckoutCenter",
"parent": null,
"children": null,
"documentation": "Joins a person-role with zero or more checkout-centers."
},
{
"name": "sessionClientInfo",
"label": "sessionClientInfo",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "wcoApplication",
"label": "wcoApplication",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "policyClass",
"label": "policyClass",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "person",
"label": "person",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "locationType",
"label": "locationType",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "location",
"label": "location",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "locationAssignment",
"label": "locationAssignment",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "calendarAuthentication",
"label": "calendarAuthentication",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "hold",
"label": "hold",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "organization",
"label": "organization",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "uniqueIdGenerator",
"label": "uniqueIdGenerator",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "resourceType",
"label": "resourceType",
"parent": null,
"children": [
"keyHook",
"resourceTypeMetaclassLocation",
"resourceTypeMetaclassEquipment",
"resourceTypeMetaclassMedia"
],
"documentation": null
},
{
"name": "resourceTypeFallback",
"label": "resourceTypeFallback",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "resourceTypeRelated",
"label": "resourceTypeRelated",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "resourceTypeCertification",
"label": "resourceTypeCertification",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "rrtBundle",
"label": "rrtBundle",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "bundlePath",
"label": "bundlePath",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "department",
"label": "department",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "departmentCode",
"label": "departmentCode",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "account",
"label": "account",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "checkoutCenter",
"label": "checkoutCenter",
"parent": null,
"children": [
"keyCenter"
],
"documentation": null
},
{
"name": "personCheckoutCenterSignature",
"label": "personCheckoutCenterSignature",
"parent": null,
"children": null,
"documentation": "Maps a (person,checkout-center) pair to date object for the\n purposes of the require-signature-on-file field/property."
},
{
"name": "modelSchedule",
"label": "modelSchedule",
"parent": null,
"children": [
"checkoutCenterModelSchedule"
],
"documentation": "An abstract schedule representing a week long repeating pattern"
},
{
"name": "modelScheduleNode",
"label": "modelScheduleNode",
"parent": null,
"children": null,
"documentation": "A single entry in a model schedule, representing a single abstract period of time between weekly times"
},
{
"name": "checkoutCenterModelSchedule",
"label": "checkoutCenterModelSchedule",
"parent": "modelSchedule",
"children": null,
"documentation": "A model schedule specialised for use by a checkout center."
},
{
"name": "calendar",
"label": "calendar",
"parent": null,
"children": [
"checkoutCenterCalendar",
"organizationCalendar"
],
"documentation": "Base class for tracking the calendar of organizations, checkout centers, and others"
},
{
"name": "calendarLayer",
"label": "calendarLayer",
"parent": null,
"children": [
"holidayScheduleLayer",
"regularScheduleLayer",
"holidayLayer",
"termLayer"
],
"documentation": "A collection of periods of the same rank (z-index). The nodes of layers with higher z-idexes superced those from layers with lower z-indexes where they overlap and both layers do not allow overlaps internally."
},
{
"name": "calendarPeriod",
"label": "calendarPeriod",
"parent": null,
"children": null,
"documentation": "A single period in a single calendar layer, representing the period between two date-times. May or may not be associated with a model schedule depending on the application."
},
{
"name": "organizationCalendar",
"label": "organizationCalendar",
"parent": "calendar",
"children": null,
"documentation": "Calendar specialized to store an organizations term information and holidays"
},
{
"name": "termLayer",
"label": "termLayer",
"parent": "calendarLayer",
"children": null,
"documentation": "Calendar Layer specialide to hold an organizations term information. Terms may not overlap."
},
{
"name": "holidayLayer",
"label": "holidayLayer",
"parent": "calendarLayer",
"children": null,
"documentation": "Calendar Layer specialised to hold an organizations holiday information. Holidays MAY overlap."
},
{
"name": "checkoutCenterCalendar",
"label": "checkoutCenterCalendar",
"parent": "calendar",
"children": null,
"documentation": "A calendar specialzed for tracking the operating hours of a Checkout Center"
},
{
"name": "regularScheduleLayer",
"label": "regularScheduleLayer",
"parent": "calendarLayer",
"children": null,
"documentation": "A calendar layer recording the regular hours of a checkout center"
},
{
"name": "holidayScheduleLayer",
"label": "holidayScheduleLayer",
"parent": "calendarLayer",
"children": null,
"documentation": "A calendar layer that records special (holiday) hours for a checkout center. This layer overrides the regular schedule layer of the cc calendar where they overlap."
},
{
"name": "simultaneitySchedule",
"label": "simultaneitySchedule",
"parent": null,
"children": null,
"documentation": ""
},
{
"name": "simultaneityScheduleNode",
"label": "simultaneityScheduleNode",
"parent": null,
"children": null,
"documentation": ""
},
{
"name": "ldapProfile",
"label": "ldapProfile",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "ldapRule",
"label": "ldapRule",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "authentication",
"label": "authentication",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "transientSessionToken",
"label": "transientSessionToken",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "resource",
"label": "resource",
"parent": null,
"children": [
"key",
"resourceMetaclassLocation",
"resourceMetaclassEquipment",
"resourceMetaclassMedia"
],
"documentation": null
},
{
"name": "circulationRecord",
"label": "circulationRecord",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "circulationPolicy",
"label": "circulationPolicy",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "authset",
"label": "authset",
"parent": null,
"children": null,
"documentation": "Authsets own a list of 0 or more authset entries,\n each of which can hold a resource-type or a checkout-center, or\n another authset from which it inherits further authset entries."
},
{
"name": "authsetAuthset",
"label": "authsetAuthset",
"parent": null,
"children": null,
"documentation": ""
},
{
"name": "authsetResourceType",
"label": "authsetResourceType",
"parent": null,
"children": null,
"documentation": ""
},
{
"name": "authsetCheckoutCenter",
"label": "authsetCheckoutCenter",
"parent": null,
"children": null,
"documentation": ""
},
{
"name": "authsetPath",
"label": "authsetPath",
"parent": null,
"children": null,
"documentation": "The table of authset-paths shows every way to get to\n terminal (tail) container object from any containing authset. The\n things a container directly holds are joined from separate tables."
},
{
"name": "authsetDelegation",
"label": "authsetDelegation",
"parent": null,
"children": null,
"documentation": "Authsets exist in an org, but can be delegated to other orgs for use. Each of these immutable objects has an authset being 'loaned out' for use, an implied loaning group (that of the authset), and an explicit 'loanee' organization. Until we need created/modified/deleted dates explicitly, we'll rely on logging to track changes."
},
{
"name": "section",
"label": "section",
"parent": null,
"children": null,
"documentation": "A group has one authset. A group has one or more\n sections. Sections contain persons via a section_member join table.\n Sections form a partition of the members of a group (no overlap)."
},
{
"name": "sectionMember",
"label": "sectionMember",
"parent": null,
"children": null,
"documentation": "A section-member is a timestamped join from a person\n to a section that contains it. We will track changes in section\n membership via log entries, so we don't need a deleted-date. This\n saves this table from filling with historical data that needs\n periodic pruning."
},
{
"name": "group",
"label": "group",
"parent": null,
"children": null,
"documentation": "A group has one or more sections. Persons belong to\n sections. All persons get their authorization to use resource-types\n through the section they are in, which gets it from the group, which\n gets it from the authset. Due to group import files coming from the\n registrar, who knows nothing about authsets, we have authsets own at\n most one group, rather than the other way around."
},
{
"name": "projectType",
"label": "projectType",
"parent": null,
"children": null,
"documentation": ""
},
{
"name": "projectTemplate",
"label": "projectTemplate",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "projectTemplateRole",
"label": "projectTemplateRole",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "project",
"label": "project",
"parent": null,
"children": null,
"documentation": ""
},
{
"name": "projectRole",
"label": "projectRole",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "station",
"label": "station",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "fileAttachment",
"label": "fileAttachment",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "wcoLog",
"label": "wcoLog",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "requestLog",
"label": "requestLog",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "logEntry",
"label": "logEntry",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "logEntryArgument",
"label": "logEntryArgument",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "logEntryText",
"label": "logEntryText",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "agreementFormConfig",
"label": "agreementFormConfig",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "findConfig",
"label": "findConfig",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "propertySheetConfig",
"label": "propertySheetConfig",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "resourceSchedule",
"label": "resourceSchedule",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "resourceAssignment",
"label": "resourceAssignment",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "allocation",
"label": "allocation",
"parent": null,
"children": null,
"documentation": "Class representing a circulation activity for a collection of resources"
},
{
"name": "allocationLog",
"label": "allocationLog",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "allocationAccompanyingPerson",
"label": "allocationAccompanyingPerson",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "allocationState",
"label": "allocationState",
"parent": null,
"children": null,
"documentation": "class tracking allocation state"
},
{
"name": "allocationItem",
"label": "allocationItem",
"parent": null,
"children": null,
"documentation": "A single item (usually a resource) on an allocation"
},
{
"name": "itemGroup",
"label": "itemGroup",
"parent": null,
"children": null,
"documentation": "The collection of allocation items on an allocation which share the same resource type"
},
{
"name": "allocationContents",
"label": "allocationContents",
"parent": null,
"children": null,
"documentation": "The collection of allocation items on an allocation"
},
{
"name": "allocationItemSupplemental",
"label": "allocationItemSupplemental",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "allocationGroup",
"label": "allocationGroup",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "allocationRepeatRule",
"label": "allocationRepeatRule",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "ticketProblemType",
"label": "ticketProblemType",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "ticketRemedyType",
"label": "ticketRemedyType",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "ticketPriority",
"label": "ticketPriority",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "ticketSeverity",
"label": "ticketSeverity",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "ticketType",
"label": "ticketType",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "ticketResolution",
"label": "ticketResolution",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "vendor",
"label": "vendor",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "ticketExpenseType",
"label": "ticketExpenseType",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "ticketWorkType",
"label": "ticketWorkType",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "ticketLog",
"label": "ticketLog",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "ticket",
"label": "ticket",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "maintenanceType",
"label": "maintenanceType",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "maintenanceSchedule",
"label": "maintenanceSchedule",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "maintenanceEvent",
"label": "maintenanceEvent",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "ticketAssignmentRule",
"label": "ticketAssignmentRule",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "messageType",
"label": "messageType",
"parent": null,
"children": null,
"documentation": "Instances of this are mapped to the actual templates\n used to populate messages."
},
{
"name": "autoEmail",
"label": "autoEmail",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "entityAutoEmail",
"label": "entityAutoEmail",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "emailTemplate",
"label": "emailTemplate",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "emailTemplateSet",
"label": "emailTemplateSet",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "emailTemplateSetTemplate",
"label": "emailTemplateSetTemplate",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "calendarAllocationFields",
"label": "calendarAllocationFields",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "inventory",
"label": "inventory",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "inventoryDefaults",
"label": "inventoryDefaults",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "inventoryItem",
"label": "inventoryItem",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "inventoryNote",
"label": "inventoryNote",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "inventorySelector",
"label": "inventorySelector",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "organizationCreditCardType",
"label": "organizationCreditCardType",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "taxRate",
"label": "taxRate",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "invoice",
"label": "invoice",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "invoiceLine",
"label": "invoiceLine",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "invoiceTaxRate",
"label": "invoiceTaxRate",
"parent": null,
"children": null,
"documentation": "Class that captures what tax-rates are available at time of invoice creation."
},
{
"name": "invoiceLineTaxRate",
"label": "invoiceLineTaxRate",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "accountCredit",
"label": "accountCredit",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "accountDebit",
"label": "accountDebit",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "bibliographicRecord",
"label": "bibliographicRecord",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "holding",
"label": "holding",
"parent": null,
"children": null,
"documentation": "A holding is a join between a physical resource of\n metaclass #!media and a bibliographic-record that describes that\n media."
},
{
"name": "resourceMetaclassMedia",
"label": "resourceMetaclassMedia",
"parent": "resource",
"children": null,
"documentation": ""
},
{
"name": "resourceTypeMetaclassMedia",
"label": "resourceTypeMetaclassMedia",
"parent": "resourceType",
"children": null,
"documentation": ""
},
{
"name": "resourceMetaclassEquipment",
"label": "resourceMetaclassEquipment",
"parent": "resource",
"children": null,
"documentation": ""
},
{
"name": "resourceTypeMetaclassEquipment",
"label": "resourceTypeMetaclassEquipment",
"parent": "resourceType",
"children": null,
"documentation": ""
},
{
"name": "resourceMetaclassLocation",
"label": "resourceMetaclassLocation",
"parent": "resource",
"children": null,
"documentation": ""
},
{
"name": "resourceTypeMetaclassLocation",
"label": "resourceTypeMetaclassLocation",
"parent": "resourceType",
"children": null,
"documentation": ""
},
{
"name": "keyCenter",
"label": "keyCenter",
"parent": "checkoutCenter",
"children": null,
"documentation": ""
},
{
"name": "hookRecord",
"label": "hookRecord",
"parent": null,
"children": null,
"documentation": ""
},
{
"name": "hookLocation",
"label": "hookLocation",
"parent": null,
"children": null,
"documentation": ""
},
{
"name": "keying",
"label": "keying",
"parent": null,
"children": null,
"documentation": ""
},
{
"name": "keyHook",
"label": "keyHook",
"parent": "resourceType",
"children": null,
"documentation": ""
},
{
"name": "keyRecord",
"label": "keyRecord",
"parent": null,
"children": null,
"documentation": ""
},
{
"name": "key",
"label": "key",
"parent": "resource",
"children": null,
"documentation": ""
},
{
"name": "locationAccessHook",
"label": "locationAccessHook",
"parent": null,
"children": null,
"documentation": ""
},
{
"name": "locationKeyAssignmentMap",
"label": "locationKeyAssignmentMap",
"parent": null,
"children": null,
"documentation": ""
},
{
"name": "scheduledMessageHistory",
"label": "scheduledMessageHistory",
"parent": null,
"children": null,
"documentation": "Instances of this entity track the last time a rule\n has RESULTED IN SENDING A MESSAGE for a given entity. We only have\n rules that are one-off or infinitely repeating (until the state of\n the entity changes so that the rule doesn't apply any more), so\n stale entries can eventually be cleared out. We won't worry about\n that here for now."
},
{
"name": "scheduledMessageType",
"label": "scheduledMessageType",
"parent": null,
"children": null,
"documentation": "Instances of this entity combine a name, format,\n entity-class and other query parameters. Taken together, these\n identify what message template should be applied to an instance of\n the entity class to create a message of the appropriate format."
},
{
"name": "scheduledMessageRule",
"label": "scheduledMessageRule",
"parent": null,
"children": null,
"documentation": "Instances of this class are evaluated by selecting\n persisted objects of type and state ,\n and then determining if it's now time to send a message of type\n ."
},
{
"name": "taskType",
"label": "taskType",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "task",
"label": "task",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "taskPerson",
"label": "taskPerson",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "taskProfile",
"label": "taskProfile",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "taskProfileTaskType",
"label": "taskProfileTaskType",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "checkoutCenterDefaultTaskProfile",
"label": "checkoutCenterDefaultTaskProfile",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "jobLog",
"label": "jobLog",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "customConstraint",
"label": "customConstraint",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "customProperty",
"label": "customProperty",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "patronPortalProperty",
"label": "patronPortalProperty",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "patronCustomData",
"label": "patronCustomData",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "integrationLog",
"label": "integrationLog",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "importSession",
"label": "importSession",
"parent": null,
"children": null,
"documentation": "Used to identify log items from one atomic import operation."
},
{
"name": "shift",
"label": "shift",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "schedulingGroup",
"label": "schedulingGroup",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "schedulingGroupMember",
"label": "schedulingGroupMember",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "staffedLocation",
"label": "staffedLocation",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "staffingLimit",
"label": "staffingLimit",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "employee",
"label": "employee",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "staff",
"label": "staff",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "staffAssignment",
"label": "staffAssignment",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "queryFeedConfig",
"label": "queryFeedConfig",
"parent": null,
"children": null,
"documentation": null
},
{
"name": "importTable",
"label": "importTable",
"parent": null,
"children": null,
"documentation": ""
}
],
"sessionToken": "eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0=",
"sessionid": "c9928243-c21a-4388-a2c0-ced72e96753d"
}
| Arguments: | None |
|---|
Return a list of all entities which may be searched using the namespace/search method.
POST /rest/session/searchableEntities HTTP/1.1
{
"headers": {
"Authorization": "Bearer eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0="
},
"postBody": {}
}
HTTP 200
{
"apiVersion": "2.0",
"uri": "/rest/session/searchableEntities",
"session": {
"id": "S-80082",
"agent": {
"_class": "person",
"oid": 533,
"name": "Super",
"avatar": null,
"lastName": null,
"otherName": "",
"firstName": "Super",
"userid": "adminuser"
},
"checkoutCenter": null,
"organization": null,
"focusAllocation": null,
"editingAllocations": null,
"transientDocuments": null,
"resetTimeout": false,
"resetApproved": false
},
"status": "ok",
"notifications": null,
"alert": null,
"payload": [
"account",
"accountCredit",
"accountDebit",
"agreementFormConfig",
"allocation",
"allocationAccompanyingPerson",
"authset",
"authsetAuthset",
"authsetCheckoutCenter",
"authsetDelegation",
"authsetResourceType",
"autoEmail",
"bibliographicRecord",
"calendarAuthentication",
"calendarLayer",
"calendarPeriod",
"checkoutCenter",
"checkoutCenterModelSchedule",
"circulationPolicy",
"customProperty",
"department",
"departmentCode",
"emailTemplate",
"emailTemplateSet",
"emailTemplateSetTemplate",
"employee",
"fileAttachment",
"group",
"holding",
"holidayLayer",
"holidayScheduleLayer",
"hookRecord",
"importSession",
"importTable",
"integrationLog",
"inventory",
"inventoryDefaults",
"inventoryItem",
"inventoryNote",
"inventorySelector",
"invoice",
"invoiceLine",
"jobLog",
"key",
"keyCenter",
"keyHook",
"keyRecord",
"location",
"locationAssignment",
"locationKeyAssignmentMap",
"locationType",
"logEntry",
"logEntryArgument",
"logEntryText",
"maintenanceEvent",
"maintenanceSchedule",
"maintenanceType",
"messageType",
"modelScheduleNode",
"organization",
"patronPortalProperty",
"person",
"personRole",
"policyClass",
"project",
"projectRole",
"projectTemplate",
"projectTemplateRole",
"projectType",
"propertySheetConfig",
"regularScheduleLayer",
"requestLog",
"resource",
"resourceAssignment",
"resourceMetaclassEquipment",
"resourceMetaclassLocation",
"resourceMetaclassMedia",
"resourceSchedule",
"resourceType",
"resourceTypeCertification",
"resourceTypeMetaclassEquipment",
"resourceTypeMetaclassLocation",
"resourceTypeMetaclassMedia",
"scheduledMessageRule",
"scheduledMessageType",
"schedulingGroup",
"section",
"sectionMember",
"shift",
"staff",
"staffAssignment",
"staffedLocation",
"task",
"taskPerson",
"taskProfile",
"taskProfileTaskType",
"taskType",
"termLayer",
"ticket",
"ticketAssignmentRule",
"ticketExpenseType",
"ticketLog",
"ticketPriority",
"ticketProblemType",
"ticketRemedyType",
"ticketResolution",
"ticketSeverity",
"ticketType",
"ticketWorkType",
"uniqueIdGenerator",
"vendor",
"wcoLog"
],
"sessionToken": "eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0=",
"sessionid": "c9928243-c21a-4388-a2c0-ced72e96753d"
}
| Arguments: | None |
|---|
Resets the session expiration value to the session timeout.
POST /rest/session/resetTimeout HTTP/1.1
{
"headers": {
"Authorization": "Bearer eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0="
},
"postBody": {}
}
HTTP 200
{
"apiVersion": "2.0",
"uri": "/rest/session/resetTimeout",
"session": {
"id": "S-80082",
"agent": {
"_class": "person",
"oid": 533,
"name": "Super",
"avatar": null,
"lastName": null,
"otherName": "",
"firstName": "Super",
"userid": "adminuser"
},
"checkoutCenter": null,
"organization": null,
"focusAllocation": null,
"editingAllocations": null,
"transientDocuments": null,
"resetTimeout": false,
"resetApproved": false
},
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"serverTime": "2023-07-07T15:59:54.436568-05:00",
"timeout": 900,
"expiration": 899
},
"sessionToken": "eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0=",
"sessionid": "c9928243-c21a-4388-a2c0-ced72e96753d"
}
| Arguments: | None |
|---|
Will generate an error condition for use in testing.
POST /rest/session/testError HTTP/1.1
{
"headers": {
"Authorization": "Bearer eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0="
}
}
HTTP 500
{
"apiVersion": "2.0",
"uri": "/rest/session/testError",
"session": {
"id": "S-80082",
"agent": {
"_class": "person",
"oid": 533,
"name": "Super",
"avatar": null,
"lastName": null,
"otherName": "",
"firstName": "Super",
"userid": "adminuser"
},
"checkoutCenter": null,
"organization": null,
"focusAllocation": null,
"editingAllocations": null,
"transientDocuments": null,
"resetTimeout": false,
"resetApproved": false
},
"status": "error",
"notifications": null,
"alert": null,
"payload": {
"message": "TEST ERROR",
"class": "COMMON-LISP:SIMPLE-ERROR"
},
"sessionToken": "eyJ0eXBlIjogInNlc3Npb24iLCAidmFsdWUiOiAiYzk5MjgyNDMtYzIxYS00Mzg4LWEyYzAtY2VkNzJlOTY3NTNkIn0=",
"sessionid": "c9928243-c21a-4388-a2c0-ced72e96753d"
}