With few exceptions (see Special Namespaces) each namespace in the API is related to a single framework class.
WCO entities are serailized to JSON as objects. When beign sent from the API to the consumer these objects have, at a minimum, the following three values.
The name of the WCOF Entity's class as a string
The unique object id of this instance of the class
A meaningful string name for this instance. Note that even those entities that don't have a defined name property will have a value in this field. That value will simply be a string version of the lisp written value of the entity and is subject to change.
Entities are serialized using a minimal set of properties or a more extensive set of properties depending on the request and the level of nesting. Since entities may have other entities as their properties it is more efficient to limit the number of properties the nested entites contain.
Some classes include additional fields in their minimal serialization. These, along with the more expanded serializations are documented for each entity in the API Reference that is available on each WebChecheckout instance.
When sending an entity back to the API the consumer may exclude the name property. Historically when the API expected a specific type of entity the consumer could just pass in the oid of the entity in place of the object. This practice is deprecated and should not be used in any new interfaces.
To get the standard serialization of an object you call get in the appropriate namespace (See Namespace) and specify the oid of the object you want to retrieve.
POST rest/person/get
{
"oid": 1,
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/get",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"_class": "person",
"oid": 1,
"name": "John Q. Admin",
"userid": "admin",
"barcode": "12345"
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
You may also specify specific properties to be included in the serialization as a property template. Doing so overrides the default serializations with the exception of the three properties mentioned above (_class, oid, name). For details on property templates see the Property Templates section below.
POST rest/person/get
{
"oid": 1,
"properties": [
"street",
"street2",
"city",
"state",
"telephone",
"email"
],
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/get",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"_class": "person",
"oid": 1,
"name": "John Q. Admin",
"email": null,
"telephone": null,
"state": null,
"city": null,
"street2": null,
"street": null
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
To allow for the retrieval of multiple entities without requiring multiple requests, you may also supply an array of oids, with or without properties.
POST rest/person/get
{
"oid": [
1000,
1001,
1002
],
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/get",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": [
{
"_class": "person",
"oid": 1000,
"name": "Brian Villanueva",
"userid": "056474",
"barcode": null
},
{
"_class": "person",
"oid": 1001,
"name": "Karen Palermo",
"userid": "023688",
"barcode": null
},
{
"_class": "person",
"oid": 1002,
"name": "Oswaldo Jenks",
"userid": "068999",
"barcode": null
}
],
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
Providing an invalid oid will result in an error
Not all entities can be created directly, many are the result of other operations in the API. Where they may be directly created, the namespace will contain a "new" command
For example, the following details the creation of a new resource type.
POST rest/resourceType/new
{
"name": "Brand New Type 476576653",
"parent": null,
"rtid": "476576653",
"organization": {
"_class": "organization",
"oid": 1
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/resourceType/new",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"_class": "resourceType",
"oid": 4805,
"name": "Brand New Type 476576653"
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
Entities are edited by posting new property values to the update command of the namespace. Update accepts the oid of the object being updated, and the set of new property values.
POST rest/resource/update
{
"oid": 1897,
"values": {
"description": "This is my description"
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/resource/update",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"_class": "resource",
"oid": 1897,
"name": "Playback Deck 01",
"circulating": true,
"statusString": "Available",
"barcode": null
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
As with retrieving, the oid argument for update may be an array of OIDs. The API will apply the edit to each of the entities. The entities must be of the same type.
Deleting of entities is generally forbidden in the API. When allowed, the namespace will contain a delete command.
Details on all properties exported for a particular entity type can be retrieved using the namespace properties call
For each property the results include:
the label to be used for display purposes to name the property
The name of the property
the framework type of the property
If true, the property expects and returns an array of the above type
A hint for the proper rendering of the value (see Hints).
A boolean telling you if queries may be sorted using this property.
Is this property intended to be a user meaningful result in a search. This field is advisory only.
When defined, information about the constrained values the property will accept. For details see constraints in Special Namespaces
The constraint value, listing all posible values, is deprecated and will be removed in a future version of the API
A plain-text description of the property
Can this property be read
Authorization required to read the property
Can this property be written to
Authorization required to write a new value to the property
By default, all wcof entity types have three defined properties:
the object oid of the specific entity.
the framework type (class) name of the entity
a property on an object which simply returns the object itself.
The full list of properties for each namespace is listed in the the API Reference that is available on each WebChecheckout instance.
POST rest/checkoutCenter/properties
{
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/checkoutCenter/properties",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": [
{
"label": "_Class",
"property": "_class",
"displayHint": "string",
"resultColumn": null,
"type": "string",
"multipleValues": false,
"documentation": "The object's class name as a string",
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": false,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Oid",
"property": "oid",
"displayHint": "integer",
"resultColumn": null,
"type": "integer",
"multipleValues": false,
"documentation": "The object's unique identifier",
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": false,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Checkout Center",
"property": "identity",
"displayHint": "identity",
"resultColumn": true,
"type": "checkoutCenter",
"multipleValues": false,
"documentation": "The object itself",
"readable": true,
"readAuth": null,
"writable": false,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Name",
"property": "name",
"displayHint": "string",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": "the unique name for this checkout-center",
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Description",
"property": "description",
"displayHint": "string",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Default Allocation Times",
"property": "defaultAllocationTimes",
"displayHint": "defaultAllocationTimes",
"resultColumn": true,
"type": "defaultAllocationTimes",
"multipleValues": false,
"documentation": "Reader defaults to org's value if self's slot is\n nil. Writer sets the slot because any psheet or other js widget\n displaying a value will show self's effective value. If self's\n slot is already set, this acts as expected -- you see that value\n and change that value. If self's slot is nil, you see the org's\n value, and either (a) the org value is fine and you won't try to\n set a value at the checkout center, (b) the org value is not fine\n and you enter an override at the checkout center level, or (c) the\n org value is fine and you enter the same value anyway. The first\n two work as expected, and in the third, we can either set the slot\n value so it continues to override if the org value changes, OR do\n nothing so that the checkout-center continues to inherit. For now\n we'll only write the value if we're replacing a nil with something\n not already equal to the value inherited from the org level. Some\n day we might want to use a display like for policy values that\n inherit.",
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Messaging From Address",
"property": "messagingFromAddress",
"displayHint": "string",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": "The From: address for email from this checkout-center. If the address entered contains only whitespace, the organization's :messaging-from-address is returned.",
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Messaging From Address Slot",
"property": "messagingFromAddressSlot",
"displayHint": "string",
"resultColumn": null,
"type": "string",
"multipleValues": false,
"documentation": "slot-value of messaging-from-address -- needed by UI",
"readable": true,
"readAuth": null,
"writable": false,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Reply To Address",
"property": "replyToAddress",
"displayHint": "string",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": "where to send replies to email",
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Reply To Address Slot",
"property": "replyToAddressSlot",
"displayHint": "string",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": "slot value of reply-to-address -- needed by UI",
"readable": true,
"readAuth": null,
"writable": false,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Renewal Limit",
"property": "renewalLimit",
"displayHint": "integer",
"resultColumn": true,
"type": "integer",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": false,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Managing Organization",
"property": "organization",
"displayHint": "entity",
"resultColumn": true,
"type": "organization",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Default Delivery Type",
"property": "defaultDeliveryType",
"displayHint": "selectBox",
"resultColumn": true,
"type": "tag",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": "deliveryType",
"constraintClass": "orderedSet",
"constraint": [
{
"value": "NORMAL",
"label": "Normal"
},
{
"value": "FULL-DAY",
"label": "Full Day"
}
]
},
{
"label": "Default Resource Selector",
"property": "defaultResourceSelector",
"displayHint": "selectBox",
"resultColumn": true,
"type": "tag",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": "resourceSelector",
"constraintClass": "orderedSet",
"constraint": [
{
"value": "RESOURCE-TYPE",
"label": "By Resource Type"
},
{
"value": "HOME-LOCATION",
"label": "By Home Location"
}
]
},
{
"label": "Timeline Zoom Factor",
"property": "timelineZoomFactor",
"displayHint": "selectBox",
"resultColumn": true,
"type": "integer",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": "timelineZoomFactor",
"constraintClass": "orderedSet",
"constraint": [
{
"value": 0,
"label": "0"
},
{
"value": 1,
"label": "1"
},
{
"value": 2,
"label": "2"
},
{
"value": 3,
"label": "3"
},
{
"value": 4,
"label": "4"
},
{
"value": 5,
"label": "5"
},
{
"value": 6,
"label": "6"
},
{
"value": 7,
"label": "7"
},
{
"value": 8,
"label": "8"
}
]
},
{
"label": "Timeline Granularity",
"property": "timelineGranularity",
"displayHint": "integer",
"resultColumn": true,
"type": "integer",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Show Resource Timelines",
"property": "showResourceTimelines",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Building",
"property": "building",
"displayHint": "string",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Room Number",
"property": "room",
"displayHint": "string",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Address",
"property": "address",
"displayHint": "string",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Telephone",
"property": "telephone",
"displayHint": "string",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Default Printer Queue",
"property": "printQueue",
"displayHint": "string",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Allocation Mode",
"property": "allocationMode",
"displayHint": "selectBox",
"resultColumn": true,
"type": "tag",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": "allocationMode",
"constraintClass": "orderedSet",
"constraint": [
{
"value": "SHOPPING-CART",
"label": "Shopping Cart"
},
{
"value": "TIMELINE",
"label": "Timeline Scheduler"
}
]
},
{
"label": "Billing Contact",
"property": "billingContactName",
"displayHint": "string",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Billing Contact Telephone",
"property": "billingContactPhone",
"displayHint": "string",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Billing Contact Email",
"property": "billingContactEmail",
"displayHint": "string",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Email Template Set",
"property": "emailTemplateSet",
"displayHint": "entitySelectBox",
"resultColumn": true,
"type": "emailTemplateSet",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": "emailTemplateSets",
"constraintClass": "dynamicOrderedSet",
"constraint": [
{
"value": null,
"label": "(default)"
}
]
},
{
"label": "Print Template Set",
"property": "printTemplateSet",
"displayHint": "selectBox",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": "printTemplateSet",
"constraintClass": "dynamicOrderedSet",
"constraint": [
{
"value": "(default)",
"label": "(default)"
}
]
},
{
"label": "Usage Day Rollover",
"property": "usageDayRollover",
"displayHint": "wallTime",
"resultColumn": null,
"type": "wallTime",
"multipleValues": false,
"documentation": "The beginning of a day for usage purposes",
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Billing Day Rollover",
"property": "billingDayRollover",
"displayHint": "wallTime",
"resultColumn": null,
"type": "wallTime",
"multipleValues": false,
"documentation": "The beginning of a day for billing purposes. Note that null has special meaning",
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Exclude Closed Time From Usage",
"property": "usageExcludeClosed",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Exclude Closed Time From Fee Calculation",
"property": "feesExcludeClosed",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Exclude Closed Time From Fine Calculation",
"property": "finesExcludeClosed",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Copy Set/Strike People on All Notifications",
"property": "ccSetStrike",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": "send CC email to set and strike people",
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Suppress Patron Emails on Set/Strike Allocations",
"property": "suppressSetStrikeEmailToPatron",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": "Suppress email to patron, accompanying people and contact person for allocation emails when the pickup/return options are set and/or strike, and it's relevant to the email.",
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Patron Portal New Reservation Notification",
"property": "patronPortalEmailNotification",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": "send email about patron portal new reservations",
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Patron Portal Notification Email Address",
"property": "patronPortalNotificationEmailAddress",
"displayHint": "string",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": "address to send emails to, about new patron portal reservations",
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Patron Portal Help Link",
"property": "patronPortalHelpLink",
"displayHint": "string",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": "link to use in place of the default for patron portal help",
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Copy Reporting Patron on Help Desk Ticket Notifications",
"property": "ccReportingPatron",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": "Send email to ticket's reporting patron.",
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Require Signature On File",
"property": "requireSignatureOnFile",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Require Scan To Pickup",
"property": "forceBarcodeScanning",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Allow Rrt Pickup",
"property": "allowRrtPickup",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Allow Rrt Autoassignment",
"property": "allowRrtAutoassignment",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Require Scan To Return",
"property": "requireScanToReturn",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Allow Return All",
"property": "allowReturnAll",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Form Date And Time Format",
"property": "formDateTimeFormat",
"displayHint": "selectBox",
"resultColumn": true,
"type": "tag",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": "dateTimeFormat",
"constraintClass": "dynamicOrderedSet",
"constraint": [
{
"value": "DAYTIME+WEEKDAY",
"label": "Wednesday, 7/3/2019, 10:17 AM"
},
{
"value": "DAYTIME",
"label": "7/3/2019, 10:17 AM"
},
{
"value": "ISO+TIME",
"label": "2019-07-03 10:17:12"
}
]
},
{
"label": "Agreement Form Item Sorting",
"property": "agreementFormSorting",
"displayHint": "selectBox",
"resultColumn": true,
"type": "tag",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": "agreementFormSorting",
"constraintClass": "orderedSet",
"constraint": [
{
"value": "ROOT-RESOURCE-TYPE",
"label": "By root resource type"
},
{
"value": "RESOURCE-TYPE",
"label": "By resource type"
},
{
"value": "NAME",
"label": "By resource ID"
}
]
},
{
"label": "Agreement Form Item Grouping",
"property": "agreementFormGrouping",
"displayHint": "selectBox",
"resultColumn": true,
"type": "tag",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": "agreementFormGrouping",
"constraintClass": "orderedSet",
"constraint": [
{
"value": "NONE",
"label": "No grouping"
},
{
"value": "UNSERIALIZED",
"label": "Group unserialized resources"
}
]
},
{
"label": "Use Customizable Agreement Form",
"property": "customAgreementFormOid",
"displayHint": "selectBox",
"resultColumn": true,
"type": "integer",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Timezone",
"property": "timezone",
"displayHint": "selectBox",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": false,
"constraintName": "timezones",
"constraintClass": "dynamicOrderedSet",
"constraint": [
{
"value": "Africa/Abidjan",
"label": "Africa/Abidjan"
},
{
"value": "Africa/Accra",
"label": "Africa/Accra"
},
{
"value": "Africa/Addis_Ababa",
"label": "Africa/Addis_Ababa"
},
{
"value": "Africa/Algiers",
"label": "Africa/Algiers"
},
{
"value": "Africa/Asmara",
"label": "Africa/Asmara"
},
{
"value": "Africa/Asmera",
"label": "Africa/Asmera"
},
{
"value": "Africa/Bamako",
"label": "Africa/Bamako"
},
{
"value": "Africa/Bangui",
"label": "Africa/Bangui"
},
{
"value": "Africa/Banjul",
"label": "Africa/Banjul"
},
{
"value": "Africa/Bissau",
"label": "Africa/Bissau"
},
{
"value": "Africa/Blantyre",
"label": "Africa/Blantyre"
},
{
"value": "Africa/Brazzaville",
"label": "Africa/Brazzaville"
},
{
"value": "Africa/Bujumbura",
"label": "Africa/Bujumbura"
},
{
"value": "Africa/Cairo",
"label": "Africa/Cairo"
},
{
"value": "Africa/Casablanca",
"label": "Africa/Casablanca"
},
{
"value": "Africa/Ceuta",
"label": "Africa/Ceuta"
},
{
"value": "Africa/Conakry",
"label": "Africa/Conakry"
},
{
"value": "Africa/Dakar",
"label": "Africa/Dakar"
},
{
"value": "Africa/Dar_es_Salaam",
"label": "Africa/Dar_es_Salaam"
},
{
"value": "Africa/Djibouti",
"label": "Africa/Djibouti"
},
{
"value": "Africa/Douala",
"label": "Africa/Douala"
},
{
"value": "Africa/El_Aaiun",
"label": "Africa/El_Aaiun"
},
{
"value": "Africa/Freetown",
"label": "Africa/Freetown"
},
{
"value": "Africa/Gaborone",
"label": "Africa/Gaborone"
},
{
"value": "Africa/Harare",
"label": "Africa/Harare"
},
{
"value": "Africa/Johannesburg",
"label": "Africa/Johannesburg"
},
{
"value": "Africa/Juba",
"label": "Africa/Juba"
},
{
"value": "Africa/Kampala",
"label": "Africa/Kampala"
},
{
"value": "Africa/Khartoum",
"label": "Africa/Khartoum"
},
{
"value": "Africa/Kigali",
"label": "Africa/Kigali"
},
{
"value": "Africa/Kinshasa",
"label": "Africa/Kinshasa"
},
{
"value": "Africa/Lagos",
"label": "Africa/Lagos"
},
{
"value": "Africa/Libreville",
"label": "Africa/Libreville"
},
{
"value": "Africa/Lome",
"label": "Africa/Lome"
},
{
"value": "Africa/Luanda",
"label": "Africa/Luanda"
},
{
"value": "Africa/Lubumbashi",
"label": "Africa/Lubumbashi"
},
{
"value": "Africa/Lusaka",
"label": "Africa/Lusaka"
},
{
"value": "Africa/Malabo",
"label": "Africa/Malabo"
},
{
"value": "Africa/Maputo",
"label": "Africa/Maputo"
},
{
"value": "Africa/Maseru",
"label": "Africa/Maseru"
},
{
"value": "Africa/Mbabane",
"label": "Africa/Mbabane"
},
{
"value": "Africa/Mogadishu",
"label": "Africa/Mogadishu"
},
{
"value": "Africa/Monrovia",
"label": "Africa/Monrovia"
},
{
"value": "Africa/Nairobi",
"label": "Africa/Nairobi"
},
{
"value": "Africa/Ndjamena",
"label": "Africa/Ndjamena"
},
{
"value": "Africa/Niamey",
"label": "Africa/Niamey"
},
{
"value": "Africa/Nouakchott",
"label": "Africa/Nouakchott"
},
{
"value": "Africa/Ouagadougou",
"label": "Africa/Ouagadougou"
},
{
"value": "Africa/Porto-Novo",
"label": "Africa/Porto-Novo"
},
{
"value": "Africa/Sao_Tome",
"label": "Africa/Sao_Tome"
},
{
"value": "Africa/Timbuktu",
"label": "Africa/Timbuktu"
},
{
"value": "Africa/Tripoli",
"label": "Africa/Tripoli"
},
{
"value": "Africa/Tunis",
"label": "Africa/Tunis"
},
{
"value": "Africa/Windhoek",
"label": "Africa/Windhoek"
},
{
"value": "America/Adak",
"label": "America/Adak"
},
{
"value": "America/Anchorage",
"label": "America/Anchorage"
},
{
"value": "America/Anguilla",
"label": "America/Anguilla"
},
{
"value": "America/Antigua",
"label": "America/Antigua"
},
{
"value": "America/Araguaina",
"label": "America/Araguaina"
},
{
"value": "America/Argentina/Buenos_Aires",
"label": "America/Argentina/Buenos_Aires"
},
{
"value": "America/Argentina/Catamarca",
"label": "America/Argentina/Catamarca"
},
{
"value": "America/Argentina/ComodRivadavia",
"label": "America/Argentina/ComodRivadavia"
},
{
"value": "America/Argentina/Cordoba",
"label": "America/Argentina/Cordoba"
},
{
"value": "America/Argentina/Jujuy",
"label": "America/Argentina/Jujuy"
},
{
"value": "America/Argentina/La_Rioja",
"label": "America/Argentina/La_Rioja"
},
{
"value": "America/Argentina/Mendoza",
"label": "America/Argentina/Mendoza"
},
{
"value": "America/Argentina/Rio_Gallegos",
"label": "America/Argentina/Rio_Gallegos"
},
{
"value": "America/Argentina/Salta",
"label": "America/Argentina/Salta"
},
{
"value": "America/Argentina/San_Juan",
"label": "America/Argentina/San_Juan"
},
{
"value": "America/Argentina/San_Luis",
"label": "America/Argentina/San_Luis"
},
{
"value": "America/Argentina/Tucuman",
"label": "America/Argentina/Tucuman"
},
{
"value": "America/Argentina/Ushuaia",
"label": "America/Argentina/Ushuaia"
},
{
"value": "America/Aruba",
"label": "America/Aruba"
},
{
"value": "America/Asuncion",
"label": "America/Asuncion"
},
{
"value": "America/Atikokan",
"label": "America/Atikokan"
},
{
"value": "America/Atka",
"label": "America/Atka"
},
{
"value": "America/Bahia",
"label": "America/Bahia"
},
{
"value": "America/Bahia_Banderas",
"label": "America/Bahia_Banderas"
},
{
"value": "America/Barbados",
"label": "America/Barbados"
},
{
"value": "America/Belem",
"label": "America/Belem"
},
{
"value": "America/Belize",
"label": "America/Belize"
},
{
"value": "America/Blanc-Sablon",
"label": "America/Blanc-Sablon"
},
{
"value": "America/Boa_Vista",
"label": "America/Boa_Vista"
},
{
"value": "America/Bogota",
"label": "America/Bogota"
},
{
"value": "America/Boise",
"label": "America/Boise"
},
{
"value": "America/Buenos_Aires",
"label": "America/Buenos_Aires"
},
{
"value": "America/Cambridge_Bay",
"label": "America/Cambridge_Bay"
},
{
"value": "America/Campo_Grande",
"label": "America/Campo_Grande"
},
{
"value": "America/Cancun",
"label": "America/Cancun"
},
{
"value": "America/Caracas",
"label": "America/Caracas"
},
{
"value": "America/Catamarca",
"label": "America/Catamarca"
},
{
"value": "America/Cayenne",
"label": "America/Cayenne"
},
{
"value": "America/Cayman",
"label": "America/Cayman"
},
{
"value": "America/Chicago",
"label": "America/Chicago"
},
{
"value": "America/Chihuahua",
"label": "America/Chihuahua"
},
{
"value": "America/Coral_Harbour",
"label": "America/Coral_Harbour"
},
{
"value": "America/Cordoba",
"label": "America/Cordoba"
},
{
"value": "America/Costa_Rica",
"label": "America/Costa_Rica"
},
{
"value": "America/Creston",
"label": "America/Creston"
},
{
"value": "America/Cuiaba",
"label": "America/Cuiaba"
},
{
"value": "America/Curacao",
"label": "America/Curacao"
},
{
"value": "America/Danmarkshavn",
"label": "America/Danmarkshavn"
},
{
"value": "America/Dawson",
"label": "America/Dawson"
},
{
"value": "America/Dawson_Creek",
"label": "America/Dawson_Creek"
},
{
"value": "America/Denver",
"label": "America/Denver"
},
{
"value": "America/Detroit",
"label": "America/Detroit"
},
{
"value": "America/Dominica",
"label": "America/Dominica"
},
{
"value": "America/Edmonton",
"label": "America/Edmonton"
},
{
"value": "America/Eirunepe",
"label": "America/Eirunepe"
},
{
"value": "America/El_Salvador",
"label": "America/El_Salvador"
},
{
"value": "America/Ensenada",
"label": "America/Ensenada"
},
{
"value": "America/Fort_Nelson",
"label": "America/Fort_Nelson"
},
{
"value": "America/Fort_Wayne",
"label": "America/Fort_Wayne"
},
{
"value": "America/Fortaleza",
"label": "America/Fortaleza"
},
{
"value": "America/Glace_Bay",
"label": "America/Glace_Bay"
},
{
"value": "America/Godthab",
"label": "America/Godthab"
},
{
"value": "America/Goose_Bay",
"label": "America/Goose_Bay"
},
{
"value": "America/Grand_Turk",
"label": "America/Grand_Turk"
},
{
"value": "America/Grenada",
"label": "America/Grenada"
},
{
"value": "America/Guadeloupe",
"label": "America/Guadeloupe"
},
{
"value": "America/Guatemala",
"label": "America/Guatemala"
},
{
"value": "America/Guayaquil",
"label": "America/Guayaquil"
},
{
"value": "America/Guyana",
"label": "America/Guyana"
},
{
"value": "America/Halifax",
"label": "America/Halifax"
},
{
"value": "America/Havana",
"label": "America/Havana"
},
{
"value": "America/Hermosillo",
"label": "America/Hermosillo"
},
{
"value": "America/Indiana/Indianapolis",
"label": "America/Indiana/Indianapolis"
},
{
"value": "America/Indiana/Knox",
"label": "America/Indiana/Knox"
},
{
"value": "America/Indiana/Marengo",
"label": "America/Indiana/Marengo"
},
{
"value": "America/Indiana/Petersburg",
"label": "America/Indiana/Petersburg"
},
{
"value": "America/Indiana/Tell_City",
"label": "America/Indiana/Tell_City"
},
{
"value": "America/Indiana/Vevay",
"label": "America/Indiana/Vevay"
},
{
"value": "America/Indiana/Vincennes",
"label": "America/Indiana/Vincennes"
},
{
"value": "America/Indiana/Winamac",
"label": "America/Indiana/Winamac"
},
{
"value": "America/Indianapolis",
"label": "America/Indianapolis"
},
{
"value": "America/Inuvik",
"label": "America/Inuvik"
},
{
"value": "America/Iqaluit",
"label": "America/Iqaluit"
},
{
"value": "America/Jamaica",
"label": "America/Jamaica"
},
{
"value": "America/Jujuy",
"label": "America/Jujuy"
},
{
"value": "America/Juneau",
"label": "America/Juneau"
},
{
"value": "America/Kentucky/Louisville",
"label": "America/Kentucky/Louisville"
},
{
"value": "America/Kentucky/Monticello",
"label": "America/Kentucky/Monticello"
},
{
"value": "America/Knox_IN",
"label": "America/Knox_IN"
},
{
"value": "America/Kralendijk",
"label": "America/Kralendijk"
},
{
"value": "America/La_Paz",
"label": "America/La_Paz"
},
{
"value": "America/Lima",
"label": "America/Lima"
},
{
"value": "America/Los_Angeles",
"label": "America/Los_Angeles"
},
{
"value": "America/Louisville",
"label": "America/Louisville"
},
{
"value": "America/Lower_Princes",
"label": "America/Lower_Princes"
},
{
"value": "America/Maceio",
"label": "America/Maceio"
},
{
"value": "America/Managua",
"label": "America/Managua"
},
{
"value": "America/Manaus",
"label": "America/Manaus"
},
{
"value": "America/Marigot",
"label": "America/Marigot"
},
{
"value": "America/Martinique",
"label": "America/Martinique"
},
{
"value": "America/Matamoros",
"label": "America/Matamoros"
},
{
"value": "America/Mazatlan",
"label": "America/Mazatlan"
},
{
"value": "America/Mendoza",
"label": "America/Mendoza"
},
{
"value": "America/Menominee",
"label": "America/Menominee"
},
{
"value": "America/Merida",
"label": "America/Merida"
},
{
"value": "America/Metlakatla",
"label": "America/Metlakatla"
},
{
"value": "America/Mexico_City",
"label": "America/Mexico_City"
},
{
"value": "America/Miquelon",
"label": "America/Miquelon"
},
{
"value": "America/Moncton",
"label": "America/Moncton"
},
{
"value": "America/Monterrey",
"label": "America/Monterrey"
},
{
"value": "America/Montevideo",
"label": "America/Montevideo"
},
{
"value": "America/Montreal",
"label": "America/Montreal"
},
{
"value": "America/Montserrat",
"label": "America/Montserrat"
},
{
"value": "America/Nassau",
"label": "America/Nassau"
},
{
"value": "America/New_York",
"label": "America/New_York"
},
{
"value": "America/Nipigon",
"label": "America/Nipigon"
},
{
"value": "America/Nome",
"label": "America/Nome"
},
{
"value": "America/Noronha",
"label": "America/Noronha"
},
{
"value": "America/North_Dakota/Beulah",
"label": "America/North_Dakota/Beulah"
},
{
"value": "America/North_Dakota/Center",
"label": "America/North_Dakota/Center"
},
{
"value": "America/North_Dakota/New_Salem",
"label": "America/North_Dakota/New_Salem"
},
{
"value": "America/Ojinaga",
"label": "America/Ojinaga"
},
{
"value": "America/Panama",
"label": "America/Panama"
},
{
"value": "America/Pangnirtung",
"label": "America/Pangnirtung"
},
{
"value": "America/Paramaribo",
"label": "America/Paramaribo"
},
{
"value": "America/Phoenix",
"label": "America/Phoenix"
},
{
"value": "America/Port-au-Prince",
"label": "America/Port-au-Prince"
},
{
"value": "America/Port_of_Spain",
"label": "America/Port_of_Spain"
},
{
"value": "America/Porto_Acre",
"label": "America/Porto_Acre"
},
{
"value": "America/Porto_Velho",
"label": "America/Porto_Velho"
},
{
"value": "America/Puerto_Rico",
"label": "America/Puerto_Rico"
},
{
"value": "America/Punta_Arenas",
"label": "America/Punta_Arenas"
},
{
"value": "America/Rainy_River",
"label": "America/Rainy_River"
},
{
"value": "America/Rankin_Inlet",
"label": "America/Rankin_Inlet"
},
{
"value": "America/Recife",
"label": "America/Recife"
},
{
"value": "America/Regina",
"label": "America/Regina"
},
{
"value": "America/Resolute",
"label": "America/Resolute"
},
{
"value": "America/Rio_Branco",
"label": "America/Rio_Branco"
},
{
"value": "America/Rosario",
"label": "America/Rosario"
},
{
"value": "America/Santa_Isabel",
"label": "America/Santa_Isabel"
},
{
"value": "America/Santarem",
"label": "America/Santarem"
},
{
"value": "America/Santiago",
"label": "America/Santiago"
},
{
"value": "America/Santo_Domingo",
"label": "America/Santo_Domingo"
},
{
"value": "America/Sao_Paulo",
"label": "America/Sao_Paulo"
},
{
"value": "America/Scoresbysund",
"label": "America/Scoresbysund"
},
{
"value": "America/Shiprock",
"label": "America/Shiprock"
},
{
"value": "America/Sitka",
"label": "America/Sitka"
},
{
"value": "America/St_Barthelemy",
"label": "America/St_Barthelemy"
},
{
"value": "America/St_Johns",
"label": "America/St_Johns"
},
{
"value": "America/St_Kitts",
"label": "America/St_Kitts"
},
{
"value": "America/St_Lucia",
"label": "America/St_Lucia"
},
{
"value": "America/St_Thomas",
"label": "America/St_Thomas"
},
{
"value": "America/St_Vincent",
"label": "America/St_Vincent"
},
{
"value": "America/Swift_Current",
"label": "America/Swift_Current"
},
{
"value": "America/Tegucigalpa",
"label": "America/Tegucigalpa"
},
{
"value": "America/Thule",
"label": "America/Thule"
},
{
"value": "America/Thunder_Bay",
"label": "America/Thunder_Bay"
},
{
"value": "America/Tijuana",
"label": "America/Tijuana"
},
{
"value": "America/Toronto",
"label": "America/Toronto"
},
{
"value": "America/Tortola",
"label": "America/Tortola"
},
{
"value": "America/Vancouver",
"label": "America/Vancouver"
},
{
"value": "America/Virgin",
"label": "America/Virgin"
},
{
"value": "America/Whitehorse",
"label": "America/Whitehorse"
},
{
"value": "America/Winnipeg",
"label": "America/Winnipeg"
},
{
"value": "America/Yakutat",
"label": "America/Yakutat"
},
{
"value": "America/Yellowknife",
"label": "America/Yellowknife"
},
{
"value": "Antarctica/Casey",
"label": "Antarctica/Casey"
},
{
"value": "Antarctica/Davis",
"label": "Antarctica/Davis"
},
{
"value": "Antarctica/DumontDUrville",
"label": "Antarctica/DumontDUrville"
},
{
"value": "Antarctica/Macquarie",
"label": "Antarctica/Macquarie"
},
{
"value": "Antarctica/Mawson",
"label": "Antarctica/Mawson"
},
{
"value": "Antarctica/McMurdo",
"label": "Antarctica/McMurdo"
},
{
"value": "Antarctica/Palmer",
"label": "Antarctica/Palmer"
},
{
"value": "Antarctica/Rothera",
"label": "Antarctica/Rothera"
},
{
"value": "Antarctica/South_Pole",
"label": "Antarctica/South_Pole"
},
{
"value": "Antarctica/Syowa",
"label": "Antarctica/Syowa"
},
{
"value": "Antarctica/Troll",
"label": "Antarctica/Troll"
},
{
"value": "Antarctica/Vostok",
"label": "Antarctica/Vostok"
},
{
"value": "Arctic/Longyearbyen",
"label": "Arctic/Longyearbyen"
},
{
"value": "Asia/Aden",
"label": "Asia/Aden"
},
{
"value": "Asia/Almaty",
"label": "Asia/Almaty"
},
{
"value": "Asia/Amman",
"label": "Asia/Amman"
},
{
"value": "Asia/Anadyr",
"label": "Asia/Anadyr"
},
{
"value": "Asia/Aqtau",
"label": "Asia/Aqtau"
},
{
"value": "Asia/Aqtobe",
"label": "Asia/Aqtobe"
},
{
"value": "Asia/Ashgabat",
"label": "Asia/Ashgabat"
},
{
"value": "Asia/Ashkhabad",
"label": "Asia/Ashkhabad"
},
{
"value": "Asia/Atyrau",
"label": "Asia/Atyrau"
},
{
"value": "Asia/Baghdad",
"label": "Asia/Baghdad"
},
{
"value": "Asia/Bahrain",
"label": "Asia/Bahrain"
},
{
"value": "Asia/Baku",
"label": "Asia/Baku"
},
{
"value": "Asia/Bangkok",
"label": "Asia/Bangkok"
},
{
"value": "Asia/Barnaul",
"label": "Asia/Barnaul"
},
{
"value": "Asia/Beirut",
"label": "Asia/Beirut"
},
{
"value": "Asia/Bishkek",
"label": "Asia/Bishkek"
},
{
"value": "Asia/Brunei",
"label": "Asia/Brunei"
},
{
"value": "Asia/Calcutta",
"label": "Asia/Calcutta"
},
{
"value": "Asia/Chita",
"label": "Asia/Chita"
},
{
"value": "Asia/Choibalsan",
"label": "Asia/Choibalsan"
},
{
"value": "Asia/Chongqing",
"label": "Asia/Chongqing"
},
{
"value": "Asia/Chungking",
"label": "Asia/Chungking"
},
{
"value": "Asia/Colombo",
"label": "Asia/Colombo"
},
{
"value": "Asia/Dacca",
"label": "Asia/Dacca"
},
{
"value": "Asia/Damascus",
"label": "Asia/Damascus"
},
{
"value": "Asia/Dhaka",
"label": "Asia/Dhaka"
},
{
"value": "Asia/Dili",
"label": "Asia/Dili"
},
{
"value": "Asia/Dubai",
"label": "Asia/Dubai"
},
{
"value": "Asia/Dushanbe",
"label": "Asia/Dushanbe"
},
{
"value": "Asia/Famagusta",
"label": "Asia/Famagusta"
},
{
"value": "Asia/Gaza",
"label": "Asia/Gaza"
},
{
"value": "Asia/Harbin",
"label": "Asia/Harbin"
},
{
"value": "Asia/Hebron",
"label": "Asia/Hebron"
},
{
"value": "Asia/Ho_Chi_Minh",
"label": "Asia/Ho_Chi_Minh"
},
{
"value": "Asia/Hong_Kong",
"label": "Asia/Hong_Kong"
},
{
"value": "Asia/Hovd",
"label": "Asia/Hovd"
},
{
"value": "Asia/Irkutsk",
"label": "Asia/Irkutsk"
},
{
"value": "Asia/Istanbul",
"label": "Asia/Istanbul"
},
{
"value": "Asia/Jakarta",
"label": "Asia/Jakarta"
},
{
"value": "Asia/Jayapura",
"label": "Asia/Jayapura"
},
{
"value": "Asia/Jerusalem",
"label": "Asia/Jerusalem"
},
{
"value": "Asia/Kabul",
"label": "Asia/Kabul"
},
{
"value": "Asia/Kamchatka",
"label": "Asia/Kamchatka"
},
{
"value": "Asia/Karachi",
"label": "Asia/Karachi"
},
{
"value": "Asia/Kashgar",
"label": "Asia/Kashgar"
},
{
"value": "Asia/Kathmandu",
"label": "Asia/Kathmandu"
},
{
"value": "Asia/Katmandu",
"label": "Asia/Katmandu"
},
{
"value": "Asia/Khandyga",
"label": "Asia/Khandyga"
},
{
"value": "Asia/Kolkata",
"label": "Asia/Kolkata"
},
{
"value": "Asia/Krasnoyarsk",
"label": "Asia/Krasnoyarsk"
},
{
"value": "Asia/Kuala_Lumpur",
"label": "Asia/Kuala_Lumpur"
},
{
"value": "Asia/Kuching",
"label": "Asia/Kuching"
},
{
"value": "Asia/Kuwait",
"label": "Asia/Kuwait"
},
{
"value": "Asia/Macao",
"label": "Asia/Macao"
},
{
"value": "Asia/Macau",
"label": "Asia/Macau"
},
{
"value": "Asia/Magadan",
"label": "Asia/Magadan"
},
{
"value": "Asia/Makassar",
"label": "Asia/Makassar"
},
{
"value": "Asia/Manila",
"label": "Asia/Manila"
},
{
"value": "Asia/Muscat",
"label": "Asia/Muscat"
},
{
"value": "Asia/Nicosia",
"label": "Asia/Nicosia"
},
{
"value": "Asia/Novokuznetsk",
"label": "Asia/Novokuznetsk"
},
{
"value": "Asia/Novosibirsk",
"label": "Asia/Novosibirsk"
},
{
"value": "Asia/Omsk",
"label": "Asia/Omsk"
},
{
"value": "Asia/Oral",
"label": "Asia/Oral"
},
{
"value": "Asia/Phnom_Penh",
"label": "Asia/Phnom_Penh"
},
{
"value": "Asia/Pontianak",
"label": "Asia/Pontianak"
},
{
"value": "Asia/Pyongyang",
"label": "Asia/Pyongyang"
},
{
"value": "Asia/Qatar",
"label": "Asia/Qatar"
},
{
"value": "Asia/Qostanay",
"label": "Asia/Qostanay"
},
{
"value": "Asia/Qyzylorda",
"label": "Asia/Qyzylorda"
},
{
"value": "Asia/Rangoon",
"label": "Asia/Rangoon"
},
{
"value": "Asia/Riyadh",
"label": "Asia/Riyadh"
},
{
"value": "Asia/Saigon",
"label": "Asia/Saigon"
},
{
"value": "Asia/Sakhalin",
"label": "Asia/Sakhalin"
},
{
"value": "Asia/Samarkand",
"label": "Asia/Samarkand"
},
{
"value": "Asia/Seoul",
"label": "Asia/Seoul"
},
{
"value": "Asia/Shanghai",
"label": "Asia/Shanghai"
},
{
"value": "Asia/Singapore",
"label": "Asia/Singapore"
},
{
"value": "Asia/Srednekolymsk",
"label": "Asia/Srednekolymsk"
},
{
"value": "Asia/Taipei",
"label": "Asia/Taipei"
},
{
"value": "Asia/Tashkent",
"label": "Asia/Tashkent"
},
{
"value": "Asia/Tbilisi",
"label": "Asia/Tbilisi"
},
{
"value": "Asia/Tehran",
"label": "Asia/Tehran"
},
{
"value": "Asia/Tel_Aviv",
"label": "Asia/Tel_Aviv"
},
{
"value": "Asia/Thimbu",
"label": "Asia/Thimbu"
},
{
"value": "Asia/Thimphu",
"label": "Asia/Thimphu"
},
{
"value": "Asia/Tokyo",
"label": "Asia/Tokyo"
},
{
"value": "Asia/Tomsk",
"label": "Asia/Tomsk"
},
{
"value": "Asia/Ujung_Pandang",
"label": "Asia/Ujung_Pandang"
},
{
"value": "Asia/Ulaanbaatar",
"label": "Asia/Ulaanbaatar"
},
{
"value": "Asia/Ulan_Bator",
"label": "Asia/Ulan_Bator"
},
{
"value": "Asia/Urumqi",
"label": "Asia/Urumqi"
},
{
"value": "Asia/Ust-Nera",
"label": "Asia/Ust-Nera"
},
{
"value": "Asia/Vientiane",
"label": "Asia/Vientiane"
},
{
"value": "Asia/Vladivostok",
"label": "Asia/Vladivostok"
},
{
"value": "Asia/Yakutsk",
"label": "Asia/Yakutsk"
},
{
"value": "Asia/Yangon",
"label": "Asia/Yangon"
},
{
"value": "Asia/Yekaterinburg",
"label": "Asia/Yekaterinburg"
},
{
"value": "Asia/Yerevan",
"label": "Asia/Yerevan"
},
{
"value": "Atlantic/Azores",
"label": "Atlantic/Azores"
},
{
"value": "Atlantic/Bermuda",
"label": "Atlantic/Bermuda"
},
{
"value": "Atlantic/Canary",
"label": "Atlantic/Canary"
},
{
"value": "Atlantic/Cape_Verde",
"label": "Atlantic/Cape_Verde"
},
{
"value": "Atlantic/Faeroe",
"label": "Atlantic/Faeroe"
},
{
"value": "Atlantic/Faroe",
"label": "Atlantic/Faroe"
},
{
"value": "Atlantic/Jan_Mayen",
"label": "Atlantic/Jan_Mayen"
},
{
"value": "Atlantic/Madeira",
"label": "Atlantic/Madeira"
},
{
"value": "Atlantic/Reykjavik",
"label": "Atlantic/Reykjavik"
},
{
"value": "Atlantic/South_Georgia",
"label": "Atlantic/South_Georgia"
},
{
"value": "Atlantic/St_Helena",
"label": "Atlantic/St_Helena"
},
{
"value": "Atlantic/Stanley",
"label": "Atlantic/Stanley"
},
{
"value": "Australia/ACT",
"label": "Australia/ACT"
},
{
"value": "Australia/Adelaide",
"label": "Australia/Adelaide"
},
{
"value": "Australia/Brisbane",
"label": "Australia/Brisbane"
},
{
"value": "Australia/Broken_Hill",
"label": "Australia/Broken_Hill"
},
{
"value": "Australia/Canberra",
"label": "Australia/Canberra"
},
{
"value": "Australia/Currie",
"label": "Australia/Currie"
},
{
"value": "Australia/Darwin",
"label": "Australia/Darwin"
},
{
"value": "Australia/Eucla",
"label": "Australia/Eucla"
},
{
"value": "Australia/Hobart",
"label": "Australia/Hobart"
},
{
"value": "Australia/LHI",
"label": "Australia/LHI"
},
{
"value": "Australia/Lindeman",
"label": "Australia/Lindeman"
},
{
"value": "Australia/Lord_Howe",
"label": "Australia/Lord_Howe"
},
{
"value": "Australia/Melbourne",
"label": "Australia/Melbourne"
},
{
"value": "Australia/NSW",
"label": "Australia/NSW"
},
{
"value": "Australia/North",
"label": "Australia/North"
},
{
"value": "Australia/Perth",
"label": "Australia/Perth"
},
{
"value": "Australia/Queensland",
"label": "Australia/Queensland"
},
{
"value": "Australia/South",
"label": "Australia/South"
},
{
"value": "Australia/Sydney",
"label": "Australia/Sydney"
},
{
"value": "Australia/Tasmania",
"label": "Australia/Tasmania"
},
{
"value": "Australia/Victoria",
"label": "Australia/Victoria"
},
{
"value": "Australia/West",
"label": "Australia/West"
},
{
"value": "Australia/Yancowinna",
"label": "Australia/Yancowinna"
},
{
"value": "Brazil/Acre",
"label": "Brazil/Acre"
},
{
"value": "Brazil/DeNoronha",
"label": "Brazil/DeNoronha"
},
{
"value": "Brazil/East",
"label": "Brazil/East"
},
{
"value": "Brazil/West",
"label": "Brazil/West"
},
{
"value": "CET",
"label": "CET"
},
{
"value": "CST6CDT",
"label": "CST6CDT"
},
{
"value": "Canada/Atlantic",
"label": "Canada/Atlantic"
},
{
"value": "Canada/Central",
"label": "Canada/Central"
},
{
"value": "Canada/Eastern",
"label": "Canada/Eastern"
},
{
"value": "Canada/Mountain",
"label": "Canada/Mountain"
},
{
"value": "Canada/Newfoundland",
"label": "Canada/Newfoundland"
},
{
"value": "Canada/Pacific",
"label": "Canada/Pacific"
},
{
"value": "Canada/Saskatchewan",
"label": "Canada/Saskatchewan"
},
{
"value": "Canada/Yukon",
"label": "Canada/Yukon"
},
{
"value": "Chile/Continental",
"label": "Chile/Continental"
},
{
"value": "Chile/EasterIsland",
"label": "Chile/EasterIsland"
},
{
"value": "Cuba",
"label": "Cuba"
},
{
"value": "EET",
"label": "EET"
},
{
"value": "EST",
"label": "EST"
},
{
"value": "EST5EDT",
"label": "EST5EDT"
},
{
"value": "Egypt",
"label": "Egypt"
},
{
"value": "Eire",
"label": "Eire"
},
{
"value": "Etc/GMT",
"label": "Etc/GMT"
},
{
"value": "Etc/GMT+0",
"label": "Etc/GMT+0"
},
{
"value": "Etc/GMT+1",
"label": "Etc/GMT+1"
},
{
"value": "Etc/GMT+10",
"label": "Etc/GMT+10"
},
{
"value": "Etc/GMT+11",
"label": "Etc/GMT+11"
},
{
"value": "Etc/GMT+12",
"label": "Etc/GMT+12"
},
{
"value": "Etc/GMT+2",
"label": "Etc/GMT+2"
},
{
"value": "Etc/GMT+3",
"label": "Etc/GMT+3"
},
{
"value": "Etc/GMT+4",
"label": "Etc/GMT+4"
},
{
"value": "Etc/GMT+5",
"label": "Etc/GMT+5"
},
{
"value": "Etc/GMT+6",
"label": "Etc/GMT+6"
},
{
"value": "Etc/GMT+7",
"label": "Etc/GMT+7"
},
{
"value": "Etc/GMT+8",
"label": "Etc/GMT+8"
},
{
"value": "Etc/GMT+9",
"label": "Etc/GMT+9"
},
{
"value": "Etc/GMT-0",
"label": "Etc/GMT-0"
},
{
"value": "Etc/GMT-1",
"label": "Etc/GMT-1"
},
{
"value": "Etc/GMT-10",
"label": "Etc/GMT-10"
},
{
"value": "Etc/GMT-11",
"label": "Etc/GMT-11"
},
{
"value": "Etc/GMT-12",
"label": "Etc/GMT-12"
},
{
"value": "Etc/GMT-13",
"label": "Etc/GMT-13"
},
{
"value": "Etc/GMT-14",
"label": "Etc/GMT-14"
},
{
"value": "Etc/GMT-2",
"label": "Etc/GMT-2"
},
{
"value": "Etc/GMT-3",
"label": "Etc/GMT-3"
},
{
"value": "Etc/GMT-4",
"label": "Etc/GMT-4"
},
{
"value": "Etc/GMT-5",
"label": "Etc/GMT-5"
},
{
"value": "Etc/GMT-6",
"label": "Etc/GMT-6"
},
{
"value": "Etc/GMT-7",
"label": "Etc/GMT-7"
},
{
"value": "Etc/GMT-8",
"label": "Etc/GMT-8"
},
{
"value": "Etc/GMT-9",
"label": "Etc/GMT-9"
},
{
"value": "Etc/GMT0",
"label": "Etc/GMT0"
},
{
"value": "Etc/Greenwich",
"label": "Etc/Greenwich"
},
{
"value": "Etc/UCT",
"label": "Etc/UCT"
},
{
"value": "Etc/UTC",
"label": "Etc/UTC"
},
{
"value": "Etc/Universal",
"label": "Etc/Universal"
},
{
"value": "Etc/Zulu",
"label": "Etc/Zulu"
},
{
"value": "Europe/Amsterdam",
"label": "Europe/Amsterdam"
},
{
"value": "Europe/Andorra",
"label": "Europe/Andorra"
},
{
"value": "Europe/Astrakhan",
"label": "Europe/Astrakhan"
},
{
"value": "Europe/Athens",
"label": "Europe/Athens"
},
{
"value": "Europe/Belfast",
"label": "Europe/Belfast"
},
{
"value": "Europe/Belgrade",
"label": "Europe/Belgrade"
},
{
"value": "Europe/Berlin",
"label": "Europe/Berlin"
},
{
"value": "Europe/Bratislava",
"label": "Europe/Bratislava"
},
{
"value": "Europe/Brussels",
"label": "Europe/Brussels"
},
{
"value": "Europe/Bucharest",
"label": "Europe/Bucharest"
},
{
"value": "Europe/Budapest",
"label": "Europe/Budapest"
},
{
"value": "Europe/Busingen",
"label": "Europe/Busingen"
},
{
"value": "Europe/Chisinau",
"label": "Europe/Chisinau"
},
{
"value": "Europe/Copenhagen",
"label": "Europe/Copenhagen"
},
{
"value": "Europe/Dublin",
"label": "Europe/Dublin"
},
{
"value": "Europe/Gibraltar",
"label": "Europe/Gibraltar"
},
{
"value": "Europe/Guernsey",
"label": "Europe/Guernsey"
},
{
"value": "Europe/Helsinki",
"label": "Europe/Helsinki"
},
{
"value": "Europe/Isle_of_Man",
"label": "Europe/Isle_of_Man"
},
{
"value": "Europe/Istanbul",
"label": "Europe/Istanbul"
},
{
"value": "Europe/Jersey",
"label": "Europe/Jersey"
},
{
"value": "Europe/Kaliningrad",
"label": "Europe/Kaliningrad"
},
{
"value": "Europe/Kiev",
"label": "Europe/Kiev"
},
{
"value": "Europe/Kirov",
"label": "Europe/Kirov"
},
{
"value": "Europe/Lisbon",
"label": "Europe/Lisbon"
},
{
"value": "Europe/Ljubljana",
"label": "Europe/Ljubljana"
},
{
"value": "Europe/London",
"label": "Europe/London"
},
{
"value": "Europe/Luxembourg",
"label": "Europe/Luxembourg"
},
{
"value": "Europe/Madrid",
"label": "Europe/Madrid"
},
{
"value": "Europe/Malta",
"label": "Europe/Malta"
},
{
"value": "Europe/Mariehamn",
"label": "Europe/Mariehamn"
},
{
"value": "Europe/Minsk",
"label": "Europe/Minsk"
},
{
"value": "Europe/Monaco",
"label": "Europe/Monaco"
},
{
"value": "Europe/Moscow",
"label": "Europe/Moscow"
},
{
"value": "Europe/Nicosia",
"label": "Europe/Nicosia"
},
{
"value": "Europe/Oslo",
"label": "Europe/Oslo"
},
{
"value": "Europe/Paris",
"label": "Europe/Paris"
},
{
"value": "Europe/Podgorica",
"label": "Europe/Podgorica"
},
{
"value": "Europe/Prague",
"label": "Europe/Prague"
},
{
"value": "Europe/Riga",
"label": "Europe/Riga"
},
{
"value": "Europe/Rome",
"label": "Europe/Rome"
},
{
"value": "Europe/Samara",
"label": "Europe/Samara"
},
{
"value": "Europe/San_Marino",
"label": "Europe/San_Marino"
},
{
"value": "Europe/Sarajevo",
"label": "Europe/Sarajevo"
},
{
"value": "Europe/Saratov",
"label": "Europe/Saratov"
},
{
"value": "Europe/Simferopol",
"label": "Europe/Simferopol"
},
{
"value": "Europe/Skopje",
"label": "Europe/Skopje"
},
{
"value": "Europe/Sofia",
"label": "Europe/Sofia"
},
{
"value": "Europe/Stockholm",
"label": "Europe/Stockholm"
},
{
"value": "Europe/Tallinn",
"label": "Europe/Tallinn"
},
{
"value": "Europe/Tirane",
"label": "Europe/Tirane"
},
{
"value": "Europe/Tiraspol",
"label": "Europe/Tiraspol"
},
{
"value": "Europe/Ulyanovsk",
"label": "Europe/Ulyanovsk"
},
{
"value": "Europe/Uzhgorod",
"label": "Europe/Uzhgorod"
},
{
"value": "Europe/Vaduz",
"label": "Europe/Vaduz"
},
{
"value": "Europe/Vatican",
"label": "Europe/Vatican"
},
{
"value": "Europe/Vienna",
"label": "Europe/Vienna"
},
{
"value": "Europe/Vilnius",
"label": "Europe/Vilnius"
},
{
"value": "Europe/Volgograd",
"label": "Europe/Volgograd"
},
{
"value": "Europe/Warsaw",
"label": "Europe/Warsaw"
},
{
"value": "Europe/Zagreb",
"label": "Europe/Zagreb"
},
{
"value": "Europe/Zaporozhye",
"label": "Europe/Zaporozhye"
},
{
"value": "Europe/Zurich",
"label": "Europe/Zurich"
},
{
"value": "Factory",
"label": "Factory"
},
{
"value": "GB",
"label": "GB"
},
{
"value": "GB-Eire",
"label": "GB-Eire"
},
{
"value": "GMT",
"label": "GMT"
},
{
"value": "GMT+0",
"label": "GMT+0"
},
{
"value": "GMT-0",
"label": "GMT-0"
},
{
"value": "GMT0",
"label": "GMT0"
},
{
"value": "Greenwich",
"label": "Greenwich"
},
{
"value": "HST",
"label": "HST"
},
{
"value": "Hongkong",
"label": "Hongkong"
},
{
"value": "Iceland",
"label": "Iceland"
},
{
"value": "Indian/Antananarivo",
"label": "Indian/Antananarivo"
},
{
"value": "Indian/Chagos",
"label": "Indian/Chagos"
},
{
"value": "Indian/Christmas",
"label": "Indian/Christmas"
},
{
"value": "Indian/Cocos",
"label": "Indian/Cocos"
},
{
"value": "Indian/Comoro",
"label": "Indian/Comoro"
},
{
"value": "Indian/Kerguelen",
"label": "Indian/Kerguelen"
},
{
"value": "Indian/Mahe",
"label": "Indian/Mahe"
},
{
"value": "Indian/Maldives",
"label": "Indian/Maldives"
},
{
"value": "Indian/Mauritius",
"label": "Indian/Mauritius"
},
{
"value": "Indian/Mayotte",
"label": "Indian/Mayotte"
},
{
"value": "Indian/Reunion",
"label": "Indian/Reunion"
},
{
"value": "Iran",
"label": "Iran"
},
{
"value": "Israel",
"label": "Israel"
},
{
"value": "Jamaica",
"label": "Jamaica"
},
{
"value": "Japan",
"label": "Japan"
},
{
"value": "Kwajalein",
"label": "Kwajalein"
},
{
"value": "Libya",
"label": "Libya"
},
{
"value": "MET",
"label": "MET"
},
{
"value": "MST",
"label": "MST"
},
{
"value": "MST7MDT",
"label": "MST7MDT"
},
{
"value": "Mexico/BajaNorte",
"label": "Mexico/BajaNorte"
},
{
"value": "Mexico/BajaSur",
"label": "Mexico/BajaSur"
},
{
"value": "Mexico/General",
"label": "Mexico/General"
},
{
"value": "NZ",
"label": "NZ"
},
{
"value": "NZ-CHAT",
"label": "NZ-CHAT"
},
{
"value": "Navajo",
"label": "Navajo"
},
{
"value": "PRC",
"label": "PRC"
},
{
"value": "PST8PDT",
"label": "PST8PDT"
},
{
"value": "Pacific/Apia",
"label": "Pacific/Apia"
},
{
"value": "Pacific/Auckland",
"label": "Pacific/Auckland"
},
{
"value": "Pacific/Bougainville",
"label": "Pacific/Bougainville"
},
{
"value": "Pacific/Chatham",
"label": "Pacific/Chatham"
},
{
"value": "Pacific/Chuuk",
"label": "Pacific/Chuuk"
},
{
"value": "Pacific/Easter",
"label": "Pacific/Easter"
},
{
"value": "Pacific/Efate",
"label": "Pacific/Efate"
},
{
"value": "Pacific/Enderbury",
"label": "Pacific/Enderbury"
},
{
"value": "Pacific/Fakaofo",
"label": "Pacific/Fakaofo"
},
{
"value": "Pacific/Fiji",
"label": "Pacific/Fiji"
},
{
"value": "Pacific/Funafuti",
"label": "Pacific/Funafuti"
},
{
"value": "Pacific/Galapagos",
"label": "Pacific/Galapagos"
},
{
"value": "Pacific/Gambier",
"label": "Pacific/Gambier"
},
{
"value": "Pacific/Guadalcanal",
"label": "Pacific/Guadalcanal"
},
{
"value": "Pacific/Guam",
"label": "Pacific/Guam"
},
{
"value": "Pacific/Honolulu",
"label": "Pacific/Honolulu"
},
{
"value": "Pacific/Johnston",
"label": "Pacific/Johnston"
},
{
"value": "Pacific/Kiritimati",
"label": "Pacific/Kiritimati"
},
{
"value": "Pacific/Kosrae",
"label": "Pacific/Kosrae"
},
{
"value": "Pacific/Kwajalein",
"label": "Pacific/Kwajalein"
},
{
"value": "Pacific/Majuro",
"label": "Pacific/Majuro"
},
{
"value": "Pacific/Marquesas",
"label": "Pacific/Marquesas"
},
{
"value": "Pacific/Midway",
"label": "Pacific/Midway"
},
{
"value": "Pacific/Nauru",
"label": "Pacific/Nauru"
},
{
"value": "Pacific/Niue",
"label": "Pacific/Niue"
},
{
"value": "Pacific/Norfolk",
"label": "Pacific/Norfolk"
},
{
"value": "Pacific/Noumea",
"label": "Pacific/Noumea"
},
{
"value": "Pacific/Pago_Pago",
"label": "Pacific/Pago_Pago"
},
{
"value": "Pacific/Palau",
"label": "Pacific/Palau"
},
{
"value": "Pacific/Pitcairn",
"label": "Pacific/Pitcairn"
},
{
"value": "Pacific/Pohnpei",
"label": "Pacific/Pohnpei"
},
{
"value": "Pacific/Ponape",
"label": "Pacific/Ponape"
},
{
"value": "Pacific/Port_Moresby",
"label": "Pacific/Port_Moresby"
},
{
"value": "Pacific/Rarotonga",
"label": "Pacific/Rarotonga"
},
{
"value": "Pacific/Saipan",
"label": "Pacific/Saipan"
},
{
"value": "Pacific/Samoa",
"label": "Pacific/Samoa"
},
{
"value": "Pacific/Tahiti",
"label": "Pacific/Tahiti"
},
{
"value": "Pacific/Tarawa",
"label": "Pacific/Tarawa"
},
{
"value": "Pacific/Tongatapu",
"label": "Pacific/Tongatapu"
},
{
"value": "Pacific/Truk",
"label": "Pacific/Truk"
},
{
"value": "Pacific/Wake",
"label": "Pacific/Wake"
},
{
"value": "Pacific/Wallis",
"label": "Pacific/Wallis"
},
{
"value": "Pacific/Yap",
"label": "Pacific/Yap"
},
{
"value": "Poland",
"label": "Poland"
},
{
"value": "Portugal",
"label": "Portugal"
},
{
"value": "ROC",
"label": "ROC"
},
{
"value": "ROK",
"label": "ROK"
},
{
"value": "Singapore",
"label": "Singapore"
},
{
"value": "SystemV/AST4",
"label": "SystemV/AST4"
},
{
"value": "SystemV/AST4ADT",
"label": "SystemV/AST4ADT"
},
{
"value": "SystemV/CST6",
"label": "SystemV/CST6"
},
{
"value": "SystemV/CST6CDT",
"label": "SystemV/CST6CDT"
},
{
"value": "SystemV/EST5",
"label": "SystemV/EST5"
},
{
"value": "SystemV/EST5EDT",
"label": "SystemV/EST5EDT"
},
{
"value": "SystemV/HST10",
"label": "SystemV/HST10"
},
{
"value": "SystemV/MST7",
"label": "SystemV/MST7"
},
{
"value": "SystemV/MST7MDT",
"label": "SystemV/MST7MDT"
},
{
"value": "SystemV/PST8",
"label": "SystemV/PST8"
},
{
"value": "SystemV/PST8PDT",
"label": "SystemV/PST8PDT"
},
{
"value": "SystemV/YST9",
"label": "SystemV/YST9"
},
{
"value": "SystemV/YST9YDT",
"label": "SystemV/YST9YDT"
},
{
"value": "Turkey",
"label": "Turkey"
},
{
"value": "UCT",
"label": "UCT"
},
{
"value": "US/Alaska",
"label": "US/Alaska"
},
{
"value": "US/Aleutian",
"label": "US/Aleutian"
},
{
"value": "US/Arizona",
"label": "US/Arizona"
},
{
"value": "US/Central",
"label": "US/Central"
},
{
"value": "US/East-Indiana",
"label": "US/East-Indiana"
},
{
"value": "US/Eastern",
"label": "US/Eastern"
},
{
"value": "US/Hawaii",
"label": "US/Hawaii"
},
{
"value": "US/Indiana-Starke",
"label": "US/Indiana-Starke"
},
{
"value": "US/Michigan",
"label": "US/Michigan"
},
{
"value": "US/Mountain",
"label": "US/Mountain"
},
{
"value": "US/Pacific",
"label": "US/Pacific"
},
{
"value": "US/Pacific-New",
"label": "US/Pacific-New"
},
{
"value": "US/Samoa",
"label": "US/Samoa"
},
{
"value": "UTC",
"label": "UTC"
},
{
"value": "Universal",
"label": "Universal"
},
{
"value": "W-SU",
"label": "W-SU"
},
{
"value": "WET",
"label": "WET"
},
{
"value": "Zulu",
"label": "Zulu"
}
]
},
{
"label": "Locale",
"property": "locale",
"displayHint": "selectBox",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": false,
"constraintName": "locales",
"constraintClass": "orderedSet",
"constraint": [
{
"value": "ar_AE",
"label": "عربي / الإمارات العربية المتحدة"
},
{
"value": "ar_EG",
"label": "عربي / مصر"
},
{
"value": "ar_SA",
"label": "العربية / السعودية"
},
{
"value": "da_DK",
"label": "dansk/Danmark"
},
{
"value": "de_AT",
"label": "Deutsch/Österreich"
},
{
"value": "de_DE",
"label": "Deutsch/Deutschland"
},
{
"value": "en_AU",
"label": "English/Australia"
},
{
"value": "en_CA",
"label": "English/Canada"
},
{
"value": "en_GB",
"label": "English/Great Britain"
},
{
"value": "en_US",
"label": "English/United States"
},
{
"value": "es_ES",
"label": "Español/España"
},
{
"value": "fr_CA",
"label": "Français/Canada"
},
{
"value": "fr_FR",
"label": "Français/France"
},
{
"value": "ja_JP",
"label": "日本語/日本"
},
{
"value": "ko_KR",
"label": "한국말/대한민국"
},
{
"value": "nb_NO",
"label": "Bokmål/Norge"
},
{
"value": "nl_NL",
"label": "Nederlands/Nederland"
},
{
"value": "nn_NO",
"label": "Nynorsk/Norge"
},
{
"value": "pt_BR",
"label": "português/Brasil"
},
{
"value": "pt_PT",
"label": "português/Portugal"
},
{
"value": "sv_SE",
"label": "svenska/Sverige"
},
{
"value": "zh_CN",
"label": "中文/中华人民共和国"
},
{
"value": "zh_TW",
"label": "中文/中華民國"
}
]
},
{
"label": "Circulation Requires Authorization",
"property": "circulationRequiresAuthorization",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": "if t, patron must be an active member of a group whose authset contains the checkout-center (scope of #!circulation-authorization) that the operator is trying to reserve/check-out from on behalf of the patron.",
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Patron Access Requires Authorization",
"property": "patronAccessRequiresAuthorization",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": "if t, patron must be an active member of a group whose authset contains the checkout-center (scope of #!patron-portal-access-authorization) that the patron is trying to log into.",
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Patron Portal Message",
"property": "pirMotd",
"displayHint": "longString",
"resultColumn": true,
"type": "string",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Allow Patron Portal Search For Media In Other Centers",
"property": "pirMediaCcQuery",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Schedule Repeats In Patron Portal",
"property": "repeatsInPir",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Patron Portal Resource Selection Mode",
"property": "pirMode",
"displayHint": "selectBox",
"resultColumn": true,
"type": "tag",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": false,
"constraintName": "pirMode",
"constraintClass": "dynamicOrderedSet",
"constraint": [
{
"value": "RRT",
"label": "RRT Only"
},
{
"value": "INDIVIDUAL",
"label": "Individual Resources Only"
},
{
"value": "BOTH",
"label": "RRT and Individual Resources"
}
]
},
{
"label": "Patron Reservations Require Approval",
"property": "pirRequiresApproval",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Allow Patrons To Submit Tickets In Patron Portal",
"property": "pirReportProblems",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": "Can a patron report a problem in PIR at this checkout-center",
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Patron Portal Reservations Require Event Title",
"property": "pirRequiresEventTitle",
"displayHint": "selectBox",
"resultColumn": true,
"type": "tag",
"multipleValues": false,
"documentation": "require an event title in patron portal",
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": "eventTitleRequired",
"constraintClass": "orderedSet",
"constraint": [
{
"value": "YES",
"label": "Yes"
},
{
"value": "OPTIONAL",
"label": "Optional"
},
{
"value": "NO",
"label": "No"
}
]
},
{
"label": "Restrict Patron Delivery Locations To This Center",
"property": "pirRestrictDeliveryLocations",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Patron Portal Timeout (Minutes)",
"property": "pirSessionTimeout",
"displayHint": "integer",
"resultColumn": true,
"type": "integer",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Min Checkout Reserve Time",
"property": "minCheckoutReserveTime",
"displayHint": "duration",
"resultColumn": true,
"type": "duration",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": false,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Max Checkout Reserve Time",
"property": "maxCheckoutReserveTime",
"displayHint": "circulationPeriod",
"resultColumn": true,
"type": "circulationPeriod",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": false,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Reservation Advance Limit",
"property": "reservationAdvanceLimit",
"displayHint": "duration",
"resultColumn": true,
"type": "duration",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": false,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Patron Portal Reservation Granularity",
"property": "pirReservationGranularity",
"displayHint": "duration",
"resultColumn": true,
"type": "duration",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": false,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Patron Portal Start Granularity",
"property": "pirStartGranularity",
"displayHint": "integer",
"resultColumn": true,
"type": "integer",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": false,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Patron Portal Delivery Locations",
"property": "pirDeliveryLocations",
"displayHint": "entityList",
"resultColumn": true,
"type": "resource",
"multipleValues": true,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": false,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Set Location In Patron Portal",
"property": "setLocationInPatronPortal",
"displayHint": "selectBox",
"resultColumn": true,
"type": "tag",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": "setLocationInPatronPortalOptions",
"constraintClass": "dynamicOrderedSet",
"constraint": [
{
"value": "NONE",
"label": "None"
},
{
"value": "ALLOW",
"label": "Allow"
},
{
"value": "REQUIRE",
"label": "Require"
}
]
},
{
"label": "Patron Portal Show Groups",
"property": "patronPortalShowGroups",
"displayHint": "boolean",
"resultColumn": true,
"type": "boolean",
"multipleValues": false,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": true,
"writeAuth": null,
"dbSortable": true,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Honor External Holds",
"property": "honorExternalHolds",
"displayHint": "entity",
"resultColumn": true,
"type": "checkoutCenter",
"multipleValues": true,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Honor External Fines",
"property": "honorExternalFines",
"displayHint": "entity",
"resultColumn": true,
"type": "checkoutCenter",
"multipleValues": true,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Honor External Lates",
"property": "honorExternalLates",
"displayHint": "entity",
"resultColumn": true,
"type": "checkoutCenter",
"multipleValues": true,
"documentation": null,
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Calendar",
"property": "calendar",
"displayHint": "entity",
"resultColumn": null,
"type": "checkoutCenterCalendar",
"multipleValues": false,
"documentation": "The calendar of this Checkout Center",
"readable": true,
"readAuth": null,
"writable": false,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Public Schedule",
"property": "publicSchedule",
"displayHint": "hashtable",
"resultColumn": true,
"type": "hashtable",
"multipleValues": false,
"documentation": "The current schedule for this CC structured for display",
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": false,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"label": "Default Task Profile",
"property": "defaultTaskProfile",
"displayHint": "entitySelectBox",
"resultColumn": null,
"type": "taskProfile",
"multipleValues": false,
"documentation": "",
"readable": true,
"readAuth": null,
"writable": true,
"writeAuth": null,
"dbSortable": false,
"constraintName": "taskProfiles",
"constraintClass": "dynamicOrderedSet",
"constraint": [
{
"value": "",
"label": "None"
},
{
"value": {
"_class": "taskProfile",
"oid": 1,
"name": "Set Only Profile",
"taskTypes": [
{
"_class": "taskType",
"oid": 1,
"name": "Set",
"active": true,
"isAllocationTask": true
}
],
"description": "Default Set Only Task Profile",
"organization": null,
"entityType": "allocation"
},
"label": "Set Only Profile"
},
{
"value": {
"_class": "taskProfile",
"oid": 3,
"name": "Set/Show/Strike Profile",
"taskTypes": [
{
"_class": "taskType",
"oid": 1,
"name": "Set",
"active": true,
"isAllocationTask": true
},
{
"_class": "taskType",
"oid": 2,
"name": "Strike",
"active": true,
"isAllocationTask": true
},
{
"_class": "taskType",
"oid": 3,
"name": "Show",
"active": true,
"isAllocationTask": true
}
],
"description": "Default Set/Show/Strike Task Profile",
"organization": null,
"entityType": "allocation"
},
"label": "Set/Show/Strike Profile"
},
{
"value": {
"_class": "taskProfile",
"oid": 2,
"name": "Set/Strike Profile",
"taskTypes": [
{
"_class": "taskType",
"oid": 1,
"name": "Set",
"active": true,
"isAllocationTask": true
},
{
"_class": "taskType",
"oid": 2,
"name": "Strike",
"active": true,
"isAllocationTask": true
}
],
"description": "Default Set/Strike Task Profile",
"organization": null,
"entityType": "allocation"
},
"label": "Set/Strike Profile"
},
{
"value": {
"_class": "taskProfile",
"oid": 4,
"name": "Setup for Will Call Profile",
"taskTypes": [
{
"_class": "taskType",
"oid": 4,
"name": "Setup For Will Call",
"active": true,
"isAllocationTask": true
}
],
"description": "Default Setup for Will Call Task Profile",
"organization": null,
"entityType": "allocation"
},
"label": "Setup for Will Call Profile"
}
]
},
{
"label": "Patron Portal Properties",
"property": "patronPortalProperties",
"displayHint": "entityList",
"resultColumn": true,
"type": "patronPortalProperty",
"multipleValues": true,
"documentation": null,
"readable": true,
"readAuth": [
{
"type": "defaultAllow"
}
],
"writable": false,
"writeAuth": null,
"dbSortable": false,
"constraintName": null,
"constraintClass": null,
"constraint": null
}
],
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
Details on the query terms published for a particular entity type can be retrieved using the namespace queryTerms call.
For each query term the results include:the label to be used for display purposes to name the query term
The name of the query term
the framework type of the term
A hint for the proper rendering of the term (see Hints)
When defined, information about the set of constrained values the query term will accept. For details see constraints in Special Namespaces
The constraint value, listing all posible values, is deprecated and will be removed in a future version of the API
A plain-text description of the query term
The full list of query terms for each namespace is listed in the the API Reference that is available on each WebChecheckout instance.
POST rest/checkoutCenter/queryTerms
{
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/checkoutCenter/queryTerms",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": [
{
"name": "Checkout Center",
"parameter": "identity",
"documentation": "Undocumented Term",
"type": "checkoutCenter",
"displayHint": "autocomplete",
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"name": "Autocomplete",
"parameter": "autocomplete",
"documentation": "Undocumented Term",
"type": "string",
"displayHint": "string",
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"name": "Contained By Authset",
"parameter": "containedByAuthset",
"documentation": "Undocumented Term",
"type": "authset",
"displayHint": "autocomplete",
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"name": "Contained By Authset Autocomplete",
"parameter": "containedByAuthsetAutocomplete",
"documentation": "Undocumented Term",
"type": "string",
"displayHint": "autocompleteString",
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"name": "Managing Organization",
"parameter": "organization",
"documentation": "Undocumented Term",
"type": "organization",
"displayHint": "entity",
"constraintName": "organizations",
"constraintClass": "dynamicOrderedSet",
"constraint": [
{
"value": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"label": "Communications"
}
]
},
{
"name": "Staffed",
"parameter": "staffed",
"documentation": "Undocumented Term",
"type": "boolean",
"displayHint": "boolean",
"constraintName": null,
"constraintClass": null,
"constraint": null
},
{
"name": "Unstaffed",
"parameter": "unstaffed",
"documentation": "Undocumented Term",
"type": "boolean",
"displayHint": "boolean",
"constraintName": null,
"constraintClass": null,
"constraint": null
}
],
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
POSTing to a namespace's search method will perform a search across all entities of that type. An empty Request payload will result in the returning of all entites of the type. This should be used with caution as some classes of entity may have hundreds of thousands of instances. There is no built-in limit on the number of results. Extreme result sets may cause performance problems with the server itself.
POST rest/checkoutCenter/search
{
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/checkoutCenter/search",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"count": 3,
"summary": null,
"result": [
{
"_class": "checkoutCenter",
"oid": 1,
"name": "Main",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
},
{
"_class": "checkoutCenter",
"oid": 2,
"name": "East",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
},
{
"_class": "checkoutCenter",
"oid": 3,
"name": "West",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
},
"description": null
}
]
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
Specifying keys and values in the query argument will limit the search to entities matching these query terms and values. See the API Reference that is available on each WebChecheckout instance for a list of available query terms and their arguments.
POST rest/person/search
{
"query": {
"firstName": "John"
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/search",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"count": 4,
"summary": null,
"result": [
{
"_class": "person",
"oid": 1033,
"name": "John Lin",
"userid": "084745",
"barcode": null
},
{
"_class": "person",
"oid": 1,
"name": "John Q. Admin",
"userid": "admin",
"barcode": "12345"
},
{
"_class": "person",
"oid": 1164,
"name": "John Braswell",
"userid": "089663",
"barcode": null
},
{
"_class": "person",
"oid": 1215,
"name": "John Smith",
"userid": "054016",
"barcode": null
}
]
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
Multiple terms may be combined using an "and" or "or" term.
POST rest/person/search
{
"query": {
"and": {
"firstName": "John",
"lastName": "Smith"
}
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/search",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"count": 1,
"summary": null,
"result": [
{
"_class": "person",
"oid": 1215,
"name": "John Smith",
"userid": "054016",
"barcode": null
}
]
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
POST rest/person/search
{
"query": {
"or": {
"firstName": "John",
"lastName": "Kim"
}
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/search",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"count": 15,
"summary": null,
"result": [
{
"_class": "person",
"oid": 1013,
"name": "SoYun Kim",
"userid": "044916",
"barcode": null
},
{
"_class": "person",
"oid": 1014,
"name": "Daniel Kim",
"userid": "063003",
"barcode": null
},
{
"_class": "person",
"oid": 1033,
"name": "John Lin",
"userid": "084745",
"barcode": null
},
{
"_class": "person",
"oid": 1,
"name": "John Q. Admin",
"userid": "admin",
"barcode": "12345"
},
{
"_class": "person",
"oid": 1093,
"name": "Virginia Kim",
"userid": "081401",
"barcode": null
},
{
"_class": "person",
"oid": 1164,
"name": "John Braswell",
"userid": "089663",
"barcode": null
},
{
"_class": "person",
"oid": 1165,
"name": "Jeff Kim",
"userid": "043383",
"barcode": null
},
{
"_class": "person",
"oid": 1166,
"name": "Gerardo Kim",
"userid": "061975",
"barcode": null
},
{
"_class": "person",
"oid": 1196,
"name": "Jenny Kim",
"userid": "073877",
"barcode": null
},
{
"_class": "person",
"oid": 1215,
"name": "John Smith",
"userid": "054016",
"barcode": null
},
{
"_class": "person",
"oid": 1343,
"name": "Christopher Kim",
"userid": "068105",
"barcode": null
},
{
"_class": "person",
"oid": 1435,
"name": "Paulina Kim",
"userid": "024945",
"barcode": null
},
{
"_class": "person",
"oid": 1459,
"name": "Dalia Kim",
"userid": "069747",
"barcode": null
},
{
"_class": "person",
"oid": 1488,
"name": "David Kim",
"userid": "083596",
"barcode": null
},
{
"_class": "person",
"oid": 1495,
"name": "Ru Ry Kim",
"userid": "056779",
"barcode": null
}
]
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
Specifying a non-existing query term, or an improperly formatted value will result in an error.
POST rest/person/search
{
"query": {
"firstNam": "John"
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/search",
"session": "S-21712",
"status": "error",
"notifications": null,
"alert": null,
"payload": {
"message": "Requested search term FIRST-NAM does not exist on class #",
"class": "REST-SERVER:SEARCH-PROPERTY-DOES-NOT-EXIST"
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
As with getting an individual entity, with searching you may specify the properties you would like to be encluded with each result. This is done by providing a property template to the properties argument. For details on property templates see the Property Templates section below. As always, the mandatory three properties will be included.
POST rest/person/search
{
"query": {
"userid": "admin"
},
"properties": [
"street",
"street2",
"city",
"state",
"telephone",
"email"
],
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/search",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"count": 1,
"summary": null,
"result": [
{
"_class": "person",
"oid": 1,
"name": "John Q. Admin",
"email": null,
"telephone": null,
"state": null,
"city": null,
"street2": null,
"street": null
}
]
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
The limit argument will limit the number of results returned, even if more results match the query terms.
POST rest/person/search
{
"limit": 5,
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/search",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"count": 502,
"summary": null,
"result": [
{
"_class": "person",
"oid": 2,
"name": "Window Worker",
"userid": "wworker",
"barcode": null
},
{
"_class": "person",
"oid": 1000,
"name": "Brian Villanueva",
"userid": "056474",
"barcode": null
},
{
"_class": "person",
"oid": 1001,
"name": "Karen Palermo",
"userid": "023688",
"barcode": null
},
{
"_class": "person",
"oid": 1002,
"name": "Oswaldo Jenks",
"userid": "068999",
"barcode": null
},
{
"_class": "person",
"oid": 1,
"name": "John Q. Admin",
"userid": "admin",
"barcode": "12345"
}
]
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
The order-by argument causes the results of the find to be sorted by the named property. It is an error to provide a name that is not a property in the namespace being searched for. It is also an error to provide the name of a property that is not "dbSortable".
Note that all entities have an identity property, and this property is always dbSortable. By default this property sorts by OID to ensure you get the same results in the same order each time. Where appropriate, some entities have a defined sortAttribute that ensures that the entity sorts in whatever its "natural" order is. For example, the person entity will use the sortableName property and the patronClass entity its rank property to sort when identity is used.
When sorting by a property that is itself an entity, that properties identity property will be used as above. So for example if allocations are sorted by their patron property, because patron is of type person, the allocations will be sorted based on the allocations patrons sortableName property.
POST rest/person/search
{
"limit": 5,
"orderBy": "sortableName",
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/search",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"count": 502,
"summary": null,
"result": [
{
"_class": "person",
"oid": 1427,
"name": "Nathaniel Abaravich",
"userid": "076904",
"barcode": null
},
{
"_class": "person",
"oid": 1311,
"name": "Sydney Adams",
"userid": "066786",
"barcode": null
},
{
"_class": "person",
"oid": 1,
"name": "John Q. Admin",
"userid": "admin",
"barcode": "12345"
},
{
"_class": "person",
"oid": 1046,
"name": "Jacquelyne Agdere",
"userid": "059609",
"barcode": null
},
{
"_class": "person",
"oid": 1430,
"name": "Balbina Ai",
"userid": "044119",
"barcode": null
}
]
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
The order-direction argument determines the sort order of the order-by argument and takes one of two values:
Sort in descending canonical order (ex Z,Y,X,etc)
Sort in ascending canonical order (ex A,B,C,etc)
The argument is ignored if you have not provided an order-by property.
POST rest/person/search
{
"limit": 5,
"orderBy": "sortableName",
"orderDirection": "desc",
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/search",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"count": 502,
"summary": null,
"result": [
{
"_class": "person",
"oid": 1064,
"name": "Matthew Zuniga",
"userid": "080696",
"barcode": null
},
{
"_class": "person",
"oid": 1480,
"name": "Emil Zukovski",
"userid": "014722",
"barcode": null
},
{
"_class": "person",
"oid": 1355,
"name": "Shomari Ziehler-Martin",
"userid": "052663",
"barcode": null
},
{
"_class": "person",
"oid": 1296,
"name": "Nicholas Yung",
"userid": "047807",
"barcode": null
},
{
"_class": "person",
"oid": 1353,
"name": "Mark Yu",
"userid": "073798",
"barcode": null
}
]
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
The order-null argument determines where null values are sorted in the results and takes one of two values
Null values are sorted ahead of non-null values
Null values are sorted after non-null values
The argument is ignored if you have not provided an order-by property.
The order argument expands on the previous order-* arguments allowing for sorting by multiple properties. Accepts a list of objects specifying "by", "direction", and "nulls" options. Returns results sorted by each option in turn.
POST rest/person/search
{
"order": [
{
"by": "lastName",
"direction": "desc"
},
{
"by": "userid",
"direction": "asc"
}
],
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/search",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"count": 502,
"summary": null,
"result": [
{
"_class": "person",
"oid": 1064,
"name": "Matthew Zuniga",
"userid": "080696",
"barcode": null
},
{
"_class": "person",
"oid": 1480,
"name": "Emil Zukovski",
"userid": "014722",
"barcode": null
},
{
"_class": "person",
"oid": 1355,
"name": "Shomari Ziehler-Martin",
"userid": "052663",
"barcode": null
},
{
"_class": "person",
"oid": 1296,
"name": "Nicholas Yung",
"userid": "047807",
"barcode": null
},
{
"_class": "person",
"oid": 1182,
"name": "Alexander Yuen",
"userid": "033733",
"barcode": null
},
{
"_class": "person",
"oid": 1353,
"name": "Mark Yu",
"userid": "073798",
"barcode": null
},
{
"_class": "person",
"oid": 1194,
"name": "Georgina York",
"userid": "076898",
"barcode": null
},
{
"_class": "person",
"oid": 1202,
"name": "Lucy Yoon",
"userid": "082767",
"barcode": null
},
{
"_class": "person",
"oid": 1424,
"name": "Aaron Yoon",
"userid": "089183",
"barcode": null
},
{
"_class": "person",
"oid": 1003,
"name": "Emma Yi",
"userid": "042612",
"barcode": null
},
{
"_class": "person",
"oid": 1085,
"name": "Yong-Ho Yi",
"userid": "085305",
"barcode": null
},
{
"_class": "person",
"oid": 1366,
"name": "Lauren Ye",
"userid": "001985",
"barcode": null
},
{
"_class": "person",
"oid": 1209,
"name": "Yebin Yates",
"userid": "008249",
"barcode": null
},
{
"_class": "person",
"oid": 1410,
"name": "Isaiah Yanson",
"userid": "097733",
"barcode": null
},
{
"_class": "person",
"oid": 1114,
"name": "Evan Yang",
"userid": "002833",
"barcode": null
},
{
"_class": "person",
"oid": 1076,
"name": "Julia Yang",
"userid": "057007",
"barcode": null
},
{
"_class": "person",
"oid": 1248,
"name": "Stephany Yan",
"userid": "051147",
"barcode": null
},
{
"_class": "person",
"oid": 1241,
"name": "Jing Wugbunski",
"userid": "066588",
"barcode": null
},
{
"_class": "person",
"oid": 1498,
"name": "Jiro Wu",
"userid": "068095",
"barcode": null
},
{
"_class": "person",
"oid": 1358,
"name": "Monica Worley",
"userid": "039226",
"barcode": null
},
{
"_class": "person",
"oid": 2,
"name": "Window Worker",
"userid": "wworker",
"barcode": null
},
{
"_class": "person",
"oid": 1354,
"name": "Matthew Woodward",
"userid": "082905",
"barcode": null
},
{
"_class": "person",
"oid": 1023,
"name": "Lyndsey Woodfin",
"userid": "068925",
"barcode": null
},
{
"_class": "person",
"oid": 1228,
"name": "Margaret Won",
"userid": "052356",
"barcode": null
},
{
"_class": "person",
"oid": 1119,
"name": "Brielle Wolfe",
"userid": "071998",
"barcode": null
},
{
"_class": "person",
"oid": 1257,
"name": "Chris Wohlgemuth",
"userid": "025809",
"barcode": null
},
{
"_class": "person",
"oid": 1373,
"name": "Christiana Witkowski",
"userid": "046072",
"barcode": null
},
{
"_class": "person",
"oid": 1464,
"name": "Meaghan Winter",
"userid": "096007",
"barcode": null
},
{
"_class": "person",
"oid": 1421,
"name": "Jacob Wilson",
"userid": "019819",
"barcode": null
},
{
"_class": "person",
"oid": 1309,
"name": "Khadijah Wilson",
"userid": "036256",
"barcode": null
},
{
"_class": "person",
"oid": 1489,
"name": "Dalit Wilmore",
"userid": "050470",
"barcode": null
},
{
"_class": "person",
"oid": 1159,
"name": "Dongwook Williamson",
"userid": "019431",
"barcode": null
},
{
"_class": "person",
"oid": 1090,
"name": "Renee Williams",
"userid": "015611",
"barcode": null
},
{
"_class": "person",
"oid": 1021,
"name": "Connor Williams",
"userid": "031469",
"barcode": null
},
{
"_class": "person",
"oid": 1301,
"name": "Dean Williams",
"userid": "033879",
"barcode": null
},
{
"_class": "person",
"oid": 1136,
"name": "Josue Williams",
"userid": "075082",
"barcode": null
},
{
"_class": "person",
"oid": 1281,
"name": "Madelene Whitaker",
"userid": "054437",
"barcode": null
},
{
"_class": "person",
"oid": 1396,
"name": "Tamar West",
"userid": "013038",
"barcode": null
},
{
"_class": "person",
"oid": 1036,
"name": "Norman Wells",
"userid": "011425",
"barcode": null
},
{
"_class": "person",
"oid": 1206,
"name": "Aaron Weissman",
"userid": "056621",
"barcode": null
},
{
"_class": "person",
"oid": 1161,
"name": "Judith Weingarten",
"userid": "086039",
"barcode": null
},
{
"_class": "person",
"oid": 1304,
"name": "Shushan Weatherly",
"userid": "036510",
"barcode": null
},
{
"_class": "person",
"oid": 1262,
"name": "Eugene Watson",
"userid": "020957",
"barcode": null
},
{
"_class": "person",
"oid": 1067,
"name": "Arella Warren",
"userid": "006147",
"barcode": null
},
{
"_class": "person",
"oid": 1402,
"name": "Gabriela Warner",
"userid": "063638",
"barcode": null
},
{
"_class": "person",
"oid": 1179,
"name": "Jason Villarreal",
"userid": "078179",
"barcode": null
},
{
"_class": "person",
"oid": 1000,
"name": "Brian Villanueva",
"userid": "056474",
"barcode": null
},
{
"_class": "person",
"oid": 1449,
"name": "Xiao Vickery",
"userid": "060596",
"barcode": null
},
{
"_class": "person",
"oid": 1315,
"name": "Michael Velasquez",
"userid": "042682",
"barcode": null
},
{
"_class": "person",
"oid": 1126,
"name": "Dory Vargas",
"userid": "031839",
"barcode": null
},
{
"_class": "person",
"oid": 1395,
"name": "Shiloh Vargas",
"userid": "045228",
"barcode": null
},
{
"_class": "person",
"oid": 1379,
"name": "Karen Van Wie",
"userid": "095822",
"barcode": null
},
{
"_class": "person",
"oid": 1107,
"name": "Melany Van Dyke",
"userid": "036067",
"barcode": null
},
{
"_class": "person",
"oid": 1123,
"name": "Mitzi Vandergrift",
"userid": "078981",
"barcode": null
},
{
"_class": "person",
"oid": 1415,
"name": "Courtney Van Den Berg",
"userid": "056145",
"barcode": null
},
{
"_class": "person",
"oid": 1434,
"name": "Andrew Valseca",
"userid": "008158",
"barcode": null
},
{
"_class": "person",
"oid": 1486,
"name": "Daniel Um",
"userid": "037621",
"barcode": null
},
{
"_class": "person",
"oid": 1493,
"name": "Devan Tucker",
"userid": "079226",
"barcode": null
},
{
"_class": "person",
"oid": 1339,
"name": "Soo Jin Tran",
"userid": "037363",
"barcode": null
},
{
"_class": "person",
"oid": 1405,
"name": "Dan Tran",
"userid": "040949",
"barcode": null
},
{
"_class": "person",
"oid": 1234,
"name": "Georgina Tran",
"userid": "053666",
"barcode": null
},
{
"_class": "person",
"oid": 1340,
"name": "Seth Trammel",
"userid": "031665",
"barcode": null
},
{
"_class": "person",
"oid": 1157,
"name": "Emma Tracker",
"userid": "036433",
"barcode": null
},
{
"_class": "person",
"oid": 1211,
"name": "Dauren Tovmasian",
"userid": "058094",
"barcode": null
},
{
"_class": "person",
"oid": 1214,
"name": "Kristiyana Toledano",
"userid": "060060",
"barcode": null
},
{
"_class": "person",
"oid": 1279,
"name": "Fred Tipton",
"userid": "015482",
"barcode": null
},
{
"_class": "person",
"oid": 1335,
"name": "Richard Tiongco",
"userid": "003455",
"barcode": null
},
{
"_class": "person",
"oid": 1149,
"name": "Carrie Tillmann",
"userid": "018617",
"barcode": null
},
{
"_class": "person",
"oid": 1439,
"name": "Amy Thordarson",
"userid": "007158",
"barcode": null
},
{
"_class": "person",
"oid": 1030,
"name": "Patricia Thomsen",
"userid": "085768",
"barcode": null
},
{
"_class": "person",
"oid": 1032,
"name": "Laura Thomas",
"userid": "084207",
"barcode": null
},
{
"_class": "person",
"oid": 1226,
"name": "Laurence Themer",
"userid": "060943",
"barcode": null
},
{
"_class": "person",
"oid": 1124,
"name": "Andrew Terrazas",
"userid": "060724",
"barcode": null
},
{
"_class": "person",
"oid": 1192,
"name": "Shan Tenpas",
"userid": "044143",
"barcode": null
},
{
"_class": "person",
"oid": 1443,
"name": "Anush Tavoni",
"userid": "018271",
"barcode": null
},
{
"_class": "person",
"oid": 1087,
"name": "Tina Tao",
"userid": "030726",
"barcode": null
},
{
"_class": "person",
"oid": 1370,
"name": "Jaclyn Tambling",
"userid": "035978",
"barcode": null
},
{
"_class": "person",
"oid": 1400,
"name": "Mark Takamoto",
"userid": "083511",
"barcode": null
},
{
"_class": "person",
"oid": 1139,
"name": "Hyun Takahashi",
"userid": "055827",
"barcode": null
},
{
"_class": "person",
"oid": 1404,
"name": "Esai Tagle",
"userid": "039795",
"barcode": null
},
{
"_class": "person",
"oid": 1075,
"name": "Anna Sweeney",
"userid": "041020",
"barcode": null
},
{
"_class": "person",
"oid": 1291,
"name": "Julie Sung",
"userid": "060377",
"barcode": null
},
{
"_class": "person",
"oid": 1417,
"name": "Calvin Sudduth",
"userid": "052080",
"barcode": null
},
{
"_class": "person",
"oid": 1034,
"name": "Seoh Rahn Su",
"userid": "010931",
"barcode": null
},
{
"_class": "person",
"oid": 1324,
"name": "Juliana Stuckelman",
"userid": "058454",
"barcode": null
},
{
"_class": "person",
"oid": 1063,
"name": "Thomas Stratton",
"userid": "065869",
"barcode": null
},
{
"_class": "person",
"oid": 1471,
"name": "Howard Stark",
"userid": "048575",
"barcode": null
},
{
"_class": "person",
"oid": 1237,
"name": "Steven Speirs",
"userid": "076205",
"barcode": null
},
{
"_class": "person",
"oid": 1327,
"name": "Lauren Sornpainan",
"userid": "038688",
"barcode": null
},
{
"_class": "person",
"oid": 1020,
"name": "Johnathan Song",
"userid": "030722",
"barcode": null
},
{
"_class": "person",
"oid": 1312,
"name": "Barton Sondergaard",
"userid": "011880",
"barcode": null
},
{
"_class": "person",
"oid": 1268,
"name": "Moinama Sofronas",
"userid": "030268",
"barcode": null
},
{
"_class": "person",
"oid": 1215,
"name": "John Smith",
"userid": "054016",
"barcode": null
},
{
"_class": "person",
"oid": 1122,
"name": "Joni Slegr",
"userid": "048942",
"barcode": null
},
{
"_class": "person",
"oid": 1351,
"name": "Alexandra Sisson",
"userid": "004900",
"barcode": null
},
{
"_class": "person",
"oid": 1152,
"name": "Sydney Sidle",
"userid": "019695",
"barcode": null
},
{
"_class": "person",
"oid": 1465,
"name": "Michael Shon",
"userid": "067457",
"barcode": null
},
{
"_class": "person",
"oid": 1316,
"name": "Kassia Shin",
"userid": "006124",
"barcode": null
},
{
"_class": "person",
"oid": 1217,
"name": "Alejandro Shim",
"userid": "095602",
"barcode": null
},
{
"_class": "person",
"oid": 1078,
"name": "Sarah Shen",
"userid": "045886",
"barcode": null
},
{
"_class": "person",
"oid": 1079,
"name": "Angus Seo",
"userid": "000354",
"barcode": null
},
{
"_class": "person",
"oid": 1142,
"name": "Stephan Senegal",
"userid": "011271",
"barcode": null
},
{
"_class": "person",
"oid": 1406,
"name": "Bill Schmetter",
"userid": "076535",
"barcode": null
},
{
"_class": "person",
"oid": 1135,
"name": "Jennifer Schali",
"userid": "024393",
"barcode": null
},
{
"_class": "person",
"oid": 1285,
"name": "Kevin Sargsyan",
"userid": "016378",
"barcode": null
},
{
"_class": "person",
"oid": 1300,
"name": "Sabrina Santamaria",
"userid": "044851",
"barcode": null
},
{
"_class": "person",
"oid": 1392,
"name": "Harriet Sanghyun",
"userid": "024828",
"barcode": null
},
{
"_class": "person",
"oid": 1230,
"name": "Brian Samaniego",
"userid": "077691",
"barcode": null
},
{
"_class": "person",
"oid": 1431,
"name": "Debbie Salaff",
"userid": "026923",
"barcode": null
},
{
"_class": "person",
"oid": 1200,
"name": "Judy Sakai",
"userid": "005636",
"barcode": null
},
{
"_class": "person",
"oid": 1477,
"name": "Terianne Sa",
"userid": "069525",
"barcode": null
},
{
"_class": "person",
"oid": 1185,
"name": "Breanna Ruiz",
"userid": "065772",
"barcode": null
},
{
"_class": "person",
"oid": 1454,
"name": "Chelsea Ruegger",
"userid": "016287",
"barcode": null
},
{
"_class": "person",
"oid": 1111,
"name": "Jae-Sung Ruegger",
"userid": "080513",
"barcode": null
},
{
"_class": "person",
"oid": 1236,
"name": "Juan Rowe",
"userid": "035278",
"barcode": null
},
{
"_class": "person",
"oid": 1249,
"name": "Alexxa Rose",
"userid": "048678",
"barcode": null
},
{
"_class": "person",
"oid": 1399,
"name": "Daniel Ronak",
"userid": "086959",
"barcode": null
},
{
"_class": "person",
"oid": 1193,
"name": "Robin Romero",
"userid": "084211",
"barcode": null
},
{
"_class": "person",
"oid": 1015,
"name": "Salama Roman",
"userid": "029896",
"barcode": null
},
{
"_class": "person",
"oid": 1190,
"name": "Richard Rojas",
"userid": "063367",
"barcode": null
},
{
"_class": "person",
"oid": 1448,
"name": "Land Roberts",
"userid": "066196",
"barcode": null
},
{
"_class": "person",
"oid": 1137,
"name": "Deborah Roberts",
"userid": "082348",
"barcode": null
},
{
"_class": "person",
"oid": 1134,
"name": "Leif Rivas",
"userid": "060161",
"barcode": null
},
{
"_class": "person",
"oid": 1043,
"name": "Jensen Ritchie",
"userid": "095967",
"barcode": null
},
{
"_class": "person",
"oid": 1394,
"name": "Lynn Richmond",
"userid": "051987",
"barcode": null
},
{
"_class": "person",
"oid": 1052,
"name": "Nancy Rich",
"userid": "035893",
"barcode": null
},
{
"_class": "person",
"oid": 1455,
"name": "Alan Reiter",
"userid": "086607",
"barcode": null
},
{
"_class": "person",
"oid": 1467,
"name": "Jocelyne Reilly",
"userid": "025637",
"barcode": null
},
{
"_class": "person",
"oid": 1432,
"name": "Sze Yu Charlene Rapp",
"userid": "006923",
"barcode": null
},
{
"_class": "person",
"oid": 1275,
"name": "Olivia Ramos",
"userid": "092360",
"barcode": null
},
{
"_class": "person",
"oid": 1295,
"name": "Yoo Jin Ramirez",
"userid": "039243",
"barcode": null
},
{
"_class": "person",
"oid": 1140,
"name": "Jonathan Ramirez",
"userid": "041721",
"barcode": null
},
{
"_class": "person",
"oid": 1451,
"name": "Krystal Ramirez",
"userid": "044899",
"barcode": null
},
{
"_class": "person",
"oid": 1112,
"name": "Courtney Ramirez",
"userid": "074462",
"barcode": null
},
{
"_class": "person",
"oid": 1497,
"name": "Natalie Principato",
"userid": "060463",
"barcode": null
},
{
"_class": "person",
"oid": 1224,
"name": "Yuchiun Prestella",
"userid": "089682",
"barcode": null
},
{
"_class": "person",
"oid": 1265,
"name": "Monica Popova",
"userid": "045436",
"barcode": null
},
{
"_class": "person",
"oid": 1143,
"name": "Ara Platt",
"userid": "080229",
"barcode": null
},
{
"_class": "person",
"oid": 1263,
"name": "Deidre Piring",
"userid": "047349",
"barcode": null
},
{
"_class": "person",
"oid": 1092,
"name": "Kenneth Pieroni",
"userid": "029085",
"barcode": null
},
{
"_class": "person",
"oid": 1428,
"name": "Alex Pierce",
"userid": "049209",
"barcode": null
},
{
"_class": "person",
"oid": 1091,
"name": "Clarence Perez",
"userid": "037421",
"barcode": null
},
{
"_class": "person",
"oid": 1413,
"name": "Hye Eun Perez",
"userid": "086734",
"barcode": null
},
{
"_class": "person",
"oid": 1362,
"name": "Kenneth Perales",
"userid": "086396",
"barcode": null
},
{
"_class": "person",
"oid": 1331,
"name": "Gerard Pels",
"userid": "092525",
"barcode": null
},
{
"_class": "person",
"oid": 1326,
"name": "Carolyn Pelayo",
"userid": "052095",
"barcode": null
},
{
"_class": "person",
"oid": 1004,
"name": "Gaby Peabody",
"userid": "099997",
"barcode": null
},
{
"_class": "person",
"oid": 1207,
"name": "Katherine Patron",
"userid": "041957",
"barcode": null
},
{
"_class": "person",
"oid": 1144,
"name": "Aaron Park",
"userid": "043874",
"barcode": null
},
{
"_class": "person",
"oid": 1246,
"name": "Diego Park",
"userid": "054783",
"barcode": null
},
{
"_class": "person",
"oid": 1381,
"name": "Justin Park",
"userid": "059860",
"barcode": null
},
{
"_class": "person",
"oid": 1066,
"name": "Rafael Park",
"userid": "061063",
"barcode": null
},
{
"_class": "person",
"oid": 1001,
"name": "Karen Palermo",
"userid": "023688",
"barcode": null
},
{
"_class": "person",
"oid": 1222,
"name": "Cindy Ouye",
"userid": "032589",
"barcode": null
},
{
"_class": "person",
"oid": 1072,
"name": "Micah Ouyang",
"userid": "037332",
"barcode": null
},
{
"_class": "person",
"oid": 1212,
"name": "Max O'Sullivan",
"userid": "031766",
"barcode": null
},
{
"_class": "person",
"oid": 1401,
"name": "Maria Ortega",
"userid": "089331",
"barcode": null
},
{
"_class": "person",
"oid": 1129,
"name": "Andrew O'Rourke",
"userid": "033036",
"barcode": null
},
{
"_class": "person",
"oid": 1195,
"name": "Naomi Optics",
"userid": "034622",
"barcode": null
},
{
"_class": "person",
"oid": 1365,
"name": "Due Sung Omidvar",
"userid": "034794",
"barcode": null
},
{
"_class": "person",
"oid": 1321,
"name": "Jody Omidvar",
"userid": "080538",
"barcode": null
},
{
"_class": "person",
"oid": 1341,
"name": "Olivia O'Malley",
"userid": "020337",
"barcode": null
},
{
"_class": "person",
"oid": 1223,
"name": "Zhong Olivieri",
"userid": "009349",
"barcode": null
},
{
"_class": "person",
"oid": 1479,
"name": "Tony Oh",
"userid": "076057",
"barcode": null
},
{
"_class": "person",
"oid": 1445,
"name": "Yoon Oganyan",
"userid": "045460",
"barcode": null
},
{
"_class": "person",
"oid": 1425,
"name": "Marianne Nyburg",
"userid": "052207",
"barcode": null
},
{
"_class": "person",
"oid": 1492,
"name": "Tiffany Norman",
"userid": "023689",
"barcode": null
},
{
"_class": "person",
"oid": 1150,
"name": "Brian Norman",
"userid": "086451",
"barcode": null
},
{
"_class": "person",
"oid": 1170,
"name": "Elliot Nonles",
"userid": "044543",
"barcode": null
},
{
"_class": "person",
"oid": 1088,
"name": "Andrew Nien",
"userid": "044444",
"barcode": null
},
{
"_class": "person",
"oid": 1171,
"name": "Karen Nichols",
"userid": "065183",
"barcode": null
},
{
"_class": "person",
"oid": 1095,
"name": "Zack Nichols",
"userid": "091869",
"barcode": null
},
{
"_class": "person",
"oid": 1120,
"name": "Alyson Nguyen",
"userid": "038964",
"barcode": null
},
{
"_class": "person",
"oid": 1148,
"name": "Elizabeth Ng",
"userid": "007314",
"barcode": null
},
{
"_class": "person",
"oid": 1278,
"name": "Eric Navarro",
"userid": "069970",
"barcode": null
},
{
"_class": "person",
"oid": 1167,
"name": "Jung Hyuk Nam",
"userid": "081923",
"barcode": null
},
{
"_class": "person",
"oid": 1361,
"name": "Chloe Myung",
"userid": "025061",
"barcode": null
},
{
"_class": "person",
"oid": 1490,
"name": "Katherine Denis Mulvihill",
"userid": "031347",
"barcode": null
},
{
"_class": "person",
"oid": 1414,
"name": "Samuel Mueller",
"userid": "082706",
"barcode": null
},
{
"_class": "person",
"oid": 1348,
"name": "Jeremy Morritt",
"userid": "005378",
"barcode": null
},
{
"_class": "person",
"oid": 1083,
"name": "Tae-Hyun Morris",
"userid": "064414",
"barcode": null
},
{
"_class": "person",
"oid": 1290,
"name": "Sam Moritz",
"userid": "098571",
"barcode": null
},
{
"_class": "person",
"oid": 1367,
"name": "Kevin Morinaga",
"userid": "049879",
"barcode": null
},
{
"_class": "person",
"oid": 1029,
"name": "Mary Morelli",
"userid": "033774",
"barcode": null
},
{
"_class": "person",
"oid": 1277,
"name": "Claire Montes",
"userid": "060174",
"barcode": null
},
{
"_class": "person",
"oid": 1016,
"name": "Ismael Monninger",
"userid": "071268",
"barcode": null
},
{
"_class": "person",
"oid": 1242,
"name": "Justina Modi",
"userid": "051586",
"barcode": null
},
{
"_class": "person",
"oid": 1047,
"name": "Estella Miya",
"userid": "078370",
"barcode": null
},
{
"_class": "person",
"oid": 1173,
"name": "Che-Yu Mitchell",
"userid": "085437",
"barcode": null
},
{
"_class": "person",
"oid": 1189,
"name": "Qiushuo Milovanovic",
"userid": "037886",
"barcode": null
},
{
"_class": "person",
"oid": 1163,
"name": "Jenice Millar",
"userid": "058200",
"barcode": null
},
{
"_class": "person",
"oid": 1307,
"name": "Emily Michael",
"userid": "057656",
"barcode": null
},
{
"_class": "person",
"oid": 1485,
"name": "Linda Meeks",
"userid": "009654",
"barcode": null
},
{
"_class": "person",
"oid": 1391,
"name": "Christen McNatt",
"userid": "064527",
"barcode": null
},
{
"_class": "person",
"oid": 1106,
"name": "Chiara McMillan",
"userid": "015846",
"barcode": null
},
{
"_class": "person",
"oid": 1094,
"name": "Ronald McDonald",
"userid": "064751",
"barcode": null
},
{
"_class": "person",
"oid": 1132,
"name": "Terence McCoy",
"userid": "054547",
"barcode": null
},
{
"_class": "person",
"oid": 1287,
"name": "Tianxu McCann",
"userid": "034969",
"barcode": null
},
{
"_class": "person",
"oid": 1284,
"name": "Michael Mayabb",
"userid": "076328",
"barcode": null
},
{
"_class": "person",
"oid": 1175,
"name": "Lydia Matlock",
"userid": "007051",
"barcode": null
},
{
"_class": "person",
"oid": 1160,
"name": "Reese Mason",
"userid": "090600",
"barcode": null
},
{
"_class": "person",
"oid": 1225,
"name": "Hope Maschmeyer",
"userid": "019740",
"barcode": null
},
{
"_class": "person",
"oid": 1153,
"name": "SeungA Marx",
"userid": "020333",
"barcode": null
},
{
"_class": "person",
"oid": 1141,
"name": "Isabella Martz",
"userid": "048264",
"barcode": null
},
{
"_class": "person",
"oid": 1393,
"name": "Esmeralda Martling",
"userid": "036537",
"barcode": null
},
{
"_class": "person",
"oid": 1388,
"name": "Mee Martinez",
"userid": "023818",
"barcode": null
},
{
"_class": "person",
"oid": 1017,
"name": "Erin Martinez",
"userid": "079979",
"barcode": null
},
{
"_class": "person",
"oid": 1294,
"name": "Jonathan Martinez",
"userid": "085629",
"barcode": null
},
{
"_class": "person",
"oid": 1019,
"name": "Ginah Marlos",
"userid": "029107",
"barcode": null
},
{
"_class": "person",
"oid": 1005,
"name": "James Mandel",
"userid": "083627",
"barcode": null
},
{
"_class": "person",
"oid": 1099,
"name": "Victor Maltese",
"userid": "051362",
"barcode": null
},
{
"_class": "person",
"oid": 1441,
"name": "Michael-Ann Maisano",
"userid": "093452",
"barcode": null
},
{
"_class": "person",
"oid": 1253,
"name": "Faustine Magana",
"userid": "061024",
"barcode": null
},
{
"_class": "person",
"oid": 1347,
"name": "Shoghak MacKett",
"userid": "052208",
"barcode": null
},
{
"_class": "person",
"oid": 1024,
"name": "Laura Luk",
"userid": "011953",
"barcode": null
},
{
"_class": "person",
"oid": 1201,
"name": "Camille Luce",
"userid": "091930",
"barcode": null
},
{
"_class": "person",
"oid": 1499,
"name": "David Loyd",
"userid": "028316",
"barcode": null
},
{
"_class": "person",
"oid": 1456,
"name": "Natasha Loiso",
"userid": "069529",
"barcode": null
},
{
"_class": "person",
"oid": 1008,
"name": "Ryan Logozio",
"userid": "050201",
"barcode": null
},
{
"_class": "person",
"oid": 1346,
"name": "Junwoo Loftis",
"userid": "039179",
"barcode": null
},
{
"_class": "person",
"oid": 1232,
"name": "Anna Lockwood",
"userid": "092899",
"barcode": null
},
{
"_class": "person",
"oid": 1247,
"name": "Rob Liu",
"userid": "014028",
"barcode": null
},
{
"_class": "person",
"oid": 1469,
"name": "Chloe Liu",
"userid": "051537",
"barcode": null
},
{
"_class": "person",
"oid": 1203,
"name": "Ana Liu",
"userid": "058575",
"barcode": null
},
{
"_class": "person",
"oid": 1058,
"name": "Laura Liu",
"userid": "076987",
"barcode": null
},
{
"_class": "person",
"oid": 1496,
"name": "Christine Liou",
"userid": "081122",
"barcode": null
},
{
"_class": "person",
"oid": 1027,
"name": "Mirena Lin",
"userid": "001298",
"barcode": null
},
{
"_class": "person",
"oid": 1062,
"name": "Keith Lin",
"userid": "031290",
"barcode": null
},
{
"_class": "person",
"oid": 1466,
"name": "Lindsay Lin",
"userid": "074869",
"barcode": null
},
{
"_class": "person",
"oid": 1033,
"name": "John Lin",
"userid": "084745",
"barcode": null
},
{
"_class": "person",
"oid": 1184,
"name": "Heather Lin",
"userid": "087080",
"barcode": null
},
{
"_class": "person",
"oid": 1183,
"name": "Puneet Lin",
"userid": "097882",
"barcode": null
},
{
"_class": "person",
"oid": 1352,
"name": "Nicole Lim",
"userid": "037106",
"barcode": null
},
{
"_class": "person",
"oid": 1186,
"name": "Lily Lim",
"userid": "050943",
"barcode": null
},
{
"_class": "person",
"oid": 1408,
"name": "Sally Lim",
"userid": "059514",
"barcode": null
},
{
"_class": "person",
"oid": 1332,
"name": "Christine Lim",
"userid": "091407",
"barcode": null
},
{
"_class": "person",
"oid": 1031,
"name": "Jeremy Liao",
"userid": "048462",
"barcode": null
},
{
"_class": "person",
"oid": 1416,
"name": "Brian Li",
"userid": "090114",
"barcode": null
},
{
"_class": "person",
"oid": 1154,
"name": "Jennifer Lemus",
"userid": "034709",
"barcode": null
},
{
"_class": "person",
"oid": 1060,
"name": "Laura Lee",
"userid": "025168",
"barcode": null
},
{
"_class": "person",
"oid": 1494,
"name": "Gary Lee",
"userid": "029461",
"barcode": null
},
{
"_class": "person",
"oid": 1299,
"name": "Carl Lee",
"userid": "031844",
"barcode": null
},
{
"_class": "person",
"oid": 1221,
"name": "Carlos Lee",
"userid": "035339",
"barcode": null
},
{
"_class": "person",
"oid": 1158,
"name": "Anne Lee",
"userid": "035351",
"barcode": null
},
{
"_class": "person",
"oid": 1269,
"name": "Elaine Lee",
"userid": "043183",
"barcode": null
},
{
"_class": "person",
"oid": 1151,
"name": "Nicolas Lee",
"userid": "051721",
"barcode": null
},
{
"_class": "person",
"oid": 1240,
"name": "Jake Lee",
"userid": "083420",
"barcode": null
},
{
"_class": "person",
"oid": 1198,
"name": "Helen Lee",
"userid": "084558",
"barcode": null
},
{
"_class": "person",
"oid": 1447,
"name": "David Ledesma",
"userid": "022007",
"barcode": null
},
{
"_class": "person",
"oid": 1357,
"name": "Julian Leal",
"userid": "040607",
"barcode": null
},
{
"_class": "person",
"oid": 1074,
"name": "Shannon Le",
"userid": "035711",
"barcode": null
},
{
"_class": "person",
"oid": 1293,
"name": "Brian Lawrence",
"userid": "018836",
"barcode": null
},
{
"_class": "person",
"oid": 1397,
"name": "Yasara Lauridsen",
"userid": "099999",
"barcode": null
},
{
"_class": "person",
"oid": 1035,
"name": "Joshua Larasati",
"userid": "012640",
"barcode": null
},
{
"_class": "person",
"oid": 1220,
"name": "Michael Lanz",
"userid": "021970",
"barcode": null
},
{
"_class": "person",
"oid": 1273,
"name": "Francis Lans",
"userid": "018572",
"barcode": null
},
{
"_class": "person",
"oid": 1065,
"name": "Nancy Landau",
"userid": "086868",
"barcode": null
},
{
"_class": "person",
"oid": 1084,
"name": "Jessica Laing",
"userid": "062215",
"barcode": null
},
{
"_class": "person",
"oid": 1040,
"name": "Jose Labib",
"userid": "018149",
"barcode": null
},
{
"_class": "person",
"oid": 1271,
"name": "Raymond Kwon",
"userid": "026175",
"barcode": null
},
{
"_class": "person",
"oid": 1096,
"name": "Mary Kwon",
"userid": "031568",
"barcode": null
},
{
"_class": "person",
"oid": 1292,
"name": "Angella Kwon",
"userid": "091375",
"barcode": null
},
{
"_class": "person",
"oid": 1131,
"name": "Mari Kwok",
"userid": "023235",
"barcode": null
},
{
"_class": "person",
"oid": 1422,
"name": "Karan Kuo",
"userid": "015040",
"barcode": null
},
{
"_class": "person",
"oid": 1409,
"name": "Jessica Kulakoff",
"userid": "055978",
"barcode": null
},
{
"_class": "person",
"oid": 1180,
"name": "Yong Koyama",
"userid": "096098",
"barcode": null
},
{
"_class": "person",
"oid": 1462,
"name": "Lydier Kossakovski",
"userid": "049480",
"barcode": null
},
{
"_class": "person",
"oid": 1426,
"name": "Suzanna Koop",
"userid": "091088",
"barcode": null
},
{
"_class": "person",
"oid": 1376,
"name": "Schunn Kollmeier",
"userid": "001320",
"barcode": null
},
{
"_class": "person",
"oid": 1423,
"name": "Muhammad Kogahara",
"userid": "048855",
"barcode": null
},
{
"_class": "person",
"oid": 1286,
"name": "Claire Klein",
"userid": "071552",
"barcode": null
},
{
"_class": "person",
"oid": 1177,
"name": "Mark Kitayama",
"userid": "083702",
"barcode": null
},
{
"_class": "person",
"oid": 1048,
"name": "Darlene Kirkeby",
"userid": "082059",
"barcode": null
},
{
"_class": "person",
"oid": 1444,
"name": "Michael Kirakossian",
"userid": "034287",
"barcode": null
},
{
"_class": "person",
"oid": 1435,
"name": "Paulina Kim",
"userid": "024945",
"barcode": null
},
{
"_class": "person",
"oid": 1165,
"name": "Jeff Kim",
"userid": "043383",
"barcode": null
},
{
"_class": "person",
"oid": 1013,
"name": "SoYun Kim",
"userid": "044916",
"barcode": null
},
{
"_class": "person",
"oid": 1495,
"name": "Ru Ry Kim",
"userid": "056779",
"barcode": null
},
{
"_class": "person",
"oid": 1166,
"name": "Gerardo Kim",
"userid": "061975",
"barcode": null
},
{
"_class": "person",
"oid": 1014,
"name": "Daniel Kim",
"userid": "063003",
"barcode": null
},
{
"_class": "person",
"oid": 1343,
"name": "Christopher Kim",
"userid": "068105",
"barcode": null
},
{
"_class": "person",
"oid": 1459,
"name": "Dalia Kim",
"userid": "069747",
"barcode": null
},
{
"_class": "person",
"oid": 1196,
"name": "Jenny Kim",
"userid": "073877",
"barcode": null
},
{
"_class": "person",
"oid": 1093,
"name": "Virginia Kim",
"userid": "081401",
"barcode": null
},
{
"_class": "person",
"oid": 1488,
"name": "David Kim",
"userid": "083596",
"barcode": null
},
{
"_class": "person",
"oid": 1349,
"name": "Rhyna Keshavarz",
"userid": "064969",
"barcode": null
},
{
"_class": "person",
"oid": 1302,
"name": "Kevin Keeffe",
"userid": "036439",
"barcode": null
},
{
"_class": "person",
"oid": 1280,
"name": "Peter Kaveh",
"userid": "071807",
"barcode": null
},
{
"_class": "person",
"oid": 1098,
"name": "Taewan Kasparian",
"userid": "082696",
"barcode": null
},
{
"_class": "person",
"oid": 1127,
"name": "Maria Kao",
"userid": "035628",
"barcode": null
},
{
"_class": "person",
"oid": 1071,
"name": "Mauricio Kang",
"userid": "008683",
"barcode": null
},
{
"_class": "person",
"oid": 1251,
"name": "Eugene Kanemaru",
"userid": "065353",
"barcode": null
},
{
"_class": "person",
"oid": 1080,
"name": "Andrew Kaminski",
"userid": "043395",
"barcode": null
},
{
"_class": "person",
"oid": 1473,
"name": "Miguel Jung",
"userid": "032137",
"barcode": null
},
{
"_class": "person",
"oid": 1188,
"name": "Lauren Juette",
"userid": "015234",
"barcode": null
},
{
"_class": "person",
"oid": 1229,
"name": "Nora Jorgensen",
"userid": "098318",
"barcode": null
},
{
"_class": "person",
"oid": 1475,
"name": "Jennifer Johnson",
"userid": "025694",
"barcode": null
},
{
"_class": "person",
"oid": 1176,
"name": "Oliver Johnson",
"userid": "084043",
"barcode": null
},
{
"_class": "person",
"oid": 1487,
"name": "Arthur Job",
"userid": "093692",
"barcode": null
},
{
"_class": "person",
"oid": 1199,
"name": "Jessica Jimenez",
"userid": "002803",
"barcode": null
},
{
"_class": "person",
"oid": 1440,
"name": "Burton Jimenez",
"userid": "032360",
"barcode": null
},
{
"_class": "person",
"oid": 1478,
"name": "Eric Jeong",
"userid": "001876",
"barcode": null
},
{
"_class": "person",
"oid": 1238,
"name": "Peter Jeon",
"userid": "047582",
"barcode": null
},
{
"_class": "person",
"oid": 1002,
"name": "Oswaldo Jenks",
"userid": "068999",
"barcode": null
},
{
"_class": "person",
"oid": 1056,
"name": "Stephanie Jegede",
"userid": "094165",
"barcode": null
},
{
"_class": "person",
"oid": 1037,
"name": "Steven Jaya",
"userid": "038319",
"barcode": null
},
{
"_class": "person",
"oid": 1254,
"name": "Timothy Jacobs",
"userid": "094222",
"barcode": null
},
{
"_class": "person",
"oid": 1117,
"name": "Alexandra Issakharian",
"userid": "020360",
"barcode": null
},
{
"_class": "person",
"oid": 1081,
"name": "Garrett Ismael",
"userid": "054477",
"barcode": null
},
{
"_class": "person",
"oid": 1041,
"name": "Eric Ismael",
"userid": "062651",
"barcode": null
},
{
"_class": "person",
"oid": 1433,
"name": "Anthony Isherwood",
"userid": "074518",
"barcode": null
},
{
"_class": "person",
"oid": 1028,
"name": "Jeffrey Isenberg",
"userid": "085600",
"barcode": null
},
{
"_class": "person",
"oid": 1418,
"name": "Tiffany Hwang",
"userid": "006129",
"barcode": null
},
{
"_class": "person",
"oid": 1243,
"name": "Allison Hwang",
"userid": "074832",
"barcode": null
},
{
"_class": "person",
"oid": 1320,
"name": "Sheri Hursey",
"userid": "080507",
"barcode": null
},
{
"_class": "person",
"oid": 1484,
"name": "Will Hunt",
"userid": "093525",
"barcode": null
},
{
"_class": "person",
"oid": 1372,
"name": "Simon Huh",
"userid": "097597",
"barcode": null
},
{
"_class": "person",
"oid": 1314,
"name": "Breanne Hudson",
"userid": "084305",
"barcode": null
},
{
"_class": "person",
"oid": 1113,
"name": "Goldie Huang",
"userid": "007291",
"barcode": null
},
{
"_class": "person",
"oid": 1382,
"name": "Jung Huang",
"userid": "085559",
"barcode": null
},
{
"_class": "person",
"oid": 1371,
"name": "Robert Hu",
"userid": "016221",
"barcode": null
},
{
"_class": "person",
"oid": 1128,
"name": "Jose Hsu",
"userid": "049862",
"barcode": null
},
{
"_class": "person",
"oid": 1044,
"name": "Hakyung Horwitz",
"userid": "073264",
"barcode": null
},
{
"_class": "person",
"oid": 1169,
"name": "Pei-Yin Hoppe",
"userid": "093473",
"barcode": null
},
{
"_class": "person",
"oid": 1325,
"name": "Shirley Hope",
"userid": "063659",
"barcode": null
},
{
"_class": "person",
"oid": 1334,
"name": "Michael Hong",
"userid": "009590",
"barcode": null
},
{
"_class": "person",
"oid": 1289,
"name": "Robert Hong",
"userid": "020388",
"barcode": null
},
{
"_class": "person",
"oid": 1481,
"name": "Minsoo Hong",
"userid": "037053",
"barcode": null
},
{
"_class": "person",
"oid": 1333,
"name": "Ethan Holme",
"userid": "072736",
"barcode": null
},
{
"_class": "person",
"oid": 1337,
"name": "Seok Kee Hodges",
"userid": "093613",
"barcode": null
},
{
"_class": "person",
"oid": 1360,
"name": "Eunjung Hintermann",
"userid": "091627",
"barcode": null
},
{
"_class": "person",
"oid": 1050,
"name": "Philipp Hill",
"userid": "078278",
"barcode": null
},
{
"_class": "person",
"oid": 1318,
"name": "Tracy Hernandez",
"userid": "058222",
"barcode": null
},
{
"_class": "person",
"oid": 1197,
"name": "Shannon Henderson",
"userid": "048667",
"barcode": null
},
{
"_class": "person",
"oid": 1255,
"name": "Taiyo Hemminger",
"userid": "058838",
"barcode": null
},
{
"_class": "person",
"oid": 1411,
"name": "Dean He",
"userid": "055356",
"barcode": null
},
{
"_class": "person",
"oid": 1483,
"name": "Tess Hart",
"userid": "063968",
"barcode": null
},
{
"_class": "person",
"oid": 1297,
"name": "Kirk Harris",
"userid": "078238",
"barcode": null
},
{
"_class": "person",
"oid": 1463,
"name": "Tristan Harmer",
"userid": "096774",
"barcode": null
},
{
"_class": "person",
"oid": 1054,
"name": "Najee Harada1",
"userid": "047907",
"barcode": null
},
{
"_class": "person",
"oid": 1218,
"name": "Joseph Haggar",
"userid": "057283",
"barcode": null
},
{
"_class": "person",
"oid": 1474,
"name": "Olivia Guidetti",
"userid": "072369",
"barcode": null
},
{
"_class": "person",
"oid": 1121,
"name": "Alanna Grigorian",
"userid": "009107",
"barcode": null
},
{
"_class": "person",
"oid": 1267,
"name": "Marissa Greenstein",
"userid": "089348",
"barcode": null
},
{
"_class": "person",
"oid": 1420,
"name": "Christopher Green",
"userid": "045474",
"barcode": null
},
{
"_class": "person",
"oid": 1412,
"name": "Kyle Graves",
"userid": "029593",
"barcode": null
},
{
"_class": "person",
"oid": 1089,
"name": "Jake Graham",
"userid": "023053",
"barcode": null
},
{
"_class": "person",
"oid": 1009,
"name": "Kelly Gozzano",
"userid": "013520",
"barcode": null
},
{
"_class": "person",
"oid": 1069,
"name": "Akiko Goodman",
"userid": "080049",
"barcode": null
},
{
"_class": "person",
"oid": 1070,
"name": "Courtney Gonzalez",
"userid": "028621",
"barcode": null
},
{
"_class": "person",
"oid": 1389,
"name": "Cecilia Gonzales",
"userid": "037247",
"barcode": null
},
{
"_class": "person",
"oid": 1205,
"name": "Timothy Gofnung",
"userid": "075825",
"barcode": null
},
{
"_class": "person",
"oid": 1039,
"name": "Kathryn Gibson",
"userid": "078299",
"barcode": null
},
{
"_class": "person",
"oid": 1303,
"name": "Wesley Genesee",
"userid": "044322",
"barcode": null
},
{
"_class": "person",
"oid": 1178,
"name": "Elizabeth Gee",
"userid": "036931",
"barcode": null
},
{
"_class": "person",
"oid": 1010,
"name": "Aiden Gee",
"userid": "062835",
"barcode": null
},
{
"_class": "person",
"oid": 1231,
"name": "Lauren Garza",
"userid": "012757",
"barcode": null
},
{
"_class": "person",
"oid": 1174,
"name": "Zia Garcia",
"userid": "006684",
"barcode": null
},
{
"_class": "person",
"oid": 1274,
"name": "Hyuk Galvan",
"userid": "004930",
"barcode": null
},
{
"_class": "person",
"oid": 1276,
"name": "Christine Gallardo",
"userid": "041613",
"barcode": null
},
{
"_class": "person",
"oid": 1336,
"name": "Shanda Gale",
"userid": "054340",
"barcode": null
},
{
"_class": "person",
"oid": 1344,
"name": "Julia Gaede",
"userid": "018399",
"barcode": null
},
{
"_class": "person",
"oid": 1460,
"name": "Hye Frederick",
"userid": "083296",
"barcode": null
},
{
"_class": "person",
"oid": 1038,
"name": "Brian Franssen",
"userid": "077909",
"barcode": null
},
{
"_class": "person",
"oid": 1452,
"name": "Calvin Francis",
"userid": "051634",
"barcode": null
},
{
"_class": "person",
"oid": 1317,
"name": "Felix Foster",
"userid": "071357",
"barcode": null
},
{
"_class": "person",
"oid": 1250,
"name": "Elijah Folker",
"userid": "047862",
"barcode": null
},
{
"_class": "person",
"oid": 1007,
"name": "Liao Fleming",
"userid": "013494",
"barcode": null
},
{
"_class": "person",
"oid": 1011,
"name": "Lito Flaherty",
"userid": "075031",
"barcode": null
},
{
"_class": "person",
"oid": 1051,
"name": "Leah Fischer",
"userid": "093065",
"barcode": null
},
{
"_class": "person",
"oid": 1104,
"name": "Natalie Ewen",
"userid": "039191",
"barcode": null
},
{
"_class": "person",
"oid": 1350,
"name": "Ryan Evans",
"userid": "066855",
"barcode": null
},
{
"_class": "person",
"oid": 1210,
"name": "Jade Estrada",
"userid": "020354",
"barcode": null
},
{
"_class": "person",
"oid": 1172,
"name": "Christopher Engel",
"userid": "092400",
"barcode": null
},
{
"_class": "person",
"oid": 1115,
"name": "Leonie Elmer",
"userid": "020672",
"barcode": null
},
{
"_class": "person",
"oid": 1108,
"name": "Jeremiah East",
"userid": "044372",
"barcode": null
},
{
"_class": "person",
"oid": 1306,
"name": "Joanne Duus",
"userid": "036676",
"barcode": null
},
{
"_class": "person",
"oid": 1101,
"name": "Brian Duque",
"userid": "054648",
"barcode": null
},
{
"_class": "person",
"oid": 1356,
"name": "Price Duong",
"userid": "066771",
"barcode": null
},
{
"_class": "person",
"oid": 1377,
"name": "Steven Dunn",
"userid": "070003",
"barcode": null
},
{
"_class": "person",
"oid": 1329,
"name": "Samantha Duncan",
"userid": "036796",
"barcode": null
},
{
"_class": "person",
"oid": 1261,
"name": "Sung Doyle",
"userid": "086387",
"barcode": null
},
{
"_class": "person",
"oid": 1310,
"name": "Zoe Dochtermann",
"userid": "071128",
"barcode": null
},
{
"_class": "person",
"oid": 1305,
"name": "Nicholas Dobos",
"userid": "098213",
"barcode": null
},
{
"_class": "person",
"oid": 1235,
"name": "Rodolfo Djanbazian",
"userid": "006602",
"barcode": null
},
{
"_class": "person",
"oid": 1097,
"name": "Mon-Lai Diaz",
"userid": "050395",
"barcode": null
},
{
"_class": "person",
"oid": 1055,
"name": "Steven Demasi",
"userid": "064904",
"barcode": null
},
{
"_class": "person",
"oid": 1461,
"name": "Susan De Las Alas",
"userid": "074235",
"barcode": null
},
{
"_class": "person",
"oid": 1330,
"name": "Aaron DeGeorge",
"userid": "093703",
"barcode": null
},
{
"_class": "person",
"oid": 1264,
"name": "Natalia Damir",
"userid": "026569",
"barcode": null
},
{
"_class": "person",
"oid": 1227,
"name": "Nicholas Dabney",
"userid": "044464",
"barcode": null
},
{
"_class": "person",
"oid": 1438,
"name": "Paul Cunningham",
"userid": "073642",
"barcode": null
},
{
"_class": "person",
"oid": 1082,
"name": "Joseph Cui",
"userid": "049786",
"barcode": null
},
{
"_class": "person",
"oid": 1472,
"name": "Rilla Cruz-Arbona",
"userid": "004278",
"barcode": null
},
{
"_class": "person",
"oid": 1077,
"name": "Erick Creedon",
"userid": "044586",
"barcode": null
},
{
"_class": "person",
"oid": 1282,
"name": "My-Kim Coulombe",
"userid": "012685",
"barcode": null
},
{
"_class": "person",
"oid": 1338,
"name": "Celia Cory",
"userid": "011742",
"barcode": null
},
{
"_class": "person",
"oid": 1375,
"name": "Anne-Marie Copeland",
"userid": "002480",
"barcode": null
},
{
"_class": "person",
"oid": 1133,
"name": "Emelene Contreras",
"userid": "022046",
"barcode": null
},
{
"_class": "person",
"oid": 1187,
"name": "Latifa Comerford",
"userid": "010887",
"barcode": null
},
{
"_class": "person",
"oid": 1308,
"name": "Miranda Cohn",
"userid": "019861",
"barcode": null
},
{
"_class": "person",
"oid": 1387,
"name": "Maria Coccetti",
"userid": "044376",
"barcode": null
},
{
"_class": "person",
"oid": 1006,
"name": "Melissa Cobos",
"userid": "057685",
"barcode": null
},
{
"_class": "person",
"oid": 1103,
"name": "Lori Coad",
"userid": "009141",
"barcode": null
},
{
"_class": "person",
"oid": 1155,
"name": "Marco Clayton",
"userid": "071260",
"barcode": null
},
{
"_class": "person",
"oid": 1068,
"name": "Daniel Chung",
"userid": "060328",
"barcode": null
},
{
"_class": "person",
"oid": 1118,
"name": "Thomas Chun",
"userid": "077076",
"barcode": null
},
{
"_class": "person",
"oid": 1323,
"name": "Eun Kyoung Chu",
"userid": "053584",
"barcode": null
},
{
"_class": "person",
"oid": 1359,
"name": "Maria Chu",
"userid": "061011",
"barcode": null
},
{
"_class": "person",
"oid": 1363,
"name": "Elise Chou",
"userid": "036280",
"barcode": null
},
{
"_class": "person",
"oid": 1105,
"name": "Linda Chong",
"userid": "061841",
"barcode": null
},
{
"_class": "person",
"oid": 1270,
"name": "Ursula Cho",
"userid": "082124",
"barcode": null
},
{
"_class": "person",
"oid": 1245,
"name": "Katherine Cho",
"userid": "096242",
"barcode": null
},
{
"_class": "person",
"oid": 1322,
"name": "Julia Chism",
"userid": "005794",
"barcode": null
},
{
"_class": "person",
"oid": 1204,
"name": "Steve Chi",
"userid": "042946",
"barcode": null
},
{
"_class": "person",
"oid": 1102,
"name": "Anaya Cheng",
"userid": "006432",
"barcode": null
},
{
"_class": "person",
"oid": 1018,
"name": "Robert Cheng",
"userid": "023983",
"barcode": null
},
{
"_class": "person",
"oid": 1364,
"name": "Hyon Chen",
"userid": "007739",
"barcode": null
},
{
"_class": "person",
"oid": 1059,
"name": "Michael Chen",
"userid": "009908",
"barcode": null
},
{
"_class": "person",
"oid": 1138,
"name": "Ani Chen",
"userid": "020417",
"barcode": null
},
{
"_class": "person",
"oid": 1073,
"name": "Hyun Chen",
"userid": "021290",
"barcode": null
},
{
"_class": "person",
"oid": 1383,
"name": "Joshua Chen",
"userid": "025910",
"barcode": null
},
{
"_class": "person",
"oid": 1328,
"name": "Elizabeth Chen",
"userid": "041609",
"barcode": null
},
{
"_class": "person",
"oid": 1266,
"name": "Jake Chen",
"userid": "052959",
"barcode": null
},
{
"_class": "person",
"oid": 1026,
"name": "Veronica Chen",
"userid": "063100",
"barcode": null
},
{
"_class": "person",
"oid": 1458,
"name": "Noah Chavez",
"userid": "092212",
"barcode": null
},
{
"_class": "person",
"oid": 1012,
"name": "Jeromy Chao",
"userid": "049430",
"barcode": null
},
{
"_class": "person",
"oid": 1442,
"name": "Natasha Chang",
"userid": "030508",
"barcode": null
},
{
"_class": "person",
"oid": 1191,
"name": "Richard Chang",
"userid": "043589",
"barcode": null
},
{
"_class": "person",
"oid": 1213,
"name": "Charles Chang",
"userid": "052007",
"barcode": null
},
{
"_class": "person",
"oid": 1288,
"name": "Haruna Chang",
"userid": "086634",
"barcode": null
},
{
"_class": "person",
"oid": 1476,
"name": "Brandon Chan",
"userid": "060424",
"barcode": null
},
{
"_class": "person",
"oid": 1057,
"name": "Jordan Chan",
"userid": "088767",
"barcode": null
},
{
"_class": "person",
"oid": 1168,
"name": "Alexander Caydamli",
"userid": "095317",
"barcode": null
},
{
"_class": "person",
"oid": 1053,
"name": "Eric Caviness",
"userid": "039946",
"barcode": null
},
{
"_class": "person",
"oid": 1319,
"name": "James Castro San Vicente",
"userid": "037031",
"barcode": null
},
{
"_class": "person",
"oid": 1233,
"name": "Shirley Castillo",
"userid": "029599",
"barcode": null
},
{
"_class": "person",
"oid": 1042,
"name": "Annika Castellano",
"userid": "086003",
"barcode": null
},
{
"_class": "person",
"oid": 1378,
"name": "Mark-Abram Caruso",
"userid": "026979",
"barcode": null
},
{
"_class": "person",
"oid": 1216,
"name": "Arotin Carrillo",
"userid": "071529",
"barcode": null
},
{
"_class": "person",
"oid": 1385,
"name": "Anthony Carlson",
"userid": "037529",
"barcode": null
},
{
"_class": "person",
"oid": 1468,
"name": "Sophia Campbell",
"userid": "096081",
"barcode": null
},
{
"_class": "person",
"oid": 1049,
"name": "Munehiro Camp",
"userid": "054416",
"barcode": null
},
{
"_class": "person",
"oid": 1429,
"name": "Jin Soo Calvin-Smith",
"userid": "034664",
"barcode": null
},
{
"_class": "person",
"oid": 1374,
"name": "Somin Burt",
"userid": "067489",
"barcode": null
},
{
"_class": "person",
"oid": 1283,
"name": "Marcus Bullock",
"userid": "003762",
"barcode": null
},
{
"_class": "person",
"oid": 1208,
"name": "Claire Bui",
"userid": "095482",
"barcode": null
},
{
"_class": "person",
"oid": 1470,
"name": "James Budris",
"userid": "018289",
"barcode": null
},
{
"_class": "person",
"oid": 1369,
"name": "Jamie Budge",
"userid": "012683",
"barcode": null
},
{
"_class": "person",
"oid": 1156,
"name": "Amalia Brush",
"userid": "058818",
"barcode": null
},
{
"_class": "person",
"oid": 1130,
"name": "Taylor Brown",
"userid": "017498",
"barcode": null
},
{
"_class": "person",
"oid": 1110,
"name": "Robert Brosmith",
"userid": "034451",
"barcode": null
},
{
"_class": "person",
"oid": 1025,
"name": "Olga Brock",
"userid": "003689",
"barcode": null
},
{
"_class": "person",
"oid": 1045,
"name": "Green Bridan",
"userid": "017483",
"barcode": null
},
{
"_class": "person",
"oid": 1345,
"name": "Leonard Briana",
"userid": "047895",
"barcode": null
},
{
"_class": "person",
"oid": 1164,
"name": "John Braswell",
"userid": "089663",
"barcode": null
},
{
"_class": "person",
"oid": 1258,
"name": "Tiffany Bracamontes",
"userid": "047055",
"barcode": null
},
{
"_class": "person",
"oid": 1181,
"name": "Paige Bountress-Hooke",
"userid": "053169",
"barcode": null
},
{
"_class": "person",
"oid": 1436,
"name": "Sophie Booty",
"userid": "050800",
"barcode": null
},
{
"_class": "person",
"oid": 1146,
"name": "Madison Boone",
"userid": "055583",
"barcode": null
},
{
"_class": "person",
"oid": 1272,
"name": "Alexander Bonilla",
"userid": "002557",
"barcode": null
},
{
"_class": "person",
"oid": 1390,
"name": "Tori Best",
"userid": "017641",
"barcode": null
},
{
"_class": "person",
"oid": 1061,
"name": "Esther Bess",
"userid": "047754",
"barcode": null
},
{
"_class": "person",
"oid": 1342,
"name": "Elizabeth Bertin",
"userid": "003119",
"barcode": null
},
{
"_class": "person",
"oid": 1419,
"name": "Corey Bernstein",
"userid": "031027",
"barcode": null
},
{
"_class": "person",
"oid": 1491,
"name": "Danielle Benson",
"userid": "056529",
"barcode": null
},
{
"_class": "person",
"oid": 1403,
"name": "Bennett Bennett",
"userid": "096896",
"barcode": null
},
{
"_class": "person",
"oid": 1244,
"name": "Fermin Belzer",
"userid": "088174",
"barcode": null
},
{
"_class": "person",
"oid": 1259,
"name": "Lillian Bell",
"userid": "060882",
"barcode": null
},
{
"_class": "person",
"oid": 1380,
"name": "Kristina Belamide",
"userid": "074098",
"barcode": null
},
{
"_class": "person",
"oid": 1256,
"name": "Brett Beckstrom",
"userid": "061064",
"barcode": null
},
{
"_class": "person",
"oid": 1386,
"name": "Saskia Beak",
"userid": "075601",
"barcode": null
},
{
"_class": "person",
"oid": 1162,
"name": "Emma Bautista",
"userid": "098360",
"barcode": null
},
{
"_class": "person",
"oid": 1260,
"name": "Gwynn Banda",
"userid": "060753",
"barcode": null
},
{
"_class": "person",
"oid": 1453,
"name": "Elizabeth Bakofsky",
"userid": "094234",
"barcode": null
},
{
"_class": "person",
"oid": 1022,
"name": "Soo Bai",
"userid": "037878",
"barcode": null
},
{
"_class": "person",
"oid": 1482,
"name": "Erica Badounts",
"userid": "070914",
"barcode": null
},
{
"_class": "person",
"oid": 1109,
"name": "Daniel Babcock",
"userid": "086016",
"barcode": null
},
{
"_class": "person",
"oid": 1116,
"name": "Justin Artinian",
"userid": "029806",
"barcode": null
},
{
"_class": "person",
"oid": 1219,
"name": "Morgen Armas",
"userid": "024481",
"barcode": null
},
{
"_class": "person",
"oid": 1407,
"name": "Han Anthony",
"userid": "020271",
"barcode": null
},
{
"_class": "person",
"oid": 1252,
"name": "Suzanne Anthony",
"userid": "076241",
"barcode": null
},
{
"_class": "person",
"oid": 1457,
"name": "Paul Antell",
"userid": "042920",
"barcode": null
},
{
"_class": "person",
"oid": 1450,
"name": "Joseph Annino",
"userid": "001981",
"barcode": null
},
{
"_class": "person",
"oid": 1437,
"name": "Zulema Anduiza",
"userid": "065660",
"barcode": null
},
{
"_class": "person",
"oid": 1313,
"name": "Brenda Andersen",
"userid": "001592",
"barcode": null
},
{
"_class": "person",
"oid": 1446,
"name": "Sarah Andersen",
"userid": "040235",
"barcode": null
},
{
"_class": "person",
"oid": 1125,
"name": "Gabor Anand",
"userid": "050848",
"barcode": null
},
{
"_class": "person",
"oid": 1398,
"name": "Cheryl Alvarez",
"userid": "005518",
"barcode": null
},
{
"_class": "person",
"oid": 1384,
"name": "Evan Alonzo",
"userid": "030931",
"barcode": null
},
{
"_class": "person",
"oid": 1239,
"name": "Jancarlo Alofoje",
"userid": "006776",
"barcode": null
},
{
"_class": "person",
"oid": 1298,
"name": "Karolina Allen",
"userid": "049834",
"barcode": null
},
{
"_class": "person",
"oid": 1147,
"name": "Teo Alfaro",
"userid": "033093",
"barcode": null
},
{
"_class": "person",
"oid": 1100,
"name": "Ariel Alekyan",
"userid": "020562",
"barcode": null
},
{
"_class": "person",
"oid": 1368,
"name": "Danielle Alaverdyan",
"userid": "018034",
"barcode": null
},
{
"_class": "person",
"oid": 1086,
"name": "Leana Alagozian",
"userid": "089907",
"barcode": null
},
{
"_class": "person",
"oid": 1145,
"name": "Sonia Aitken",
"userid": "069199",
"barcode": null
},
{
"_class": "person",
"oid": 1430,
"name": "Balbina Ai",
"userid": "044119",
"barcode": null
},
{
"_class": "person",
"oid": 1046,
"name": "Jacquelyne Agdere",
"userid": "059609",
"barcode": null
},
{
"_class": "person",
"oid": 1,
"name": "John Q. Admin",
"userid": "admin",
"barcode": "12345"
},
{
"_class": "person",
"oid": 1311,
"name": "Sydney Adams",
"userid": "066786",
"barcode": null
},
{
"_class": "person",
"oid": 1427,
"name": "Nathaniel Abaravich",
"userid": "076904",
"barcode": null
}
]
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
The offset argument will ignore the first N results before returning any matches. Note that the offset argument should generally be combined with some sort of ordering when implementing pagination to ensure consistent order in the results.
POST rest/person/search
{
"limit": 5,
"offset": 0,
"orderBy": "sortableName",
"orderDirection": "desc",
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/search",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"count": 502,
"summary": null,
"result": [
{
"_class": "person",
"oid": 1064,
"name": "Matthew Zuniga",
"userid": "080696",
"barcode": null
},
{
"_class": "person",
"oid": 1480,
"name": "Emil Zukovski",
"userid": "014722",
"barcode": null
},
{
"_class": "person",
"oid": 1355,
"name": "Shomari Ziehler-Martin",
"userid": "052663",
"barcode": null
},
{
"_class": "person",
"oid": 1296,
"name": "Nicholas Yung",
"userid": "047807",
"barcode": null
},
{
"_class": "person",
"oid": 1353,
"name": "Mark Yu",
"userid": "073798",
"barcode": null
}
]
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
POST rest/person/search
{
"limit": 5,
"offset": 5,
"orderBy": "sortableName",
"orderDirection": "desc",
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/search",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"count": 502,
"summary": null,
"result": [
{
"_class": "person",
"oid": 1182,
"name": "Alexander Yuen",
"userid": "033733",
"barcode": null
},
{
"_class": "person",
"oid": 1194,
"name": "Georgina York",
"userid": "076898",
"barcode": null
},
{
"_class": "person",
"oid": 1202,
"name": "Lucy Yoon",
"userid": "082767",
"barcode": null
},
{
"_class": "person",
"oid": 1424,
"name": "Aaron Yoon",
"userid": "089183",
"barcode": null
},
{
"_class": "person",
"oid": 1085,
"name": "Yong-Ho Yi",
"userid": "085305",
"barcode": null
}
]
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
The count argument revises the type of value returned by search. It no longer returns an array, instead it returns an integer count of the number of matching entities. This operation is far more efficient that returing a list of results.
POST rest/person/search
{
"count": true,
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/search",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"count": 502,
"summary": null,
"result": 502
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
The oidsOnly argument revises the return value of the search. Instead of returning an array of entities, it returns an array of OIDsfor the result. This may be used for performance reasons when it would be better to retrieve entites as they are needed. For example, see the CSV Export section below.
POST rest/person/search
{
"limit": 10,
"oidsOnly": true,
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/search",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"count": 502,
"summary": null,
"result": [
1,
2,
1000,
1001,
1002,
1003,
1004,
1005,
1006,
1007
]
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
The mutiQuery argument allows for multiple searches for the same entity type in a single call. It accepts an array of query definitions, including all above arguments with the exception of properties which if provided to search still applies to all returned results.
The result is an array of search result payloads in the same order as the queries.
POST rest/person/search
{
"multiQuery": [
{
"query": {
"firstName": "John"
}
},
{
"query": {
"userid": "admin"
}
}
],
"properties": [
"street",
"street2",
"city",
"state",
"telephone",
"email"
],
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/search",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": [
{
"count": 4,
"summary": null,
"result": [
{
"_class": "person",
"oid": 1033,
"name": "John Lin",
"email": null,
"telephone": null,
"state": null,
"city": null,
"street2": null,
"street": null
},
{
"_class": "person",
"oid": 1,
"name": "John Q. Admin",
"email": null,
"telephone": null,
"state": null,
"city": null,
"street2": null,
"street": null
},
{
"_class": "person",
"oid": 1164,
"name": "John Braswell",
"email": null,
"telephone": null,
"state": null,
"city": null,
"street2": null,
"street": null
},
{
"_class": "person",
"oid": 1215,
"name": "John Smith",
"email": null,
"telephone": null,
"state": null,
"city": null,
"street2": null,
"street": null
}
]
},
{
"count": 1,
"summary": null,
"result": [
{
"_class": "person",
"oid": 1,
"name": "John Q. Admin",
"email": null,
"telephone": null,
"state": null,
"city": null,
"street2": null,
"street": null
}
]
}
],
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
A namespace may have a set of predefined find configurations describing a set of query terms, and a set of result properties for a search. The list for each entity type can be retrieved by GETing the namespace searchConfigs asset. The results are the name and guid of the config and a flag to tell if it is the default query config for the entity type. A full configuration may be retrieved by posting to the configurations/searchConfig. See configuration in Special Namespaces for details.
Please note that configurations are highly unstable and likely to change considerably in upcomming releases.POST rest/allocation/searchConfigs
{
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/allocation/searchConfigs",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": [
{
"_class": "findConfig",
"oid": 1,
"name": "All Future Reservations",
"config": {
"autoRun": true,
"autoHideTerms": null,
"defaultSort": {
"property": "startTime",
"direction": "asc"
},
"actions": [
{
"method": "emailAllocationPatrons",
"label": "Email Patrons",
"argument": "allocations",
"useSelected": true
}
],
"properties": [
"identity",
"patron",
"originalAgent",
"startTime",
"endTime"
],
"summary": [
"allocationContentsSummary"
],
"resultSummary": null,
"terms": [
{
"term": "identity"
},
{
"term": "center",
"initialValue": "!location"
},
{
"term": "state",
"initialValue": [
"RESERVATION"
]
},
{
"term": "patron"
},
{
"term": "resource"
},
{
"term": "eventDescription"
},
{
"term": "earliestScheduledStart",
"initialValue": "!time,now"
}
]
},
"scope": null,
"guid": "find-all-future-allocations",
"default": false,
"entityType": "allocation",
"immutable": true
},
{
"_class": "findConfig",
"oid": 2,
"name": "Canceled Reservations",
"config": {
"autoRun": true,
"autoHideTerms": null,
"defaultSort": {
"property": "startTime",
"direction": "asc"
},
"actions": null,
"properties": [
"identity",
"patron",
"originalAgent",
"startTime",
"endTime"
],
"summary": [
"allocationContentsSummary"
],
"resultSummary": null,
"terms": [
{
"term": "identity"
},
{
"term": "center",
"initialValue": "!location"
},
{
"term": "state",
"initialValue": [
"RESERVATION-CANCELLED"
]
},
{
"term": "patron"
},
{
"term": "resource"
},
{
"term": "eventDescription"
}
]
},
"scope": null,
"guid": "find-all-cancelled-reservations",
"default": false,
"entityType": "allocation",
"immutable": true
},
{
"_class": "findConfig",
"oid": 3,
"name": "Whats Late",
"config": {
"autoRun": true,
"autoHideTerms": null,
"defaultSort": {
"property": "endTime",
"direction": "asc"
},
"actions": [
{
"method": "emailAllocationPatrons",
"label": "Email Patrons",
"argument": "allocations",
"useSelected": true
}
],
"properties": [
"identity",
"patron",
"realStartTime",
"endTime",
"patronEmail"
],
"summary": [
"allocationContentsSummary"
],
"resultSummary": null,
"terms": [
{
"term": "center",
"initialValue": "!location"
},
{
"term": "state",
"initialValue": [
"CHECKOUT"
]
},
{
"term": "latestPendingReturn",
"initialValue": "!time,now"
}
]
},
"scope": null,
"guid": "find-whats-late",
"default": false,
"entityType": "allocation",
"immutable": true
},
{
"_class": "findConfig",
"oid": 4,
"name": "Usage Report",
"config": {
"autoRun": null,
"autoHideTerms": null,
"defaultSort": {
"property": "identity",
"direction": "ascending"
},
"actions": null,
"properties": [
"identity",
"agent",
"patron",
"patronBarcode",
"patronDepartment",
"patronEmail",
"renewalCount",
"accountCode"
],
"summary": [
"allocationContentsSummary"
],
"resultSummary": "usageSummary",
"terms": [
{
"term": "center",
"initialValue": "!location"
},
{
"term": "state"
},
{
"term": "earliestScheduledStart",
"initialValue": "!time,BOD"
},
{
"term": "latestScheduledStart",
"initialValue": "!time,EOD"
}
]
},
"scope": null,
"guid": "usage-report",
"default": false,
"entityType": "allocation",
"immutable": true
},
{
"_class": "findConfig",
"oid": 46,
"name": "Find Allocations",
"config": {
"autoRun": null,
"autoHideTerms": null,
"defaultSort": {
"property": "startTime",
"direction": "asc"
},
"actions": null,
"properties": [
"identity",
"patron",
"originalAgent",
"startTime",
"endTime"
],
"summary": [
"allocationContentsSummary"
],
"resultSummary": null,
"terms": [
{
"term": "identity"
},
{
"term": "center",
"initialValue": "!location"
},
{
"term": "state"
},
{
"term": "patron"
},
{
"term": "resource"
},
{
"term": "eventDescription"
}
]
},
"scope": null,
"guid": "default-find-allocations",
"default": true,
"entityType": "allocation",
"immutable": true
},
{
"_class": "findConfig",
"oid": 47,
"name": "All Checkouts",
"config": {
"autoRun": true,
"autoHideTerms": null,
"defaultSort": {
"property": "endTime",
"direction": "asc"
},
"actions": null,
"properties": [
"identity",
"patron",
"originalAgent",
"realStartTime",
"endTime"
],
"summary": [
"allocationContentsSummary"
],
"resultSummary": null,
"terms": [
{
"term": "identity"
},
{
"term": "center",
"initialValue": "!location"
},
{
"term": "state",
"initialValue": [
"CHECKOUT",
"CHECKOUT-COMPLETED"
]
},
{
"term": "patron"
},
{
"term": "resource"
},
{
"term": "eventDescription"
}
]
},
"scope": null,
"guid": "find-all-checkouts",
"default": false,
"entityType": "allocation",
"immutable": true
},
{
"_class": "findConfig",
"oid": 48,
"name": "Unreturned Checkouts",
"config": {
"autoRun": true,
"autoHideTerms": null,
"defaultSort": {
"property": "endTime",
"direction": "asc"
},
"actions": [
{
"method": "emailAllocationPatrons",
"label": "Email Patrons",
"argument": "allocations",
"useSelected": true
}
],
"properties": [
"identity",
"patron",
"originalAgent",
"realStartTime",
"endTime"
],
"summary": [
"allocationContentsSummary"
],
"resultSummary": null,
"terms": [
{
"term": "identity"
},
{
"term": "center",
"initialValue": "!location"
},
{
"term": "state",
"initialValue": [
"CHECKOUT"
]
},
{
"term": "patron"
},
{
"term": "resource"
},
{
"term": "eventDescription"
}
]
},
"scope": null,
"guid": "find-unreturned-allocations",
"default": false,
"entityType": "allocation",
"immutable": true
},
{
"_class": "findConfig",
"oid": 49,
"name": "Returned Checkouts",
"config": {
"autoRun": true,
"autoHideTerms": null,
"defaultSort": {
"property": "realEndTime",
"direction": "asc"
},
"actions": null,
"properties": [
"identity",
"patron",
"originalAgent",
"realStartTime",
"realEndTime"
],
"summary": [
"allocationContentsSummary"
],
"resultSummary": null,
"terms": [
{
"term": "identity"
},
{
"term": "center",
"initialValue": "!location"
},
{
"term": "state",
"initialValue": [
"CHECKOUT-COMPLETED"
]
},
{
"term": "patron"
},
{
"term": "resource"
},
{
"term": "eventDescription"
}
]
},
"scope": null,
"guid": "find-returned-allocations",
"default": false,
"entityType": "allocation",
"immutable": true
},
{
"_class": "findConfig",
"oid": 50,
"name": "All Reservations",
"config": {
"autoRun": true,
"autoHideTerms": null,
"defaultSort": {
"property": "startTime",
"direction": "asc"
},
"actions": [
{
"method": "emailAllocationPatrons",
"label": "Email Patrons",
"argument": "allocations",
"useSelected": true
}
],
"properties": [
"identity",
"patron",
"originalAgent",
"startTime",
"endTime"
],
"summary": [
"allocationContentsSummary"
],
"resultSummary": null,
"terms": [
{
"term": "identity"
},
{
"term": "center",
"initialValue": "!location"
},
{
"term": "state",
"initialValue": [
"RESERVATION",
"RESERVATION-CANCELLED"
]
},
{
"term": "patron"
},
{
"term": "resource"
},
{
"term": "eventDescription"
}
]
},
"scope": null,
"guid": "find-all-reservations",
"default": false,
"entityType": "allocation",
"immutable": true
},
{
"_class": "findConfig",
"oid": 51,
"name": "Reservations Pending Approval",
"config": {
"autoRun": true,
"autoHideTerms": null,
"defaultSort": {
"property": "startTime",
"direction": "asc"
},
"actions": [
{
"method": "approveReservations",
"label": "Approve Reservations",
"argument": "reservations",
"useSelected": true,
"rerunQuery": true
},
{
"method": "disapproveReservations",
"label": "Disapprove Reservations",
"argument": "reservations",
"useSelected": true,
"rerunQuery": true
}
],
"properties": [
"identity",
"patron",
"originalAgent",
"startTime",
"endTime"
],
"summary": [
"allocationContentsSummary"
],
"resultSummary": null,
"terms": [
{
"term": "center",
"initialValue": "!location"
},
{
"term": "state",
"initialValue": [
"RESERVATION"
]
},
{
"term": "patron"
},
{
"term": "resource"
},
{
"term": "eventDescription"
},
{
"term": "identity"
},
{
"term": "pendingApproval",
"initialValue": true
}
]
},
"scope": null,
"guid": "find-reservations-pending-approval",
"default": false,
"entityType": "allocation",
"immutable": true
},
{
"_class": "findConfig",
"oid": 52,
"name": "Reservations Available Now",
"config": {
"autoRun": true,
"autoHideTerms": null,
"defaultSort": {
"property": "startTime",
"direction": "asc"
},
"actions": [
{
"method": "emailAllocationPatrons",
"label": "Email Patrons",
"argument": "allocations",
"useSelected": true
}
],
"properties": [
"identity",
"patron",
"originalAgent",
"startTime",
"endTime"
],
"summary": [
"allocationContentsSummary"
],
"resultSummary": null,
"terms": [
{
"term": "center",
"initialValue": "!location"
},
{
"term": "state",
"initialValue": [
"RESERVATION"
]
},
{
"term": "patron"
},
{
"term": "resource"
},
{
"term": "eventDescription"
},
{
"term": "identity"
},
{
"term": "earliestScheduledStart",
"initialValue": "!time,hour,-,1"
},
{
"term": "latestScheduledStart",
"initialValue": "!time,hour,+,1"
}
]
},
"scope": null,
"guid": "find-reservations-available-now",
"default": false,
"entityType": "allocation",
"immutable": true
}
],
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
Any collection of the same entity type may be exported to CSV by posting the name of the output file, the properties requested in order, and the list of OIDs to include in order.
POST rest/person/exportCSV
{
"oids": [
1
],
"properties": [
"userid",
"oid"
],
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 500
{
"apiVersion": "1.0",
"uri": "/rest/person/exportCSV",
"session": "S-21712",
"status": "error",
"notifications": null,
"alert": null,
"payload": {
"message": "Properties list required for wcof-entites",
"class": "COMMON-LISP:SIMPLE-ERROR"
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
Getting the resulting URI, assuming it is done in the context of the same authorized session, will return the generated csv data as an attachment. Note, here, that this is not currently a rest API operation. Hence the use of the "GET" operation.
GET wco?method=get-asset&name=foo.csv
HTTP 200
Content-Disposition:attachment; filename=foo.csv Content-Type:text/csv; charset=utf-8 "Person ID",person.oid admin,1
In addition to exportCSV, entites may have additional possible export formats defined. A list of all exports available may be retrieved by GETting the namespaces exports asset. For consistancy, all export methods take the same set of arguments as exportCSV however some reports may ignore some of the arguments.
POST rest/allocation/exports
{
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/allocation/exports",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": [
{
"name": "exportCSV",
"label": "Export CSV"
},
{
"name": "byItemUsageReport",
"label": "Usage Report"
}
],
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
POST rest/person/exports
{
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/person/exports",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": [
{
"name": "exportCSV",
"label": "Export CSV"
},
{
"name": "exportImportable",
"label": "Export Importable"
}
],
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
Apart from the standard methods all entities have as documented above, some namespaces have additional commands defined. The list of available commands can be retrieved by GETing the namespaces commands operation.
The full list of commands for each namespace is listed in the the API Reference that is available on each WebChecheckout instance.
POST rest/group/commands
{
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/group/commands",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": [
{
"name": "addAuthsetsToGroups",
"requiredArguments": [
{
"name": "authsets",
"type": "authset",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
},
{
"name": "groups",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "groups",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "UNDOCUMENTED FRAMEWORK COMMAND"
},
{
"name": "addCheckoutCentersToGroups",
"requiredArguments": [
{
"name": "checkoutCenters",
"type": "checkoutCenter",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
},
{
"name": "groups",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
},
{
"name": "scope",
"type": "tag",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "selectBox",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "groups",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "UNDOCUMENTED FRAMEWORK COMMAND"
},
{
"name": "addGroupAuthset",
"requiredArguments": [
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
},
{
"name": "authset",
"type": "authset",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "group",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Add an authset to group's primary authset (the top-level one\nmeant to hold ad hoc types/authsets in a place that cannot be\naccidentally reused)."
},
{
"name": "addGroupCheckoutCenter",
"requiredArguments": [
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
},
{
"name": "checkoutCenter",
"type": "checkoutCenter",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
},
{
"name": "scope",
"type": "tag",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "selectBox",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "group",
"auths": [
"MANAGE-PIR-ACCESS"
]
}
],
"documentation": "Add a checkout-center to group's primary authset (the top-level one\nmeant to hold ad hoc types/authsets in a place that cannot be\naccidentally reused)."
},
{
"name": "addGroupResourceType",
"requiredArguments": [
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
},
{
"name": "rtype",
"type": "resourceType",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "group",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Add a resource-type to group's primary authset (the top-level one\nmeant to hold ad hoc types/authsets in a place that cannot be\naccidentally reused)."
},
{
"name": "addGroupSection",
"requiredArguments": [
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
},
{
"name": "section",
"type": "section",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": [
"applicationObject"
],
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Add section to group."
},
{
"name": "addResourceTypesToGroups",
"requiredArguments": [
{
"name": "resourceTypes",
"type": "resourceType",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
},
{
"name": "groups",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "groups",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "UNDOCUMENTED FRAMEWORK COMMAND"
},
{
"name": "copyGroup",
"requiredArguments": [
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": [
"applicationObject"
],
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Deep-copy group: (1) Shallow-copy group. (2) Set new group's\nsections to copies of group's sections. (3) Insert sections' members\ninto respective copies. User needs to hand-edit group's and sections'\nnames to be more meaningful than 'Copy of Copy of Copy of Foo'."
},
{
"name": "copySectionToGroup",
"requiredArguments": [
{
"name": "section",
"type": "section",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
},
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": [
"applicationObject"
],
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Shallow copy section, then copy its members to the copy."
},
{
"name": "copySectionsToGroup",
"requiredArguments": [
{
"name": "sections",
"type": "section",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
},
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": [
"applicationObject"
],
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Shallow copy section, then copy its members to the copy."
},
{
"name": "copySectionsToGroups",
"requiredArguments": [
{
"name": "sections",
"type": "section",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
},
{
"name": "groups",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": [
"applicationObject"
],
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Shallow copy section every section to every group, copying the members to the copy."
},
{
"name": "createPrimaryAuthset",
"requiredArguments": [
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "group",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Create and attach a primary authset to group if one doesn't exist. Raise an exception if one already exists, to force the user to do explicit checking."
},
{
"name": "deleteAuthsetsFromGroups",
"requiredArguments": [
{
"name": "authsets",
"type": "authset",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
},
{
"name": "groups",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "groups",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "UNDOCUMENTED FRAMEWORK COMMAND"
},
{
"name": "deleteCheckoutCentersFromGroups",
"requiredArguments": [
{
"name": "checkoutCenters",
"type": "checkoutCenter",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
},
{
"name": "groups",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "groups",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "UNDOCUMENTED FRAMEWORK COMMAND"
},
{
"name": "deleteGroup",
"requiredArguments": [
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": [
"applicationObject"
],
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Delete group, possibly with a bunch of keyword arguments usable\nby group's create-object method. The caller can further populate\nits slots and add section, an authset, or whatever."
},
{
"name": "deleteGroupAuthset",
"requiredArguments": [
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "group",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Disconnect authset from group."
},
{
"name": "deleteResourceTypesFromGroups",
"requiredArguments": [
{
"name": "resourceTypes",
"type": "resourceType",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
},
{
"name": "groups",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "groups",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "UNDOCUMENTED FRAMEWORK COMMAND"
},
{
"name": "deleteSections",
"requiredArguments": [
{
"name": "sections",
"type": "section",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": true
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": [
"applicationObject"
],
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Delete sections. No need to provide the group as it's contained in each section."
},
{
"name": "exportImportable",
"requiredArguments": [
{
"name": "oids",
"type": "integer",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "integer",
"multiple": true
},
{
"name": "columns",
"type": "keyword",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "selectBox",
"multiple": true
}
],
"optionalArguments": [
{
"name": "name",
"type": "string",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "string",
"multiple": null
}
],
"auth": [
{
"type": "sysauth",
"entity": [
"applicationObject"
],
"auths": [
"OPERATOR"
]
}
],
"documentation": "UNDOCUMENTED FRAMEWORK COMMAND"
},
{
"name": "groupPersonSetExpiration",
"requiredArguments": [
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
},
{
"name": "person",
"type": "person",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
},
{
"name": "date",
"type": "timestamp",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "timestamp",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "group",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Set end-date for person in every section of group."
},
{
"name": "new",
"requiredArguments": [
{
"name": "organization",
"type": "organization",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
}
],
"optionalArguments": [
{
"name": "name",
"type": "string",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "string",
"multiple": null
},
{
"name": "status",
"type": "tag",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "selectBox",
"multiple": null
},
{
"name": "contact",
"type": "person",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
},
{
"name": "role",
"type": "string",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "string",
"multiple": null
},
{
"name": "contactNote",
"type": "string",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "string",
"multiple": null
},
{
"name": "uniqueIdentifier",
"type": "string",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "string",
"multiple": null
},
{
"name": "origin",
"type": "string",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "string",
"multiple": null
},
{
"name": "description",
"type": "string",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "string",
"multiple": null
},
{
"name": "startDate",
"type": "timestamp",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "timestamp",
"multiple": null
},
{
"name": "endDate",
"type": "timestamp",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "timestamp",
"multiple": null
},
{
"name": "note",
"type": "string",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "string",
"multiple": null
},
{
"name": "telephone",
"type": "string",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "string",
"multiple": null
},
{
"name": "email",
"type": "string",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "string",
"multiple": null
},
{
"name": "url",
"type": "string",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "string",
"multiple": null
}
],
"auth": [
{
"type": "sysauth",
"entity": "organization",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Create a group"
},
{
"name": "setGroupDescription",
"requiredArguments": [
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
},
{
"name": "desc",
"type": "string",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "string",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "group",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "UNDOCUMENTED FRAMEWORK COMMAND"
},
{
"name": "setGroupEndDate",
"requiredArguments": [
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
},
{
"name": "value",
"type": "timestamp",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "timestamp",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "group",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Set group's end-date to value if it differs from current end-date."
},
{
"name": "setGroupOrganization",
"requiredArguments": [
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
},
{
"name": "organization",
"type": "organization",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "group",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Assign group to an organization."
},
{
"name": "setGroupStartDate",
"requiredArguments": [
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
},
{
"name": "value",
"type": "timestamp",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "timestamp",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": "group",
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Set group's start-date to value if it differs from current start-date."
},
{
"name": "shallowCopyGroup",
"requiredArguments": [
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": [
"applicationObject"
],
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Create a new group, identical to group (at the top level), except\nfor the following: name <- 'Copy of ', unique-identifier =\n'Copy of '."
},
{
"name": "shallowCopySectionToGroup",
"requiredArguments": [
{
"name": "section",
"type": "section",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
},
{
"name": "group",
"type": "group",
"constraintClass": null,
"constraintName": null,
"constraint": null,
"displayHint": "entity",
"multiple": null
}
],
"optionalArguments": null,
"auth": [
{
"type": "sysauth",
"entity": [
"applicationObject"
],
"auths": [
"MANAGE-AUTHS"
]
}
],
"documentation": "Create a new section, identical to section (at the top level), except\nfor the following: name <- 'Copy of ', unique-identifier =\n'Copy of '."
}
],
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
At its least sophisticated, a property template is simply an array of property names.
POST rest/checkoutCenter/get
{
"properties": [
"pickupDefault",
"returnDefault",
"organization"
],
"oid": 1,
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/checkoutCenter/get",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"_class": "checkoutCenter",
"oid": 1,
"name": "Main",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications"
}
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
However, some of these properties may themselves be entities with properties, as with organization above. Property templates allow for a recursive request for the properties of properties. If the base property is non-null, the "subProperties" template will be applied to the base properties value.
POST rest/checkoutCenter/get
{
"properties": [
"pickupDefault",
"returnDefault",
{
"property": "organization",
"subProperties": [
"timezone",
"locale"
]
}
],
"oid": 1,
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/checkoutCenter/get",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"_class": "checkoutCenter",
"oid": 1,
"name": "Main",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications",
"locale": "en_US",
"timezone": "America/Chicago"
}
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
The "subProperties" value is itself is a property template. This allows for unlimited nesting of templates.
POST rest/checkoutCenter/get
{
"properties": [
"pickupDefault",
"returnDefault",
{
"property": "organization",
"subProperties": [
"timezone",
"locale",
{
"property": "administrator",
"subProperties": [
"barcode"
]
}
]
}
],
"oid": 1,
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}
HTTP 200
{
"apiVersion": "1.0",
"uri": "/rest/checkoutCenter/get",
"session": "S-21712",
"status": "ok",
"notifications": null,
"alert": null,
"payload": {
"_class": "checkoutCenter",
"oid": 1,
"name": "Main",
"organization": {
"_class": "organization",
"oid": 1,
"name": "Communications",
"administrator": {
"_class": "person",
"oid": 1,
"name": "John Q. Admin",
"barcode": "12345"
},
"locale": "en_US",
"timezone": "America/Chicago"
}
},
"sessionid": "2bcd859a-f491-4ed2-a6d8-f6f2aca5e114"
}