Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add non-trivial Query examples to the API documentation #1

Open
cristobalito opened this issue Dec 30, 2016 · 2 comments
Open

Add non-trivial Query examples to the API documentation #1

cristobalito opened this issue Dec 30, 2016 · 2 comments

Comments

@cristobalito
Copy link

A number of the API methods take a Query parameter as input. All the examples appear to have a match all query, similar to this one for api/Ticket/Select:

<SelectRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vivantio.Model.Public.Common">
  <Query>
    <Items i:nil="true" />
    <Mode>MatchAny</Mode>
  </Query>
</SelectRequest>

While this is certainly useful, I believe it would also be useful to have some examples for more targeted queries e.g. searching for a particular user by email or similar.

@Vivantio
Copy link
Collaborator

Vivantio commented Jan 9, 2017

We do have a section in the wiki itself which has some more details on querying:
https://github.com/Vivantio/apisamples/wiki/Querying

This isn't quite as extensive as we like, but might be a good starting point for you.

For now, if you need further assistance building specific queries, you can email our support team on [email protected].

@Vivantio Vivantio closed this as completed Jan 9, 2017
@Vivantio Vivantio reopened this Jan 9, 2017
@cristobalito
Copy link
Author

cristobalito commented Jan 9, 2017 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant