Results 1 to 4 of 4

Thread: Vixen 3 Web API Sequence Commands

  1. #1
    Join Date
    Sep 2018
    Posts
    2
    Post Thanks / Like

    Default Vixen 3 Web API Sequence Commands

    This year for my Halloween display I have decided to do something interactive and have sensors trigger my various sequences. However I am struggling to figure out the format to Vixen's resting web api. Below is an example of what I have been trying to send.

    https://desktop-4rgi471:8888/api/pla...oween+Test.tim

    My web server is enabled and I am able to do all the functions just by using the GUI in a web browser but I need direct commands. Any suggestions I appreciate the help as i cannot find any additional documentation or a direct contact at Vixen to ask.

    David

  2. #2
    Join Date
    Oct 2011
    Location
    Maryville, Illinois
    Posts
    1,610
    Post Thanks / Like

    Default Re: Vixen 3 Web API Sequence Commands

    Looks like you are trying to do a GET with the parameters as query strings. However it is a POST request with a JSON object in the payload that looks something like this. You won't be able to do that directly from a browser. I suggest using someone like Googles Postman to get the hang of making the restful requests. See this answer for a quick how to set it up.

    https://stackoverflow.com/a/38974774

    What do you plan to use to send the requests?

    {
    "Name":"Announcement",
    "FileName": "C:\\Users\\Bob\\Documents\\Vixen 3 - Halloween\\Sequence\\Announcement.tim"
    }

  3. #3
    Join Date
    Sep 2018
    Posts
    2
    Post Thanks / Like

    Default Re: Vixen 3 Web API Sequence Commands

    I downloaded postman and was successful in getting the sequence to play. Now I'm struggling with formatting via the Crestron SIO. Below is what the Postman shows as the generated Code Snippet.

    POST /api/play/playSequence HTTP/1.1
    Host: 192.168.1.22:8888
    Content-Type: application/json
    User-Agent: PostmanRuntime/7.17.1
    Accept: */*
    Cache-Control: no-cache
    Postman-Token: d5d41686-bb83-4ca5-b666-14702237d626,80aebe38-ab52-47f2-be7f-0cfdf0a3a0f3
    Host: 192.168.1.22:8888
    Accept-Encoding: gzip, deflate
    Content-Length: 123
    Connection: keep-alive
    cache-control: no-cache

    {
    "Name": "Halloween Test",
    "FileName": "C:\\users\\David\\Documents\\Vixen 3\\Sequence\\Halloween\\Halloween Test.tim"
    }

    Below is what I have been trying to send via Crestron

    POST /api/play/playSequence HTTP/1.1\x0AHost: 192.168.1.22:8888\x0AContent-Type: application/json\x0AConnection: keep-alive\x0a{"Name": "Halloween Test","FileName": "C:\\users\\David\\Documents\\Vixen 3\\Sequence\\Halloween\\Halloween Test.tim"}\x0A\x0A

    I've also tried to break it down and send lines one at a time.

    POST /api/play/playSequence HTTP/1.1\x0A
    Host: 192.168.1.22:8888\x0A
    Content-Type: application/json\x0A
    Connection: keep-alive\x0a
    {\x0A
    "Name": "Halloween Test",\x0A
    "FileName": "C:\\users\\David\\Documents\\Vixen 3\\Sequence\\Halloween\\Halloween Test.tim"\x0A
    }\x0A\x0A

  4. #4
    Join Date
    Oct 2014
    Location
    Sauk City, WI USA
    Posts
    1,171
    Post Thanks / Like

    Default Re: Vixen 3 Web API Sequence Commands

    do you get an error back?

Tags for this Thread

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •