APIs Flags on UCCX9 for time of day

Question

Hi,
I was discussing UCCX and our upgrades to V9 for a few of our customers with a Voice CCIE at an event a few days ago, and was explaining that  our customers found the configured time of day and holidays  in scripts was very restricting. They want the ability to upload holidays and early close the call centre via a Web interface. I advised that was looking into doing this via a SQL server running a stored procedure fired from a script; however this would not be possible with our clients on the enhanced license.
The CCIE mentioned that in UCCX v9 we can use APIs to set flags and reference these in scripts. I have has a trawl of the Web but cannot find any reference to this. Can someone point me in the right direction where I can find :-
a) How to reference these flags in scripts – I am more than happy to write the script logic
b) Info to pass to our Developer on how to integrate with APIs to set these flags.

Answer 1

Hi, first thing first, you should see this post, which lays out for you how to integrate UCCX Enhanced with an external DB via a "man in the middle" web server.
https://supportforums.cisco.com/docs/DOC-29776
Long story short, tell your developer to build a URL for accessing calendar and business hours logic in various formats: XML, JSON, HTML, etc.  You'll use XML, but asking them for more opens your options down the road.
Next up, the API's.  These are pretty new to UCCX, with v9.0 bringing the first round of access and then v10 coming in behind with even more access.
Normally, when I don't know the answer to a question on the forums, I go research it, and sometimes proof of concept it, and then post my findings.  However, the developer.cisco.com site has a revoked certificate at the moment and I cannot get to the API docs for UCCX.  Or says the proxy im going through anyway.
I've managed to get my hands on the documentation, unfortunately I don't have UCCX 9 or 10 to try this out on so look at this more of a point in the right direction.
The API you're CCIE was referring to is most likely the application API within System Configuration grouping of APIs.  It has five or so methods, one of them is an HTTP PUT to modify the application of your choice.
HTTP Method
PUT
URI
http:///adminapi/application/{applicationName}
Example URI
http://10.10.10.10/adminapi/application/mysweetapplication
Content Body Type
Application/XML or Application/JSON
Response Code on Success
HTTP 200
Response Codes on Failure
HTTP 401, 405 or 412
Error Codes
None
In your Content Body, which is like a file you send it with instructions in either XML or JSON format, you will need to send it:
script - The name of the current script (unless you plan to also change it)
scriptParams - The list of parameters for the script
script
In order to send it the same script name that is currently using, you'll need to query the application first, which means you'll need to use another one of the five available methods for the application: Get Application
HTTP Method
GET
URI
http:///adminapi/application/{applicationName}
Example URI
http://10.10.10.10/adminapi/applications/mysweetapplication
Content Body Type
Application/XML or Application/JSON
HTTP Code on Success
HTTP 200
HTTP Codes on Failure
HTTP 401, 405
Error Codes
None
Inside that response (assume XML for a moment) you will see:
    mysweetscript.aef 
This gives you the current script name to use in your Modify Method.
scriptParams
This is where things get a little fuzzy without some hand on experience (good thing there's also a forum on the delvepor site).  The application XSD shows us that the scriptParams element is defined as:
Which tells us that the name of the element is scriptParams, the type is variable (more on that in a second), it is optional, and can occur an infinite amount of times in the XML document.
The type variable is pretty key, as the application XSD defines type variable as:
That tells us three major things about variable types:
It has to have a single name element whose value has to be a string and have atleast one character in itThis is the name of the variable in your script  E.g., start_time
It has to have a single value element whose value has to be a string and have atleast one character in itThis is what value you want to set it to  E.g., T[8:00 AM]
It has to have a single type element whose value has to be a string and have atleast one character in itThis is what type of variable it is in your script  E.g., Time
Note that the XSD does not define the format of the name, value, or type elements, above the the string and 1 character limitation.
Therefore a valid XML document should look like:
<?xml version="1.0" encoding="utf-8"?>      mysweetscript.aef          start_time      T[8:00 AM]      Time     
To conclude this much longer than anticipated reply, a few things I do not know about how this works:
How do you disable the use of a parameter such that the script default value takes effect?
How do you set multiple parameters at once without sending multiple API PUT requests?
It might just be:
<?xml version="1.0" encoding="utf-8"?>      mysweetscript.aef          start_time      T[8:00 AM]      Time              end_time      T[5:00 PM]      Time   
Do you have to send all of the existing parameters, as to not inadvertinly disable them?  And if so, how do you get a list of them?  Perhaps from the Get Application method, but I don't see that sepcified anywhere.
EDIT: I do see that there is a query parameter for the GET operation of an application named detail which can have a value of full.  I'd need to test it though.
Good luck and happy API programming!
Anthony Holloway
Please use the star ratings to help drive great content to the top of searches.