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 (will be) documented for each entity. See your intance's local API Reference for details.
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": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": { "_class": "person", "oid": 1, "name": "Daniel T. Pyne", "userid": "admin" }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
You may also specify specific properties to be included in the serialization as a list. Doing so overrides the default serializations with the exception of the three properties mentioned above (_class, oid, name).
POST rest/person/get
{ "oid": 1, "properties": [ "street", "street2", "city", "state", "telephone", "email" ], "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": { "_class": "person", "oid": 1, "name": "Daniel T. Pyne", "email": null, "telephone": null, "state": null, "city": null, "street2": null, "street": null }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
You may also supply an array of oids, with or without properties
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 detaisl the creation of a new resource type.
POST rest/resourceType/new
{ "name": "Brand New Type 176688136", "parent": null, "rtid": "176688136", "organization": { "_class": "organization", "oid": 1 }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": { "_class": "resourceType", "oid": 5481, "name": "Brand New Type 176688136" }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
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": 2140, "properties": { "description": "This is my description" }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": { "_class": "resource", "oid": 2140, "name": "Camera-01", "statusString": "Available" }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
Deleting of entities is generaly 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
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, the set of constrained values the property will accept. (see Constraints Below)
A plain-text description of 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.
POST rest/location/properties
{ "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": [ { "label": "Oid", "property": "oid", "displayHint": "integer", "resultColumn": null, "type": "integer", "documentation": "The object's unique identifier", "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "_Class", "property": "_class", "displayHint": "string", "resultColumn": null, "type": "string", "documentation": "The object's class name as a string", "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": false, "constraint": null }, { "label": "Identity", "property": "identity", "displayHint": "identity", "resultColumn": true, "type": "location", "documentation": "The object itself", "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Default Allocation Times", "property": "defaultAllocationTimes", "displayHint": "defaultAllocationTimes", "resultColumn": true, "type": "defaultAllocationTimes", "documentation": null, "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Managing Organization", "property": "organization", "displayHint": "entity", "resultColumn": true, "type": "organization", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Name", "property": "name", "displayHint": "string", "resultColumn": true, "type": "string", "documentation": "the unique name for this location", "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Description", "property": "description", "displayHint": "string", "resultColumn": true, "type": "string", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Default Pickup Option", "property": "pickupDefault", "displayHint": "selectBox", "resultColumn": true, "type": "tag", "documentation": null, "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": [ { "value": "WILL-CALL", "label": "Pickup" }, { "value": "SETUP-WILL-CALL", "label": "Setup For Pickup" }, { "value": "SET", "label": "Deliver" } ] }, { "label": "Default Return Option", "property": "returnDefault", "displayHint": "selectBox", "resultColumn": true, "type": "tag", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": [ { "value": "WILL-RETURN", "label": "Take down" }, { "value": "STRIKE", "label": "Drop-off" } ] }, { "label": "Default Delivery Type", "property": "defaultDeliveryType", "displayHint": "selectBox", "resultColumn": true, "type": "tag", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": [ { "value": "NORMAL", "label": "Normal" }, { "value": "FULL-DAY", "label": "Full Day" } ] }, { "label": "Default Resource Selector", "property": "defaultResourceSelector", "displayHint": "selectBox", "resultColumn": true, "type": "tag", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": [ { "value": "RESOURCE-TYPE", "label": "By Resource Type" }, { "value": "HOME-LOCATION", "label": "By Home Location" } ] }, { "label": "Timeline Zoom Factor", "property": "timelineZoomFactor", "displayHint": "integer", "resultColumn": true, "type": "integer", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Timeline Granularity", "property": "timelineGranularity", "displayHint": "integer", "resultColumn": true, "type": "integer", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Building", "property": "building", "displayHint": "string", "resultColumn": true, "type": "string", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Room Number", "property": "room", "displayHint": "string", "resultColumn": true, "type": "string", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Address", "property": "address", "displayHint": "string", "resultColumn": true, "type": "string", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Telephone", "property": "telephone", "displayHint": "string", "resultColumn": true, "type": "string", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Default Printer Queue", "property": "printQueue", "displayHint": "string", "resultColumn": true, "type": "string", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Allocation Mode", "property": "allocationMode", "displayHint": "selectBox", "resultColumn": true, "type": "tag", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": [ { "value": "SHOPPING-CART", "label": "Shopping Cart" }, { "value": "TIMELINE", "label": "Timeline Scheduler" } ] }, { "label": "Billing Contact", "property": "billingContactName", "displayHint": "string", "resultColumn": true, "type": "string", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Billing Contact Telephone", "property": "billingContactPhone", "displayHint": "string", "resultColumn": true, "type": "string", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Billing Contact Email", "property": "billingContactEmail", "displayHint": "string", "resultColumn": true, "type": "string", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Email Template Set", "property": "emailTemplateSet", "displayHint": "selectBox", "resultColumn": true, "type": "string", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": [ { "value": null, "label": "(default)" }, { "value": "bar", "label": "bar" }, { "value": "baz", "label": "baz" }, { "value": "foo", "label": "foo" } ] }, { "label": "Print Template Set", "property": "printTemplateSet", "displayHint": "selectBox", "resultColumn": true, "type": "string", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": [ { "value": "(default)", "label": "(default)" } ] }, { "label": "Center Day Rollover", "property": "dayRollover", "displayHint": "intSinceMidnight", "resultColumn": true, "type": "integer", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Exclude Closed Days From Usage", "property": "usageExcludeClosed", "displayHint": "boolean", "resultColumn": true, "type": "boolean", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Hostname Or IP Address", "property": "crestronHost", "displayHint": "string", "resultColumn": true, "type": "string", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Port", "property": "crestronPort", "displayHint": "integer", "resultColumn": true, "type": "integer", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Require Signature On File", "property": "requireSignatureOnFile", "displayHint": "boolean", "resultColumn": true, "type": "boolean", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Form Date And Time Format", "property": "formDateTimeFormat", "displayHint": "selectBox", "resultColumn": true, "type": "tag", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": [ { "value": "DAYTIME+WEEKDAY", "label": "Friday, 3/4/2016, 12:12 PM" }, { "value": "DAYTIME", "label": "3/4/2016, 12:12 PM" }, { "value": "ISO+TIME", "label": "2016-03-04 12:12:07" } ] }, { "label": "Agreement Form Item Sorting", "property": "agreementFormSorting", "displayHint": "selectBox", "resultColumn": true, "type": "tag", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "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", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "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", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Timezone", "property": "timezone", "displayHint": "selectBox", "resultColumn": true, "type": "string", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": false, "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/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/Baghdad", "label": "Asia/Baghdad" }, { "value": "Asia/Bahrain", "label": "Asia/Bahrain" }, { "value": "Asia/Baku", "label": "Asia/Baku" }, { "value": "Asia/Bangkok", "label": "Asia/Bangkok" }, { "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/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/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/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/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/East-Saskatchewan", "label": "Canada/East-Saskatchewan" }, { "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/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/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/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/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", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": false, "constraint": [ { "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": "Patron Portal Message", "property": "pirMotd", "displayHint": "longString", "resultColumn": true, "type": "string", "documentation": null, "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Allow Patron Portal Search For Media In Other Centers", "property": "pirMediaCcQuery", "displayHint": "boolean", "resultColumn": true, "type": "boolean", "documentation": null, "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Repeats In Patron Portal", "property": "repeatsInPir", "displayHint": "boolean", "resultColumn": true, "type": "boolean", "documentation": null, "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Patron Portal Mode", "property": "pirMode", "displayHint": "selectBox", "resultColumn": true, "type": "tag", "documentation": null, "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "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", "documentation": null, "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Allow Patrons To Report Problems In Patron Portal", "property": "pirReportProblems", "displayHint": "boolean", "resultColumn": true, "type": "boolean", "documentation": "Can a patron report a problem in PIR at this location", "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Restrict Patron Delivery Locations To This Center", "property": "pirRestrictDeliveryLocations", "displayHint": "boolean", "resultColumn": true, "type": "boolean", "documentation": null, "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Patron Timeout (In Minutes)", "property": "pirSessionTimeout", "displayHint": "integer", "resultColumn": true, "type": "integer", "documentation": null, "readAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "OPERATOR" ] } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": true, "constraint": null }, { "label": "Pir Reservation Granularity", "property": "pirReservationGranularity", "displayHint": "duration", "resultColumn": true, "type": "duration", "documentation": null, "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": false, "constraint": null }, { "label": "Pir Start Granularity", "property": "pirStartGranularity", "displayHint": "integer", "resultColumn": true, "type": "integer", "documentation": null, "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": false, "constraint": null }, { "label": "Pir Delivery Locations", "property": "pirDeliveryLocations", "displayHint": "entityList", "resultColumn": true, "type": "list", "documentation": null, "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": false, "constraint": null }, { "label": "Pir Pickup Options", "property": "pirPickupOptions", "displayHint": "list", "resultColumn": true, "type": "list", "documentation": null, "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": false, "constraint": null }, { "label": "Min Checkout Reserve Time", "property": "minCheckoutReserveTime", "displayHint": "duration", "resultColumn": true, "type": "duration", "documentation": null, "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": false, "constraint": null }, { "label": "Max Checkout Reserve Time", "property": "maxCheckoutReserveTime", "displayHint": "circulationPeriod", "resultColumn": true, "type": "circulationPeriod", "documentation": null, "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": false, "constraint": null }, { "label": "Reservation Advance Limit", "property": "reservationAdvanceLimit", "displayHint": "duration", "resultColumn": true, "type": "duration", "documentation": null, "readAuth": [ { "type": "defaultAllow" } ], "writeAuth": [ { "type": "sysauth", "entity": "self", "auths": [ "MANAGE-LOCATIONS" ] } ], "dbSortable": false, "constraint": null } ], "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
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, the set of constrained values the query term will accept. (see Constraints below)
A plain-text description of the query term
POST rest/location/queryTerms
{ "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": [ { "name": "Org. ID", "parameter": "orgOid", "documentation": "Undocumented Term", "type": "integer", "displayHint": "integer", "constraint": null }, { "name": "Identity", "parameter": "identity", "documentation": "Undocumented Term", "type": "location", "displayHint": "autocomplete", "constraint": null }, { "name": "Autocomplete", "parameter": "autocomplete", "documentation": "Undocumented Term", "type": "string", "displayHint": "string", "constraint": null }, { "name": "Staffed", "parameter": "staffed", "documentation": "Undocumented Term", "type": "boolean", "displayHint": "boolean", "constraint": null }, { "name": "Unstaffed", "parameter": "unstaffed", "documentation": "Undocumented Term", "type": "boolean", "displayHint": "boolean", "constraint": null } ], "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
When a property or a search terms are constrained to a set of possible values, the system will attach a constraint. Constraints are a JSON array of objects, each object representing one of the options. The object contains a value, which is to be returned to the server as the value when selected, and a label to be displayed to the user. The framework MUST NEVER define "" as a valid value. null is the proper representation of "Nothing" when that option is appropriate.
The following is an example of the default patronClass constraint used for setting an allocation or a patron's patronClass, or as the possible options when searching for a patron or allocation. Constraints provided by the API may be dependent on the data in the database.
[ { "label": "Other", "value": "OTHER" }, { "label": "Continuing education", "value": "CONTINUING-EDUCATION" }, { "label": "Undergraduate freshman", "value": "UNDERGRADUATE-FRESHMAN" }, { "label": "Undergraduate sophomore", "value": "UNDERGRADUATE-SOPHOMORE" }, { "label": "Undergraduate junior", "value": "UNDERGRADUATE-JUNIOR" }, { "label": "Undergraduate senior", "value": "UNDERGRADUATE-SENIOR" }, { "label": "Graduate 1", "value": "GRAD1" }, { "label": "Graduate 2", "value": "GRAD2" }, { "label": "Employee", "value": "EMPLOYEE" }, { "label": "Faculty", "value": "FACULTY" } ]
POSTing to a namespace's search method will perform a search accross all entities of that type. An empty Request payload will result in the returing of all entites of the type. This shoudl 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/location/search
{ "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": { "count": 3, "summary": null, "result": [ { "_class": "location", "oid": 2, "name": "East" }, { "_class": "location", "oid": 1, "name": "Main" }, { "_class": "location", "oid": 3, "name": "West" } ] }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
POST rest/person/search
{ "userid": "admin", "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": { "count": 1, "summary": null, "result": [ { "_class": "person", "oid": 1, "name": "Daniel T. Pyne" } ] }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
POST rest/person/search
{ "userid": "admin", "properties": [ "street", "street2", "city", "state", "telephone", "email" ], "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": { "count": 1, "summary": null, "result": [ { "_class": "person", "oid": 1, "name": "Daniel T. Pyne", "email": null, "telephone": null, "state": null, "city": null, "street2": null, "street": null } ] }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
POST rest/person/search
{ "count": true, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": { "count": 502, "summary": null, "result": 502 }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
POST rest/person/search
{ "limit": 5, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": { "count": 502, "summary": null, "result": [ { "_class": "person", "oid": 1427, "name": "Nathaniel Abaravich" }, { "_class": "person", "oid": 1311, "name": "Sydney Adams" }, { "_class": "person", "oid": 1046, "name": "Jacquelyne Agdere" }, { "_class": "person", "oid": 1430, "name": "Balbina Ai" }, { "_class": "person", "oid": 1145, "name": "Sonia Aitken" } ] }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
POST rest/person/search
{ "limit": 5, "orderBy": "sortableName", "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": { "count": 502, "summary": null, "result": [ { "_class": "person", "oid": 1427, "name": "Nathaniel Abaravich" }, { "_class": "person", "oid": 1311, "name": "Sydney Adams" }, { "_class": "person", "oid": 1046, "name": "Jacquelyne Agdere" }, { "_class": "person", "oid": 1430, "name": "Balbina Ai" }, { "_class": "person", "oid": 1145, "name": "Sonia Aitken" } ] }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
Sort in descending canonical order (ex Z,Y,X,etc)
Sort in ascending canonical order (ex A,B,C,etc)
POST rest/person/search
{ "limit": 5, "orderBy": "sortableName", "orderDirection": "desc", "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": { "count": 502, "summary": null, "result": [ { "_class": "person", "oid": 1064, "name": "Matthew Zuniga" }, { "_class": "person", "oid": 1480, "name": "Emil Zukovski" }, { "_class": "person", "oid": 1355, "name": "Shomari Ziehler-Martin" }, { "_class": "person", "oid": 1296, "name": "Nicholas Yung" }, { "_class": "person", "oid": 1353, "name": "Mark Yu" } ] }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
Null values are sorted ahead of non-null values
Null values are sorted after non-null values
POST rest/person/search
{ "limit": 5, "offset": 0, "orderBy": "sortableName", "orderDirection": "desc", "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": { "count": 502, "summary": null, "result": [ { "_class": "person", "oid": 1064, "name": "Matthew Zuniga" }, { "_class": "person", "oid": 1480, "name": "Emil Zukovski" }, { "_class": "person", "oid": 1355, "name": "Shomari Ziehler-Martin" }, { "_class": "person", "oid": 1296, "name": "Nicholas Yung" }, { "_class": "person", "oid": 1353, "name": "Mark Yu" } ] }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
POST rest/person/search
{ "limit": 5, "offset": 5, "orderBy": "sortableName", "orderDirection": "desc", "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": { "count": 502, "summary": null, "result": [ { "_class": "person", "oid": 1182, "name": "Alexander Yuen" }, { "_class": "person", "oid": 1194, "name": "Georgina York" }, { "_class": "person", "oid": 1202, "name": "Lucy Yoon" }, { "_class": "person", "oid": 1424, "name": "Aaron Yoon" }, { "_class": "person", "oid": 1085, "name": "Yong-Ho Yi" } ] }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
The autocomplete framework was developed to support a specific user interface componant used by WebCheckout. This framework may change without warning as specific UI needs evolve.
The Autcomplete Framework is a set of methods and query terms that support dynamic autocomplete functionality; allowing the user to search for matching entities without envoking the entirety of the searching infrastructure.
Some namespaces have a command named "autocomplete" which accepts a string and returns one or more sets of results based on that string using logic specific to the type of entity. For example for person the command returns three sets of matches; by name, by userid and by barcode. As a user types text into an autocomplete widget, calls are made to these commands to populate the results.
Some search terms have the display-hint "autocomplete", and others the display hint "autocompleteString". The former accepts entities and is intended ot be used as the search term is the user selects a specific entoty in the autocomplete widget. The latter takes strings and will match all of the same results as the "autocomplete" command given the same string. The "autocompleteString" terms are used when the user opts to not select a specific entity in the widget and instead leaves the search string in place.
The list of entities that particiapte in the autcomplete Framework as of 4.3.0 is:
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 conciderably in upcomming releases.POST rest/allocation/searchConfigs
{ "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": [ { "name": "All Checkouts", "guid": "find-all-checkouts", "default": false }, { "name": "All Future Reservations", "guid": "find-all-future-allocations", "default": false }, { "name": "All Reservations", "guid": "find-all-reservations", "default": false }, { "name": "Canceled Reservations", "guid": "find-all-cancelled-reservations", "default": false }, { "name": "Find Allocations", "guid": "default-find-allocations", "default": true }, { "name": "Reservations Available Now", "guid": "find-reservations-available-now", "default": false }, { "name": "Reservations Pending Approval", "guid": "find-reservations-pending-approval", "default": false }, { "name": "Returned Checkouts", "guid": "find-returned-allocations", "default": false }, { "name": "Unreturned Checkouts", "guid": "find-unreturned-allocations", "default": false }, { "name": "Usage Report", "guid": "usage-report", "default": false }, { "name": "Whats Late", "guid": "find-whats-late", "default": false } ], "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
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": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": { "url": "wco?method=get-asset&name=PERSON-export.csv" }, "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
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": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": [ { "name": "exportCSV", "label": "Export CSV" }, { "name": "byItemUsageReport", "label": "Usage Report" } ], "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
POST rest/person/exports
{ "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": [ { "name": "exportCSV", "label": "Export CSV" }, { "name": "exportImportable", "label": "Export Importable" } ], "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
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.
Please note that commands are likely to undergo a great deal of revision in the comming releases. The list of commands for each namespace listed on your instance Entity Reference page is generated dynamicaly from the API and will be up to date.
POST rest/group/commands
{ "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }
HTTP 200
{ "apiVersion": "0.1", "session": "S-17898", "status": "ok", "notifications": null, "payload": [ { "name": "addAcceptedAuthorizations", "requiredArguments": [ { "name": "rtype", "type": "resourceType", "constraint": null, "multiple": null }, { "name": "groups", "type": "group", "constraint": null, "multiple": true } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "rtype", "auths": [ "MANAGE-RTYPES" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "addGroupMember", "requiredArguments": [ { "name": "person", "type": "person", "constraint": null, "multiple": null }, { "name": "group", "type": "group", "constraint": null, "multiple": null } ], "optionalArguments": [ { "name": "origin", "type": "string", "constraint": null, "multiple": null } ], "auth": [ { "type": "sysauth", "entity": "group", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "addGroupResourceType", "requiredArguments": [ { "name": "rtype", "type": "resourceType", "constraint": null, "multiple": null }, { "name": "group", "type": "group", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "group", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "associateGroups", "requiredArguments": [ { "name": "groupB", "type": "group", "constraint": null, "multiple": null }, { "name": "groupA", "type": "group", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "groupA", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "Associate two groups together" }, { "name": "authorizeAllMembers", "requiredArguments": [ { "name": "groupRtype", "type": "groupResourceType", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "groupRtype", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "exportGroupMembersImportable", "requiredArguments": [ { "name": "properties", "type": "keyword", "constraint": null, "multiple": true }, { "name": "oids", "type": "integer", "constraint": null, "multiple": true } ], "optionalArguments": [ { "name": "name", "type": "string", "constraint": null, "multiple": null } ], "auth": [ { "type": "sysauth", "entity": [ "applicationObject" ], "auths": [ "OPERATOR" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "groupAutocomplete", "requiredArguments": [ { "name": "string", "type": "string", "constraint": null, "multiple": null } ], "optionalArguments": [ { "name": "limit", "type": "integer", "constraint": null, "multiple": null } ], "auth": [ { "type": "defaultAllow" } ], "documentation": "Find all groups with names matching 'string'. Matching is performed using a list of space seperated tokens, which may match anywhere in the name of the group" }, { "name": "groupExportImportable", "requiredArguments": [ { "name": "properties", "type": "keyword", "constraint": null, "multiple": true }, { "name": "oids", "type": "integer", "constraint": null, "multiple": true } ], "optionalArguments": [ { "name": "name", "type": "string", "constraint": null, "multiple": null } ], "auth": [ { "type": "sysauth", "entity": [ "applicationObject" ], "auths": [ "OPERATOR" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "groupPersonSetExpiration", "requiredArguments": [ { "name": "date", "type": "timestamp", "constraint": null, "multiple": null }, { "name": "person", "type": "person", "constraint": null, "multiple": null }, { "name": "group", "type": "group", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "group", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "groupPersonTypes", "requiredArguments": [ { "name": "person", "type": "person", "constraint": null, "multiple": null }, { "name": "group", "type": "group", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": null, "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "groupSetExpiration", "requiredArguments": [ { "name": "date", "type": "timestamp", "constraint": null, "multiple": null }, { "name": "group", "type": "group", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "group", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "groupStatusCommand", "requiredArguments": [ { "name": "person", "type": "person", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": null, "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "removeGroupMember", "requiredArguments": [ { "name": "groupMember", "type": "groupMember", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "groupMember", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "removeGroupsFromSet", "requiredArguments": [ { "name": "groups", "type": "group", "constraint": null, "multiple": true }, { "name": "groupSet", "type": "groupSet", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "groupSet", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "removeResourceType", "requiredArguments": [ { "name": "groupRtype", "type": "groupResourceType", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "groupRtype", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "revokeAllMembers", "requiredArguments": [ { "name": "groupRtype", "type": "groupResourceType", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "groupRtype", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "selectAssociatedGroups", "requiredArguments": [ { "name": "sessionId", "type": "string", "constraint": null, "multiple": null }, { "name": "targetGroup", "type": "group", "constraint": null, "multiple": null }, { "name": "groups", "type": "group", "constraint": null, "multiple": true } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": [ "applicationObject" ], "auths": [ "OPERATOR" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "setGroupDescription", "requiredArguments": [ { "name": "desc", "type": "string", "constraint": null, "multiple": null }, { "name": "group", "type": "group", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "group", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "setGroupEndDate", "requiredArguments": [ { "name": "value", "type": "timestamp", "constraint": null, "multiple": null }, { "name": "group", "type": "group", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "group", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "setGroupName", "requiredArguments": [ { "name": "value", "type": "string", "constraint": null, "multiple": null }, { "name": "group", "type": "group", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "group", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "setGroupOrganization", "requiredArguments": [ { "name": "organization", "type": "organization", "constraint": null, "multiple": null }, { "name": "group", "type": "group", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "group", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "setGroupStartDate", "requiredArguments": [ { "name": "value", "type": "timestamp", "constraint": null, "multiple": null }, { "name": "group", "type": "group", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "group", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" }, { "name": "setMemberExpiration", "requiredArguments": [ { "name": "date", "type": "timestamp", "constraint": null, "multiple": null }, { "name": "groupMember", "type": "groupMember", "constraint": null, "multiple": null } ], "optionalArguments": null, "auth": [ { "type": "sysauth", "entity": "groupMember", "auths": [ "MANAGE-AUTHS" ] } ], "documentation": "UNDOCUMENTED FRAMEWORK COMMAND" } ], "sessionid": "696d0483-d95c-4721-9398-beefda6f2b64" }