SysAid Product Documentation Revamped !

Hi!

I know this post is a year old, but since you explicitly soliciting feedback, I thought I’d chime in with mine. I’m working with REST API so my comments will be exclusively on that documentation.

1. I believe you should provide a sample JSON for every request of every endpoint. At the moment there are only samples for response JSONs. I think those are severely missing.
2. Not only will it make it easier to use the API, but it will also help eliminate errors/confusions in the documentation. Like for example the documentation for Login calls the request values that must be supplied Parameters. Now in the HTTP world parameters are an actual entity and are appended to the end of the request URL. What the Login endpoint actually requires is a JSON input sent in the BODY of the request. :) So this is either confusing or incorrect depending on how you want to look at it. :)

HTH

Rudy