Skip to content

Commit

Permalink
syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
alina-lapina committed Oct 20, 2020
1 parent ebac516 commit 898646a
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions klass-api/src/main/asciidoc/api-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -510,21 +510,19 @@ include::{snippets}/select-codes-example-csv/http-response.adoc[]


=== csvSeparator
`csvSeparator` is used to specify separator to be used for csv format. Default is `,`
`csvSeparator` is used to specify a separator symbol to be used for csv format. Default is `,`

===== Example request for csvSeparator=;
include::{snippets}/csv-separator-example/curl-request.adoc[]
===== Example response
include::{snippets}/csv-separator-example/http-response.adoc[]



=== csvFields
`csvFields` is an optional parameter that allows a user to filter columns and specify columns order in the Csv output.
It is only applicable for `/codes` and `/codesAt` services.

Please note that the field names are case-sensitive If the service fails to match a field name with the available data
a 400 BAD REQUEST response will be returned.
The field names are case-sensitive. Misspelled field names will cause a 400 BAD REQUEST error.

===== Example request for csvFields=name,code with /codesAt;
include::{snippets}/csv-fields-codes-at-example/curl-request.adoc[]
Expand Down

0 comments on commit 898646a

Please sign in to comment.