Explore the API

You can explore the API using the API Sandbox. The API Sandbox is a documentation website built into the software that makes it easy to explore the API. It shows you all the models and endpoints you need. In addition, you can execute API requests inside it to try it out.

To access the API Sandbox, click the API Help link from the Main Menu. You can also browse to it by adding /api/help at the end of your site. For example, https://mysite/api/help. Make sure to add the /prod or /test after your domain if applicable.

What Does the API Sandbox Do?

The API Sandbox shows all the models and endpoints and even allows you to run calls against your live data.

Click on the endpoints to reveal everything you need to know. You can then click on the Model or Example Value links to reveal the structures of the model and response.

mceclip1.png

How do I use it?

If you want to look at the documentation, you can browse by clicking the subject names in the list. If you want to interact with calls, see below.

  1. Click the Add Authorization button in the top right. The Add API Authorization screen opens.mceclip5.png
  2. Select JWT.
    mceclip1.png
  3. Enter the created API User information found in the API Users screen. The JWT at the bottom auto-generates. See example below.
    mceclip3.png
  4. Click Save and Close.

You can now use the Try It Now button on all the endpoints. Remember that it affects your data, so use caution if using against a production database. We strongly recommend not doing this against your production database.

A simple and safe example call is using a GET on an account, as shown below. Fill in any account's organization code and account code, and then click Try It Now. 

mceclip2.png

This retrieves the account's data from the software.

mceclip3.png

Related articles

Comments

9 comments

Date Votes
  • Steven Spyrka

    Is there a WSDL url or Swagger file?

    0 upvotes

  • Ryan G.
    • Edited

    Hi Steven,

    You can access your swagger file by using the following URL: https://[your Ungerboeck domain]/swagger/docs/v1

    Ryan Gilomen
    Ungerboeck Software International

    0 upvotes

  • Thomas Hohm (m:con-mannheim:congress GmbH)

    Hello,

    I want to add bookings via API to an event. It works if there is no booking conflict with existing other bookings inside other events.

    If there is a booking conflict, the API returns response code 400 with response message "Potential booking conflicts have been found: Space, date..."

    How can I create bookings and ignore the conflicts via API (without using die Ungerboeck SDK)?

    (I did not find any documentation about that in the Ungerboeck API Sandbox or on this supportcenter portal. I found a kind of hint inside the API examples on github: https://github.com/UngerboeckAPI/20.94/blob/master/Examples/Operations/Bookings.cs => " APIUtil.AddBookingWithoutConflictCheck")

    Thanks,

    Thomas

    0 upvotes

  • Sean Tame

    Does the API User ID have the correct rights under Access Privilege Allow Conflict Booking by Booking Status Limit?

    0 upvotes

  • Thomas Hohm (m:con-mannheim:congress GmbH)

    Hi Sean,

    yes:

    - I created a role for this API-User and added the role to the access privilege Allow Conflict Booking by Booking Status Limit with value=99.

    - after it did not work I added the user to the access privilege, also with value = 99 and still the same result.

    - we have waitlisting turned on with status range = 10-25

    - the booking I want to create has status = 25

    - when I create the same booking with the api-user via Ungerboeck v20 GUI (instead of API), the booking will be saved (and of course indicates potential conflicts, which is correct).

     

    What I would expect from the API: I can save the booking and might get a response code between 200 and 300 (not 400) and a response message indicating potential booking conflicts.

    From what I found in the API-examples on github ("APIUtil.AddBookingWithoutConflictCheck") I hoped that there is a way to bypass the conflict check.

     

     

    0 upvotes

  • Ryan G.

    Hi Thomas,

    You can choose to add bookings while ignoring conflict checks. 

    If you are not using the SDK Wrapper, you can still follow the same example the function is giving, which is adding a header to your bookings POST:

    "X-ValidationOverrides", [{"Code": 12015}]

    This will auto skip conflict checks.

    Anyone using using the SDK Wrapper can call the function APIUtil.AddBookingWithoutConflictCheck()

    Thanks!

    Ryan

    0 upvotes

  • Thomas Hohm (m:con-mannheim:congress GmbH)
    • Edited

    Hi Ryan,

     

    thanks a lot! Works great!

    Is there a similar way to ignore the "automatic waitlist status" logic? (I can book conflicts right now in space bookings, but I have problems with the event status value)

    Is there a similar way to cancel events & bookings (in best case including cancellation reason) ?

    Is there somewhere a document that lists all available header options?

     

    Thanks,

    Thomas

    0 upvotes

  • Rudy Scoggins

    Hi Thomas,

    There is currently no bypass for Automatic Waitlist Status.  Currently, that is the only ValidationOverride, but we are looking to add more.

    You can cancel Events with Reasons.  See the function here for CancelEvent.  You can cancel bookings by simply changing the booking status.

     

    0 upvotes

  • Thomas Hohm (m:con-mannheim:congress GmbH)

    Thanks!

    0 upvotes

Please sign in to leave a comment.