API routes (Click a route to expand it, click here to expand/collapse all)
GET/ ⎘
Provides the API-specification. Only enabled if API exposure is enabled.
Parameter Location Type Requirements Optional Default value Description
format URI-Query string
enum: [ "KateAPI", "InternalAPIMap", "OpenAPI", "Swagger" ]
 Yes "KateAPI" Documentation format. We support KateAPI documentation, Swagger/OpenAPI documentation and raw output of the internal API-map cache.
openApiVersion URI-Query int
enum: [ 2, 3 ]
 Yes 2 Version 3 is crappy with request bodies, so we prefer version 2 (which only sucks regarding Response definitions; hence we prefer KateAPI documentation).
Response HTTP Type Description
Success 200 object The API-documentation.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
    GET/countries ⎘
    List all countries.
    Response HTTP Type Description
    Success 200 Country[] List of Countries.
    MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
    InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
    AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
    UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
    Authentication required:
    No
    • Authentication scheme: JWTAuth Requires: None ⎘
    GET/countries/{idCountry} ⎘Authentication required
    Retrieve a Country by ID.
    Parameter Location Type Requirements Optional Default value Description
    idCountry URI-Path int
    max: 128
    		 No The ID of the Country.
    Response HTTP Type Description
    Success 200 Country The Country.
    MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
    InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
    AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
    UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
    Authentication required:
    Yes
    • Authentication scheme: JWTAuth Requires: None ⎘
    GET/groups ⎘Authentication required
    Get a list of all Groups.
    Response HTTP Type Description
    Success 200 Groups[] An array of Groups.
    MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
    InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
    AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
    UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
    Authentication required:
    Yes
    • Authentication scheme: JWTAuth Requires: None ⎘
    GET/groups/{idGroup} ⎘Authentication required
    Retrieve a Group by ID.
    Parameter Location Type Requirements Optional Default value Description
    idGroup URI-Path int
    max: 128
    		 No The ID of the Group.
    Response HTTP Type Description
    Success 200 Group The Group.
    MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
    InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
    AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
    UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
    Authentication required:
    Yes
    • Authentication scheme: JWTAuth Requires: None ⎘
    GET/selectables ⎘Authentication required
    Search the Country list.
    Parameter Location Type Requirements Optional Default value Description
    idGroups URI-Query int[] No Array of REDGroup IDs that the specified REDPath belongs to.
    redPath URI-Query string
    pattern: ^[^\/]+$
    		 No REDPath of the EntitySelect to obtain country-items for.
    reData URI-Query string
    format: json
    		 No JSON-string of key-value map where keys represent SJAQueries occurring in REDSet-context literals in the filter, and their respective values contain their respective resolved values.
    limit URI-Query int Yes 9999 Limit the amount of results.
    search URI-Query string
    maxLength: 128
    		 Yes null Optional search query as additional filter. [deprecated, preferred to filter in front-end]
    Response HTTP Type Description
    Success 200 Country[] List of Country-selectables.
    MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
    InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
    AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
    UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
    Authentication required:
    Yes
    • Authentication scheme: JWTAuth Requires: None ⎘
    Authentication schemes (Click an authentication scheme to expand it)
    JWTAuth
    Result wrappers (Click a result-wrapper to expand it)
    Success
    Error