| 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
{
"sessionid": ""
}
HTTP 200
{
"apiVersion": "0.1",
"session": null,
"status": "ok",
"notifications": null,
"payload": {
"session": null,
"serverTime": "2016-03-04T12:12:09.932407-06:00",
"instanceName": "release",
"webcoVersion": "4.3.0",
"features": {
"mandatoryBarcoding": false,
"fees": true,
"messaging": true,
"media": true,
"personnelScheduling": true,
"patronPortal": true,
"freelancers": true,
"rrt": true,
"bundles": false,
"ticketing": true,
"crestron": true,
"enterprise": false
},
"webcoBuild": "master...origin/master_16522_1d1e15b"
}
}
| Arguments: |
|
|---|
Attempt to authenticate the user userid with a password.
POST rest/session/start
{
"userid": "admin",
"password": "admin",
"sessionid": ""
}
HTTP 200
{
"apiVersion": "0.1",
"session": "S-17899",
"status": "ok",
"notifications": null,
"payload": {
"id": "S-17899",
"uuid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc",
"agent": {
"_class": "person",
"oid": 1,
"name": "Daniel T. Pyne",
"userid": "admin"
},
"systemAuths": null,
"roles": {
"patron": [
{
"_class": "location",
"oid": 1,
"name": "Main",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
}
],
"operator": [
{
"_class": "location",
"oid": 2,
"name": "East",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
},
{
"_class": "location",
"oid": 1,
"name": "Main",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
},
{
"_class": "location",
"oid": 3,
"name": "West",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
}
],
"employee": [
{
"_class": "organization",
"oid": 1,
"name": "Communications"
}
],
"staff": null,
"manager": [
{
"_class": "organization",
"oid": 1,
"name": "Communications"
}
]
},
"checkoutCenter": null,
"organization": null,
"timezone": "America/Chicago",
"locale": "en_US",
"logoutUri": null,
"timeout": 300,
"expiration": 300,
"twentyFourHourTime": false
},
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
| Arguments: | None |
|---|
Ends the current users session, unlocking any objects locked to the session.
POST rest/session/logout
{
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
HTTP 200
{
"apiVersion": "0.1",
"session": "S-17899",
"status": "ok",
"notifications": null,
"payload": {},
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
| Arguments: | None |
|---|
Return the list of valid roles for the current authenticated user.
POST rest/session/sessionRoles
{
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
HTTP 200
{
"apiVersion": "0.1",
"session": "S-17899",
"status": "ok",
"notifications": null,
"payload": {
"patron": [
{
"_class": "location",
"oid": 1,
"name": "Main",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
}
],
"operator": [
{
"_class": "location",
"oid": 2,
"name": "East",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
},
{
"_class": "location",
"oid": 1,
"name": "Main",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
},
{
"_class": "location",
"oid": 3,
"name": "West",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
}
],
"employee": [
{
"_class": "organization",
"oid": 1,
"name": "Communications"
}
],
"staff": null,
"manager": [
{
"_class": "organization",
"oid": 1,
"name": "Communications"
}
]
},
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
| Arguments: |
|
|---|
Set the current location for this session.
POST rest/session/setSessionLocation
{
"checkoutCenter": {
"_class": "location",
"oid": 1
},
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
HTTP 200
{
"apiVersion": "0.1",
"session": "S-17899",
"status": "ok",
"notifications": null,
"payload": {
"id": "S-17899",
"uuid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc",
"agent": {
"_class": "person",
"oid": 1,
"name": "Daniel T. Pyne",
"userid": "admin"
},
"systemAuths": [
[
"OPERATOR",
"role"
],
[
"CIRCULATE",
"role"
],
[
"EDIT-RESERVATIONS",
"role"
],
[
"EMAIL-PATRONS",
"role"
],
[
"ONLINE-OFFLINE",
"role"
],
[
"CHANGE-RESOURCE-LOCATION",
"role"
],
[
"ADD-CONDITION-NOTES",
"role"
],
[
"MANAGE-RTYPES",
"role"
],
[
"MANAGE-AUTHS",
"role"
],
[
"MANAGE-RESOURCES",
"role"
],
[
"PERFORM-INVENTORY",
"role"
],
[
"MANAGE-BIBLIO",
"role"
],
[
"MANAGE-FINES",
"role"
],
[
"MANAGE-PEOPLE",
"role"
],
[
"MANAGE-PIR-ACCESS",
"role"
],
[
"MANAGE-PIR-RESERVATIONS",
"role"
],
[
"MANAGE-LOCATIONS",
"role"
],
[
"MANAGE-EMPLOYEES",
"role"
],
[
"MANAGE-ORGS",
"role"
],
[
"MANAGE-ORGANIZATION",
"role"
],
[
"MANAGE-DEPTS",
"role"
],
[
"MANAGE-TICKETS",
"role"
],
[
"OVERRIDE-MAX-CHECKOUT",
"role"
],
[
"OVERRIDE-RESERVE-PAST",
"role"
],
[
"OVERRIDE-MAX-RENEWALS",
"role"
],
[
"OVERRIDE-USAGE-LIMITS",
"role"
],
[
"OVERRIDE-FINE",
"role"
],
[
"OVERRIDE-HOLD",
"role"
],
[
"OVERRIDE-INACTIVE-PATRON",
"role"
],
[
"OVERRIDE-CHECKOUT-TO-SELF",
"role"
],
[
"OVERRIDE-LATE-RESOURCES",
"role"
],
[
"OVERRIDE-LOCATION-HOURS",
"role"
],
[
"OVERRIDE-OPEN-CLOSE-INTERVALS",
"role"
],
[
"OVERRIDE-RESTRICTED-ORG",
"role"
],
[
"OVERRIDE-RESERVATION-ADVANCE",
"role"
],
[
"OVERRIDE-AUTHORIZATION",
"role"
],
[
"OVERRIDE-MAX-RESOURCES",
"role"
],
[
"OVERRIDE-TURNAROUND",
"role"
],
[
"OVERRIDE-ALLOCATION-LOCK",
"role"
],
[
"MIN-RESERVATION-LEAD-TIME",
"role"
],
[
"BYPASS-PIN",
"role"
],
[
"OVERRIDE-FORBIDDEN-PICKUP-RETURN",
"role"
],
[
"MANAGE-CATALOG",
"role"
],
[
"ALTER-SYSTEM",
"role"
],
[
"CAN-IMPORT",
"role"
],
[
"BACKUP-DATABASE",
"role"
],
[
"MANAGE-ROLES",
"role"
],
[
"MANAGE-FREELANCERS",
"role"
],
[
"SCHEDULE-FREELANCERS",
"role"
],
[
"OVERRIDE-FREELANCER-UNFILLED-ROLES",
"role"
],
[
"OVERRIDE-MAX-SIMULTANEOUS-CIRCULATION-EVENTS",
"role"
],
[
"OVERRIDE-RESOURCE-TYPE-LIMIT-PER-PATRON",
"role"
],
[
"OVERRIDE-PATRON-MAX-RESERVATIONS",
"role"
],
[
"OVERRIDE-MAX-UNSERIALIZED-QTY",
"role"
],
[
"MANAGE-PERSONNEL-SCHEDULING",
"role"
]
],
"roles": {
"patron": [
{
"_class": "location",
"oid": 1,
"name": "Main",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
}
],
"operator": [
{
"_class": "location",
"oid": 2,
"name": "East",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
},
{
"_class": "location",
"oid": 1,
"name": "Main",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
},
{
"_class": "location",
"oid": 3,
"name": "West",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
}
],
"employee": [
{
"_class": "organization",
"oid": 1,
"name": "Communications"
}
],
"staff": null,
"manager": [
{
"_class": "organization",
"oid": 1,
"name": "Communications"
}
]
},
"checkoutCenter": {
"_class": "location",
"oid": 1,
"name": "Main",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
},
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"timezone": "America/Chicago",
"locale": "en_US",
"logoutUri": null,
"timeout": 300,
"expiration": 300,
"twentyFourHourTime": false
},
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
| Arguments: | None |
|---|
Return information about the current session.
POST rest/session/currentSession
{
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
HTTP 200
{
"apiVersion": "0.1",
"session": "S-17899",
"status": "ok",
"notifications": null,
"payload": {
"id": "S-17899",
"uuid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc",
"agent": {
"_class": "person",
"oid": 1,
"name": "Daniel T. Pyne",
"userid": "admin"
},
"systemAuths": [
[
"OPERATOR",
"role"
],
[
"CIRCULATE",
"role"
],
[
"EDIT-RESERVATIONS",
"role"
],
[
"EMAIL-PATRONS",
"role"
],
[
"ONLINE-OFFLINE",
"role"
],
[
"CHANGE-RESOURCE-LOCATION",
"role"
],
[
"ADD-CONDITION-NOTES",
"role"
],
[
"MANAGE-RTYPES",
"role"
],
[
"MANAGE-AUTHS",
"role"
],
[
"MANAGE-RESOURCES",
"role"
],
[
"PERFORM-INVENTORY",
"role"
],
[
"MANAGE-BIBLIO",
"role"
],
[
"MANAGE-FINES",
"role"
],
[
"MANAGE-PEOPLE",
"role"
],
[
"MANAGE-PIR-ACCESS",
"role"
],
[
"MANAGE-PIR-RESERVATIONS",
"role"
],
[
"MANAGE-LOCATIONS",
"role"
],
[
"MANAGE-EMPLOYEES",
"role"
],
[
"MANAGE-ORGS",
"role"
],
[
"MANAGE-ORGANIZATION",
"role"
],
[
"MANAGE-DEPTS",
"role"
],
[
"MANAGE-TICKETS",
"role"
],
[
"OVERRIDE-MAX-CHECKOUT",
"role"
],
[
"OVERRIDE-RESERVE-PAST",
"role"
],
[
"OVERRIDE-MAX-RENEWALS",
"role"
],
[
"OVERRIDE-USAGE-LIMITS",
"role"
],
[
"OVERRIDE-FINE",
"role"
],
[
"OVERRIDE-HOLD",
"role"
],
[
"OVERRIDE-INACTIVE-PATRON",
"role"
],
[
"OVERRIDE-CHECKOUT-TO-SELF",
"role"
],
[
"OVERRIDE-LATE-RESOURCES",
"role"
],
[
"OVERRIDE-LOCATION-HOURS",
"role"
],
[
"OVERRIDE-OPEN-CLOSE-INTERVALS",
"role"
],
[
"OVERRIDE-RESTRICTED-ORG",
"role"
],
[
"OVERRIDE-RESERVATION-ADVANCE",
"role"
],
[
"OVERRIDE-AUTHORIZATION",
"role"
],
[
"OVERRIDE-MAX-RESOURCES",
"role"
],
[
"OVERRIDE-TURNAROUND",
"role"
],
[
"OVERRIDE-ALLOCATION-LOCK",
"role"
],
[
"MIN-RESERVATION-LEAD-TIME",
"role"
],
[
"BYPASS-PIN",
"role"
],
[
"OVERRIDE-FORBIDDEN-PICKUP-RETURN",
"role"
],
[
"MANAGE-CATALOG",
"role"
],
[
"ALTER-SYSTEM",
"role"
],
[
"CAN-IMPORT",
"role"
],
[
"BACKUP-DATABASE",
"role"
],
[
"MANAGE-ROLES",
"role"
],
[
"MANAGE-FREELANCERS",
"role"
],
[
"SCHEDULE-FREELANCERS",
"role"
],
[
"OVERRIDE-FREELANCER-UNFILLED-ROLES",
"role"
],
[
"OVERRIDE-MAX-SIMULTANEOUS-CIRCULATION-EVENTS",
"role"
],
[
"OVERRIDE-RESOURCE-TYPE-LIMIT-PER-PATRON",
"role"
],
[
"OVERRIDE-PATRON-MAX-RESERVATIONS",
"role"
],
[
"OVERRIDE-MAX-UNSERIALIZED-QTY",
"role"
],
[
"MANAGE-PERSONNEL-SCHEDULING",
"role"
]
],
"roles": {
"patron": [
{
"_class": "location",
"oid": 1,
"name": "Main",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
}
],
"operator": [
{
"_class": "location",
"oid": 2,
"name": "East",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
},
{
"_class": "location",
"oid": 1,
"name": "Main",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
},
{
"_class": "location",
"oid": 3,
"name": "West",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
}
],
"employee": [
{
"_class": "organization",
"oid": 1,
"name": "Communications"
}
],
"staff": null,
"manager": [
{
"_class": "organization",
"oid": 1,
"name": "Communications"
}
]
},
"checkoutCenter": {
"_class": "location",
"oid": 1,
"name": "Main",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
},
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"timezone": "America/Chicago",
"locale": "en_US",
"logoutUri": null,
"timeout": 300,
"expiration": 300,
"twentyFourHourTime": false
},
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
| Arguments: | None |
|---|
Return the servers current time.
POST rest/session/currentTime
{
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
HTTP 200
{
"apiVersion": "0.1",
"session": "S-17899",
"status": "ok",
"notifications": null,
"payload": "2016-03-04T12:12:10.702701-06:00",
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
| Arguments: | None |
|---|
Return the current user's calendar token.
POST rest/session/currentUserCalendarToken
{
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
HTTP 200
{
"apiVersion": "0.1",
"session": "S-17899",
"status": "ok",
"notifications": null,
"payload": {
"token": null
},
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
| Arguments: | None |
|---|
Return a list of all entities locked in the current session.
POST rest/session/lockedEntities
{
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
HTTP 200
{
"apiVersion": "0.1",
"session": "S-17899",
"status": "ok",
"notifications": null,
"payload": [
{
"_class": "allocation",
"oid": 5514,
"name": "A-5514",
"id": null,
"action": "RESERVATION",
"state": "RESERVATION",
"returnTime": "2016-03-04T12:12:11.009905-06:00",
"returnOption": "WILL-RETURN",
"pickupTime": "2016-03-04T12:12:11.009904-06:00",
"pickupOption": "WILL-CALL",
"location": {
"_class": "location",
"oid": 1,
"name": "Main",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
},
"patron": {
"_class": "person",
"oid": 1,
"name": "Daniel T. Pyne",
"userid": "admin"
},
"note": null,
"items": [],
"deliveryLocationName": ""
}
],
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
| Arguments: | None |
|---|
Return a list of all available namespaces.
POST rest/session/namespaces
{
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
HTTP 200
{
"apiVersion": "0.1",
"session": "S-17899",
"status": "ok",
"notifications": null,
"payload": [
{
"name": "authset",
"label": "authset",
"documentation": "Main authorization class. (organization_oid, person_oid) must be unique."
},
{
"name": "authsetLocation",
"label": "authsetLocation",
"documentation": "Joins an authset with zero or more locations."
},
{
"name": "operatorRole",
"label": "operatorRole",
"documentation": "An operator role (these should match what is present in *default-roles*)"
},
{
"name": "operatorAuthorization",
"label": "operatorAuthorization",
"documentation": "An operator authorization (these should match what is present in *default-roles*)"
},
{
"name": "authsetAuthorization",
"label": "authsetAuthorization",
"documentation": "Joins an authset with zero or more supplemental authorizations (beyond those granted by the the authset's roles)"
},
{
"name": "wcoApplication",
"label": "wcoApplication",
"documentation": null
},
{
"name": "integrationLog",
"label": "integrationLog",
"documentation": null
},
{
"name": "patronClass",
"label": "patronClass",
"documentation": null
},
{
"name": "person",
"label": "person",
"documentation": null
},
{
"name": "personLocationSignature",
"label": "personLocationSignature",
"documentation": "Maps a (person,location) pair to date object for the\n purposes of the require-signature-on-file field/property."
},
{
"name": "personRole",
"label": "personRole",
"documentation": null
},
{
"name": "calendarAuthentication",
"label": "calendarAuthentication",
"documentation": null
},
{
"name": "hold",
"label": "hold",
"documentation": null
},
{
"name": "organization",
"label": "organization",
"documentation": null
},
{
"name": "resourceType",
"label": "resourceType",
"documentation": null
},
{
"name": "resourceTypeFallback",
"label": "resourceTypeFallback",
"documentation": null
},
{
"name": "rrtBundle",
"label": "rrtBundle",
"documentation": null
},
{
"name": "rtypeView",
"label": "rtypeView",
"documentation": null
},
{
"name": "rtypeViewAuthorized",
"label": "rtypeViewAuthorized",
"documentation": null
},
{
"name": "taxRate",
"label": "taxRate",
"documentation": null
},
{
"name": "role",
"label": "role",
"documentation": null
},
{
"name": "department",
"label": "department",
"documentation": null
},
{
"name": "departmentCode",
"label": "departmentCode",
"documentation": null
},
{
"name": "accountCode",
"label": "accountCode",
"documentation": null
},
{
"name": "term",
"label": "term",
"documentation": null
},
{
"name": "location",
"label": "location",
"documentation": null
},
{
"name": "locationSchedule",
"label": "locationSchedule",
"documentation": null
},
{
"name": "locationScheduleNode",
"label": "locationScheduleNode",
"documentation": null
},
{
"name": "ldapProfile",
"label": "ldapProfile",
"documentation": null
},
{
"name": "ldapRule",
"label": "ldapRule",
"documentation": null
},
{
"name": "authentication",
"label": "authentication",
"documentation": null
},
{
"name": "resource",
"label": "resource",
"documentation": null
},
{
"name": "circulationPolicy",
"label": "circulationPolicy",
"documentation": null
},
{
"name": "resourceSchedule",
"label": "resourceSchedule",
"documentation": null
},
{
"name": "jobLog",
"label": "jobLog",
"documentation": null
},
{
"name": "group",
"label": "group",
"documentation": null
},
{
"name": "groupSet",
"label": "groupSet",
"documentation": null
},
{
"name": "groupSetMember",
"label": "groupSetMember",
"documentation": null
},
{
"name": "groupMember",
"label": "groupMember",
"documentation": null
},
{
"name": "groupAuthorization",
"label": "groupAuthorization",
"documentation": null
},
{
"name": "groupResourceType",
"label": "groupResourceType",
"documentation": null
},
{
"name": "station",
"label": "station",
"documentation": null
},
{
"name": "allocation",
"label": "allocation",
"documentation": "Class representing a circulation activity for a collection of resources"
},
{
"name": "allocationLog",
"label": "allocationLog",
"documentation": null
},
{
"name": "allocationPerson",
"label": "allocationPerson",
"documentation": null
},
{
"name": "allocationItemBuildingPass",
"label": "allocationItemBuildingPass",
"documentation": null
},
{
"name": "allocationRepeatRule",
"label": "allocationRepeatRule",
"documentation": null
},
{
"name": "allocationGroup",
"label": "allocationGroup",
"documentation": null
},
{
"name": "allocationTask",
"label": "allocationTask",
"documentation": null
},
{
"name": "allocationReminderInterval",
"label": "allocationReminderInterval",
"documentation": null
},
{
"name": "fileAttachment",
"label": "fileAttachment",
"documentation": null
},
{
"name": "wcoLog",
"label": "wcoLog",
"documentation": null
},
{
"name": "requestLog",
"label": "requestLog",
"documentation": null
},
{
"name": "mailEvent",
"label": "mailEvent",
"documentation": null
},
{
"name": "agreementFormConfig",
"label": "agreementFormConfig",
"documentation": null
},
{
"name": "pirPersonLocation",
"label": "pirPersonLocation",
"documentation": null
},
{
"name": "ticketProblemType",
"label": "ticketProblemType",
"documentation": null
},
{
"name": "ticketRemedyType",
"label": "ticketRemedyType",
"documentation": null
},
{
"name": "ticketLog",
"label": "ticketLog",
"documentation": null
},
{
"name": "ticket",
"label": "ticket",
"documentation": null
},
{
"name": "locationAutoEmail",
"label": "locationAutoEmail",
"documentation": null
},
{
"name": "calendarAllocationFields",
"label": "calendarAllocationFields",
"documentation": null
},
{
"name": "locationPirPickupOption",
"label": "locationPirPickupOption",
"documentation": null
},
{
"name": "turndown",
"label": "turndown",
"documentation": null
},
{
"name": "inventoryEvent",
"label": "inventoryEvent",
"documentation": null
},
{
"name": "invoice",
"label": "invoice",
"documentation": null
},
{
"name": "organizationCreditCardType",
"label": "organizationCreditCardType",
"documentation": null
},
{
"name": "invoiceLine",
"label": "invoiceLine",
"documentation": null
},
{
"name": "invoiceTaxRate",
"label": "invoiceTaxRate",
"documentation": "Class that captures what tax-rates are available at time of invoice creation."
},
{
"name": "invoiceLineTaxRate",
"label": "invoiceLineTaxRate",
"documentation": null
},
{
"name": "invoicesPendingExport",
"label": "invoicesPendingExport",
"documentation": null
},
{
"name": "bibliographicRecord",
"label": "bibliographicRecord",
"documentation": null
},
{
"name": "holding",
"label": "holding",
"documentation": null
},
{
"name": "freelancerPersonLocation",
"label": "freelancerPersonLocation",
"documentation": null
},
{
"name": "bibliographicRecordHelix",
"label": "bibliographicRecordHelix",
"documentation": "A class mapping bibliographic records to Helix Licensing Server\nclips, using the bibliographic record object ID and the Helix content key and GUID."
},
{
"name": "resourceController",
"label": "resourceController",
"documentation": null
},
{
"name": "allocationRoute",
"label": "allocationRoute",
"documentation": null
},
{
"name": "allocationRouteMessage",
"label": "allocationRouteMessage",
"documentation": null
},
{
"name": "bibliographicRecordExt",
"label": "bibliographicRecordExt",
"documentation": null
},
{
"name": "resourceExt",
"label": "resourceExt",
"documentation": null
},
{
"name": "resourceTypeExt",
"label": "resourceTypeExt",
"documentation": null
},
{
"name": "personExt",
"label": "personExt",
"documentation": null
},
{
"name": "groupExt",
"label": "groupExt",
"documentation": null
},
{
"name": "groupMemberExt",
"label": "groupMemberExt",
"documentation": null
},
{
"name": "accountCodeExt",
"label": "accountCodeExt",
"documentation": null
},
{
"name": "departmentExt",
"label": "departmentExt",
"documentation": null
},
{
"name": "pirAuthExt",
"label": "pirAuthExt",
"documentation": null
},
{
"name": "importSession",
"label": "importSession",
"documentation": "Used to identify log items from one atomic import operation."
},
{
"name": "allocationFreelancer",
"label": "allocationFreelancer",
"documentation": null
},
{
"name": "allocationFreelancerRole",
"label": "allocationFreelancerRole",
"documentation": null
},
{
"name": "allocationFreelancerAssigned",
"label": "allocationFreelancerAssigned",
"documentation": null
},
{
"name": "allocationStaffing",
"label": "allocationStaffing",
"documentation": null
},
{
"name": "shift",
"label": "shift",
"documentation": null
},
{
"name": "schedulingGroup",
"label": "schedulingGroup",
"documentation": null
},
{
"name": "schedulingGroupMember",
"label": "schedulingGroupMember",
"documentation": null
},
{
"name": "staffedLocation",
"label": "staffedLocation",
"documentation": null
},
{
"name": "staffingLimit",
"label": "staffingLimit",
"documentation": null
},
{
"name": "staff",
"label": "staff",
"documentation": null
},
{
"name": "staffAssignment",
"label": "staffAssignment",
"documentation": null
},
{
"name": "staffAvailability",
"label": "staffAvailability",
"documentation": null
}
],
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
| Arguments: | None |
|---|
Return a list of all entities which may be searched using the namespace/search method.
POST rest/session/searchableEntities
{
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
HTTP 200
{
"apiVersion": "0.1",
"session": "S-17899",
"status": "ok",
"notifications": null,
"payload": [
"accountCode",
"agreementFormConfig",
"allocation",
"allocationTask",
"bibliographicRecord",
"department",
"group",
"holding",
"inventoryEvent",
"invoice",
"invoiceLine",
"jobLog",
"location",
"organization",
"person",
"requestLog",
"resource",
"resourceSchedule",
"resourceType",
"schedulingGroup",
"shift",
"staff",
"staffAssignment",
"staffAvailability",
"staffedLocation",
"ticket",
"turndown",
"wcoLog"
],
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
| Arguments: | None |
|---|
Resets the session expiration value to the session timeout.
POST rest/session/resetTimeout
{
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
HTTP 200
{
"apiVersion": "0.1",
"session": "S-17899",
"status": "ok",
"notifications": null,
"payload": {
"serverTime": "2016-03-04T12:12:11.672979-06:00",
"timeout": 300,
"expiration": 300
},
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
| Arguments: | None |
|---|
Will generate an error condition for use in testing.
POST rest/session/testError
{
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
HTTP 500
{
"apiVersion": "0.1",
"session": "S-17899",
"status": "error",
"notifications": null,
"payload": {
"message": "TEST ERROR",
"backtrace": "Backtrace for: #\n0: ((LAMBDA NIL :IN SB-DEBUG::FUNCALL-WITH-DEBUG-IO-SYNTAX))\n1: (SB-IMPL::CALL-WITH-SANE-IO-SYNTAX #)\n2: (SB-IMPL::%WITH-STANDARD-IO-SYNTAX #)\n3: (SB-DEBUG:PRINT-BACKTRACE :STREAM # :START 0 :FROM :DEBUGGER-FRAME :COUNT 4611686018427387903 :PRINT-THREAD T :PRINT-FRAME-SOURCE NIL :METHOD-FRAME-STYLE NIL)\n4: ((:METHOD REST-SERVER::REST-ERROR-AS-JSON (ERROR)) #) [fast-method]\n5: ((FLET REST-SERVER::RETURN-ERROR :IN HUNCHENTOOT:ACCEPTOR-DISPATCH-REQUEST) #)\n6: (SIGNAL #)\n7: (ERROR \"TEST ERROR\")\n8: ((LAMBDA NIL :IN WCOF::PERFORM))\n9: (WCOF::CALL-WITHOUT-AUTHORIZATION-CHECKING #)\n10: ((LAMBDA (WCOF::FRAMEWORK-TRANSACTION) :IN WCOF::PERFORM) #)\n11: (POSTMODERN::CALL-WITH-TRANSACTION #)\n12: (POSTMODERN::CALL-WITH-LOGICAL-TRANSACTION WCOF::FRAMEWORK-TRANSACTION #)\n13: ((LAMBDA NIL :IN WCOF::PERFORM))\n14: (WCOF::CALL-WITH-DATABASE-CONNECTION # #)\n15: (WCOF::CALL-WITH-POOLED-DATABASE #)\n16: ((:METHOD WCOF::PERFORM (REST-SERVER::TEST-ERROR)) #) [fast-method]\n17: (REST-SERVER::TEST-ERROR)\n18: ((:METHOD REST-SERVER::%INVOKE-FRAMEWORK-COMMAND (HUNCHENTOOT:REQUEST T T)) # # REST-SERVER::TEST-ERROR) [fast-method]\n19: ((:METHOD REST-SERVER::INVOKE-FRAMEWORK-COMMAND (HUNCHENTOOT:REQUEST T T)) # \"SESSION\" \"TEST-ERROR\") [fast-method]\n20: ((:METHOD REST-SERVER::%DISPATCH-METHOD-REQUEST (HUNCHENTOOT:REQUEST)) #) [fast-method]\n21: ((:METHOD HUNCHENTOOT:ACCEPTOR-DISPATCH-REQUEST (REST-SERVER::REST-ACCEPTOR HUNCHENTOOT:REQUEST)) # #) [fast-method]\n22: ((FLET CALL-NEXT-METHOD :IN \"/home/lee/vc/web-co/webco/src/lisp/rest-server/acceptor.lisp\"))\n23: ((LAMBDA NIL :IN HUNCHENTOOT:ACCEPTOR-DISPATCH-REQUEST))\n24: (WCOF::CALL-WITH-CACHED-CONTENTS #)\n25: ((FLET #:DEBUGGABLE-HANDLER-BIND-BODY62 :IN HUNCHENTOOT:ACCEPTOR-DISPATCH-REQUEST))\n26: ((LAMBDA NIL :IN HUNCHENTOOT:ACCEPTOR-DISPATCH-REQUEST))\n27: (WCOF::CALL-WITH-DATABASE-CONNECTION # #)\n28: (WCOF::CALL-WITH-POOLED-DATABASE #)\n29: ((:METHOD HUNCHENTOOT:ACCEPTOR-DISPATCH-REQUEST :AROUND (REST-SERVER::REST-ACCEPTOR HUNCHENTOOT:REQUEST)) # #) [fast-method]\n30: ((:METHOD HUNCHENTOOT:HANDLE-REQUEST (HUNCHENTOOT:ACCEPTOR HUNCHENTOOT:REQUEST)) # #) [fast-method]\n31: ((:METHOD HUNCHENTOOT:PROCESS-REQUEST (T)) #) [fast-method]\n32: ((SB-PCL::GF-DISPATCH HUNCHENTOOT:PROCESS-REQUEST) #)\n33: ((LAMBDA NIL :IN HUNCHENTOOT:PROCESS-CONNECTION))\n34: (HUNCHENTOOT::DO-WITH-ACCEPTOR-REQUEST-COUNT-INCREMENTED # #)\n35: ((:METHOD HUNCHENTOOT:PROCESS-CONNECTION (HUNCHENTOOT:ACCEPTOR T)) # #) [fast-method]\n36: ((FLET CALL-NEXT-METHOD :IN \"/home/lee/vc/web-co/webco/lib/lisp/hunchentoot_1.2.17/acceptor.lisp\"))\n37: ((:METHOD HUNCHENTOOT:PROCESS-CONNECTION :AROUND (HUNCHENTOOT:ACCEPTOR T)) # #) [fast-method]\n38: ((FLET HUNCHENTOOT::PROCESS-CONNECTION% :IN HUNCHENTOOT::HANDLE-INCOMING-CONNECTION%) # #)\n39: ((:METHOD HUNCHENTOOT::HANDLE-INCOMING-CONNECTION% (HUNCHENTOOT:ONE-THREAD-PER-CONNECTION-TASKMASTER T)) # #) [fast-method]\n40: ((LAMBDA NIL :IN HUNCHENTOOT:CREATE-REQUEST-HANDLER-THREAD))\n41: ((LAMBDA NIL :IN BORDEAUX-THREADS::BINDING-DEFAULT-SPECIALS))\n42: ((FLET #:WITHOUT-INTERRUPTS-BODY-1120 :IN SB-THREAD::INITIAL-THREAD-FUNCTION-TRAMPOLINE))\n43: ((FLET SB-THREAD::WITH-MUTEX-THUNK :IN SB-THREAD::INITIAL-THREAD-FUNCTION-TRAMPOLINE))\n44: ((FLET #:WITHOUT-INTERRUPTS-BODY-537 :IN SB-THREAD::CALL-WITH-MUTEX))\n45: (SB-THREAD::CALL-WITH-MUTEX # #> NIL T NIL)\n46: (SB-THREAD::INITIAL-THREAD-FUNCTION-TRAMPOLINE # #S(SB-THREAD:SEMAPHORE :NAME \"Thread setup semaphore\" :%COUNT 0 :WAITCOUNT 0 :MUTEX # :QUEUE #) # NIL NIL NIL NIL)\n47: (\"foreign function: call_into_lisp\")\n48: (\"foreign function: new_thread_trampoline\")\n",
"class": "COMMON-LISP:SIMPLE-ERROR"
},
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
| Arguments: |
|
|---|
Retrieve a single configuration by name.
POST rest/configuration/getConfig
{
"guid": "find-all-checkouts",
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}
HTTP 200
{
"apiVersion": "0.1",
"session": "S-17899",
"status": "ok",
"notifications": null,
"payload": {
"guid": "find-all-checkouts",
"name": "All Checkouts",
"entityType": "allocation",
"default": null,
"description": "",
"autoRun": true,
"autoHideTerms": null,
"defaultSort": {
"property": "endTime",
"direction": "asc"
},
"helpText": [
"You can use this form to find checkouts and reservations. After you've found your checkout or reservation, you can select it to return it, pick it up, edit it, or delete it"
],
"helpLinks": [
{
"link": "wco?method=rapid-return",
"label": "Use the rapid return form to quickly return checked out resources",
"visible": true
}
],
"actions": null,
"properties": [
{
"property": "identity",
"visible": true
},
{
"property": "patron",
"visible": true
},
{
"property": "originalAgent",
"visible": true
},
{
"property": "realStartTime",
"visible": true
},
{
"property": "endTime",
"visible": true
}
],
"summary": [
{
"property": "allocationContentsSummary",
"displayHint": "allocationContentsSummary",
"type": "hashtable"
}
],
"resultSummary": null,
"terms": [
{
"term": "identity",
"visible": true
},
{
"term": "center",
"initialValue": "!location",
"visible": true
},
{
"term": "state",
"initialValue": [
"CHECKOUT",
"CHECKOUT-COMPLETED"
],
"visible": true
},
{
"term": "patron",
"visible": true
},
{
"term": "resource",
"visible": true
},
{
"term": "eventDescription",
"visible": true
},
{
"term": "idIsNull",
"initialValue": null,
"visible": true
}
]
},
"sessionid": "42033093-7a5a-4f24-97cf-e17ce16cb8dc"
}