{"info":{"_postman_id":"e0cc20b5-e478-44f1-933b-a50674814111","name":"Axiell Web API","description":"

StartFragment

\n

The Axiell WebAPI is a command library that can be used to interact with
SQL Server Axiell Collections databases. Using this WebAPI you can
easily build your own applications.

\n

EndFragment

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1948141","collectionId":"e0cc20b5-e478-44f1-933b-a50674814111","publishedId":"2sAXxJhExy","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-01T08:21:48.000Z"},"item":[{"name":"Version","item":[{"name":"Get version","id":"288ffb52-6c6c-43e9-8ec0-7cf81a590688","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?command=getversion","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"command","value":"getversion"}],"variable":[]}},"response":[],"_postman_id":"288ffb52-6c6c-43e9-8ec0-7cf81a590688"}],"id":"78079d17-34dc-4712-b286-c3b10bd38c9d","_postman_id":"78079d17-34dc-4712-b286-c3b10bd38c9d","description":""},{"name":"Create","item":[{"name":"Insert record","id":"e09faa92-f777-4719-9250-9a0611af0dd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n \r\n \r\n MyMuseum\r\n painting\r\n My.Number.1\r\n Zelfportret\r\n \r\n \r\n","options":{"raw":{"language":"xml"}}},"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?command=insertrecord&database=collect.inf&xmltype=unstructured","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"command","value":"insertrecord"},{"key":"database","value":"collect.inf"},{"key":"xmltype","value":"unstructured"}],"variable":[]}},"response":[],"_postman_id":"e09faa92-f777-4719-9250-9a0611af0dd3"}],"id":"36fac324-57fc-41a0-ac6f-0120647bcf90","_postman_id":"36fac324-57fc-41a0-ac6f-0120647bcf90","description":""},{"name":"Read","item":[{"name":"Search all records in database collect.inf","id":"46c2f80c-6a98-4421-ba5d-05e95f76866b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?search=all&database=collect.inf","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"search","value":"all"},{"key":"database","value":"collect.inf"}],"variable":[]}},"response":[],"_postman_id":"46c2f80c-6a98-4421-ba5d-05e95f76866b"},{"name":"Search all records in default database","id":"85c1f4be-5078-4161-bdae-f6319093ed74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?search=all","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"search","value":"all"}],"variable":[]}},"response":[],"_postman_id":"85c1f4be-5078-4161-bdae-f6319093ed74"},{"name":"Search all records and limit result","id":"c497841a-05b5-4980-a1c5-06a48567c96c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?search=all&limit=4","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"search","value":"all"},{"key":"limit","value":"4"}],"variable":[]}},"response":[],"_postman_id":"c497841a-05b5-4980-a1c5-06a48567c96c"},{"name":"Search all records, limit the result, and skip records: from all records in collect.inf, return the fifth, sixth, seventh and eighth record","id":"89ce4f9f-f45e-4236-a474-b52620a58df1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?database=collect.inf&search=all&limit=4&startfrom=5","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"database","value":"collect.inf"},{"key":"search","value":"all"},{"key":"limit","value":"4"},{"key":"startfrom","value":"5"}],"variable":[]}},"response":[],"_postman_id":"89ce4f9f-f45e-4236-a474-b52620a58df1"},{"name":"Search an index for specific value: from all records in collect.inf, return the records with the whole word 'man' in the title","id":"e2d39df9-9a13-4b68-8310-1dbc28cb8de4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?database=collect.inf&search=title=man","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"database","value":"collect.inf"},{"key":"search","value":"title=man"}],"variable":[]}},"response":[],"_postman_id":"e2d39df9-9a13-4b68-8310-1dbc28cb8de4"},{"name":"Right truncation: from all records in the people database, return the records with the partial or whole name 'jo'","id":"63065034-06f0-4cc4-b809-fdfea7ec89f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?database=people&search=name=jo*","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"database","value":"people"},{"key":"search","value":"name=jo*"}],"variable":[]}},"response":[],"_postman_id":"63065034-06f0-4cc4-b809-fdfea7ec89f0"},{"name":"Determine the fields to return: of a record found with a priref search, request only two specific fields from the detailfields","id":"514bea98-fdff-4887-80e7-0c588c929d3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?database=collect.inf&search=priref=17&fields=creator,administration_name","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"database","value":"collect.inf"},{"key":"search","value":"priref=17"},{"key":"fields","value":"creator,administration_name"}],"variable":[]}},"response":[],"_postman_id":"514bea98-fdff-4887-80e7-0c588c929d3d"},{"name":"Boolean OR: use a comma as 'or' to search for multiple words in the title field","id":"e0c9b246-fe01-4bab-bdd4-524e4f1ee18c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?database=collect.inf&search=title=man,woman,child","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"database","value":"collect.inf"},{"key":"search","value":"title=man,woman,child"}],"variable":[]}},"response":[],"_postman_id":"e0c9b246-fe01-4bab-bdd4-524e4f1ee18c"},{"name":"Boolean AND: use a plus as 'and' to search for multiple words in the title field","id":"aff16f48-e57d-4f52-a5c7-19967abcba23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?database=collect.inf&search=title=man%2bwoman","description":"

StartFragment

\n

Note that the '+' needs to be hexadecimal encoded (as '+'), this is
because the '+' character in a url is interpreted as a space.

\n

EndFragment

\n","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"database","value":"collect.inf"},{"key":"search","value":"title=man%2bwoman"}],"variable":[]}},"response":[],"_postman_id":"aff16f48-e57d-4f52-a5c7-19967abcba23"},{"name":"Boolean AND NOT: use a minus as 'and not' to search for 'man' and not 'woman' in the title field","id":"05d50786-a1ca-4c39-b859-a1f0ea9533d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?database=collect.inf&search=title=man-woman","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"database","value":"collect.inf"},{"key":"search","value":"title=man-woman"}],"variable":[]}},"response":[],"_postman_id":"05d50786-a1ca-4c39-b859-a1f0ea9533d7"},{"name":"Search a dataset with Boolean WHEN: search truncated for records where the creator 'Batoni' has the role 'painter'.","id":"de4dcf87-3765-4d8d-ba9e-8dfff2eb8453","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?database=collect.inf&search=creator=Batoni* when creator.role=painter","description":"

StartFragment

\n

The WHEN operator is used when searching for two record details
appearing in the same occurrence of a field group. Creator and Role are
part of the same (repeatable) field group. So the example only finds
records in which 'Batoni' is the (first part of the) name of one of the
creators while he has the role 'painter'. If 'Batoni' and 'painter' do
not appear in the same field group occurrence, the record won't be
retrieved.

\n

EndFragment

\n","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"database","value":"collect.inf"},{"key":"search","value":"creator=Batoni* when creator.role=painter"}],"variable":[]}},"response":[],"_postman_id":"de4dcf87-3765-4d8d-ba9e-8dfff2eb8453"}],"id":"175f3815-c157-4def-abef-8a0f883d3245","_postman_id":"175f3815-c157-4def-abef-8a0f883d3245","description":""},{"name":"Update","item":[{"name":"Update record","id":"05c53843-7647-44b9-8acd-09093c7a6937","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n \r\n \r\n 110000956\r\n My.Number.14\r\n \r\n \r\n","options":{"raw":{"language":"xml"}}},"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?command=updaterecord&database=collect.inf&xmltype=unstructured","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"command","value":"updaterecord"},{"key":"database","value":"collect.inf"},{"key":"xmltype","value":"unstructured"}],"variable":[]}},"response":[],"_postman_id":"05c53843-7647-44b9-8acd-09093c7a6937"}],"id":"e4e26cd7-c550-41a1-a7b1-4e37e66de7f6","_postman_id":"e4e26cd7-c550-41a1-a7b1-4e37e66de7f6","description":""},{"name":"Delete","item":[{"name":"Delete record","id":"78958bc7-577a-4620-a987-d855f34a0716","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"78958bc7-577a-4620-a987-d855f34a0716"}],"id":"525c3224-f398-4ac1-81d6-ff98b7627a05","_postman_id":"525c3224-f398-4ac1-81d6-ff98b7627a05","description":""},{"name":"Meta data","item":[{"name":"Retrieve a list of available databases","id":"f2635a39-c55a-4f8c-96a0-6d931a94092e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?command=listdatabases","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"command","value":"listdatabases"}],"variable":[]}},"response":[],"_postman_id":"f2635a39-c55a-4f8c-96a0-6d931a94092e"},{"name":"Retrieve some metadata for a database","id":"97c0cda5-8326-4ed3-9729-9070a1ac6a16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?command=getmetadata&database=collect.inf&&fields=object_number,creator","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"command","value":"getmetadata"},{"key":"database","value":"collect.inf"},{"key":null,"value":null},{"key":"fields","value":"object_number,creator"}],"variable":[]}},"response":[],"_postman_id":"97c0cda5-8326-4ed3-9729-9070a1ac6a16"},{"name":"Get data dictionary meta data for a database","id":"8cddbbed-c2cb-4900-90c5-f1c9c5e66af6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?command=getmetadata&database=collect.inf&limit=0","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"command","value":"getmetadata"},{"key":"database","value":"collect.inf"},{"key":"limit","value":"0"}],"variable":[]}},"response":[],"_postman_id":"8cddbbed-c2cb-4900-90c5-f1c9c5e66af6"}],"id":"772fbcd1-5c76-44cd-a030-18043f532b14","_postman_id":"772fbcd1-5c76-44cd-a030-18043f532b14","description":""},{"name":"Media","item":[{"name":"Retrieve content","item":[{"name":"Retrieve image file 2043.jpg from the image server","id":"9bfd042f-079d-4348-8478-0ebdd724dea9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?command=getcontent&server=adlibimages&value=2043.jpg","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"command","value":"getcontent"},{"key":"server","value":"adlibimages"},{"key":"value","value":"2043.jpg"}],"variable":[]}},"response":[],"_postman_id":"9bfd042f-079d-4348-8478-0ebdd724dea9"},{"name":"Retrieve image file 2043.jpg from the image server and scale it","id":"ceec0202-3fb7-425b-b4fb-fc29ab7f2465","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?command=getcontent&server=adlibimages&value=2043.jpg&height=100","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"command","value":"getcontent"},{"key":"server","value":"adlibimages"},{"key":"value","value":"2043.jpg"},{"key":"height","value":"100"}],"variable":[]}},"response":[],"_postman_id":"ceec0202-3fb7-425b-b4fb-fc29ab7f2465"},{"name":"Retrieve image file 2043.jpg and scale it to fit within a square box with a whitesmoke background and rounded corners","id":"45a298f7-6b8a-435c-b7b5-01693e33d5bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?command=getcontent&server=adlibimages&value=2043.jpg&width=200&height=400&canvascolor=whitesmoke&cornerradius=20","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"command","value":"getcontent"},{"key":"server","value":"adlibimages"},{"key":"value","value":"2043.jpg"},{"key":"width","value":"200"},{"key":"height","value":"400"},{"key":"canvascolor","value":"whitesmoke"},{"key":"cornerradius","value":"20"}],"variable":[]}},"response":[],"_postman_id":"45a298f7-6b8a-435c-b7b5-01693e33d5bb"},{"name":"Retrieve just uploaded image \"afbeelding.jpg\"","id":"56526982-4ea2-451f-8612-7cd334649f51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?command=getcontent&server=adlibimages&value=afbeelding.jpg","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"command","value":"getcontent"},{"key":"server","value":"adlibimages"},{"key":"value","value":"afbeelding.jpg"}],"variable":[]}},"response":[],"_postman_id":"56526982-4ea2-451f-8612-7cd334649f51"}],"id":"a81ab12b-a13c-475a-b82a-a4b6462c3303","_postman_id":"a81ab12b-a13c-475a-b82a-a4b6462c3303","description":""},{"name":"Write content","item":[{"name":"Write new image","id":"7e46a9ca-1041-4e3b-aa15-7e4e78f3fae1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"file","file":{"src":"postman-cloud:///1ef7f399-a1be-4ec0-b99f-c0de0f083385"}},"url":"https://webapi.axiell.com/demowebapi/wwwopac.ashx?command=writecontent&server=adlibimages&value=afbeelding.jpg","urlObject":{"host":["https://webapi.axiell.com/demowebapi/wwwopac.ashx"],"query":[{"key":"command","value":"writecontent"},{"key":"server","value":"adlibimages"},{"key":"value","value":"afbeelding.jpg"}],"variable":[]}},"response":[],"_postman_id":"7e46a9ca-1041-4e3b-aa15-7e4e78f3fae1"}],"id":"e6677041-42a9-4a2e-8606-4e9b5d781f45","_postman_id":"e6677041-42a9-4a2e-8606-4e9b5d781f45","description":""}],"id":"cb787ae0-e5fb-4991-8ef4-b66d5f7f3de0","_postman_id":"cb787ae0-e5fb-4991-8ef4-b66d5f7f3de0","description":""}],"event":[{"listen":"prerequest","script":{"id":"2779d3b2-cbf5-428a-bf6d-e4d7f6f66dd6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c1648187-257c-4bfd-a579-b15043dafac3","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://webapi.axiell.com/demowebapi/wwwopac.ashx","type":"string"}]}