1. Overview

Automatically-generated documentation based on Swagger and created by Springfox.

1.1. Version information

Version : 2.1.2-SNAPSHOT

1.2. Contact information

Contact : Manos Batsis
Contact Email : manosbatsis gmail

1.3. License information

License : LGPLv3
License URL : https://www.gnu.org/licenses/lgpl-3.0.en.html
Terms of service : urn:tos

1.4. URI scheme

Host : localhost:8080
BasePath : /restdude

1.5. Tags

  • Auth : Authentication operations

  • AuthAccount : User account operations

  • Client Errors : Client Error Operations

  • ContactDetails : Contact details

  • Continents : Operations about continent

  • Countries : Operations about countries

  • ErrorLogs : Stacktrace or other error log details.

  • Errors : Generic error information (readonly)

  • Friends : Friend searches

  • Friendships : Operations about friendships

  • Hosts : Operations about hosts

  • Invitations : Invite new users

  • Localities : Locality operations

  • PersonalDetails : Personal information operations

  • PostalCodes : Postal code operations

  • RegistrationCodeBatches : Codes management (admin, operator)

  • Roles : Operations about roles

  • STOMP Sessions : STOMP Session Operations

  • System Errors : System Error Operations (readonly)

  • User Agents : Collection of UA signatures

  • User Credentials : Operations about user credentials

  • UserRegistrationCode : User registration codes (read-only)

  • Users : User management operations

  • audit-events-mvc-endpoint : Audit Events Mvc Endpoint

  • endpoint-mvc-adapter : Endpoint Mvc Adapter

  • environment-mvc-endpoint : Environment Mvc Endpoint

  • hal-json-mvc-endpoint : Hal Json Mvc Endpoint

  • health-mvc-endpoint : Health Mvc Endpoint

  • heapdump-mvc-endpoint : Heapdump Mvc Endpoint

  • index-jsp-controller : Index Jsp Controller

  • jwt-controller : Jwt Controller

  • loggers-mvc-endpoint : Loggers Mvc Endpoint

  • metrics-mvc-endpoint : Metrics Mvc Endpoint

2. Resources

2.1. Auth

Authentication operations

2.1.1. Login

POST /api/auth/userDetails
Description

Login using a JSON object with email/password properties.

Parameters
Type Name Description Schema

Body

resource
required

resource

Login Submission
Responses
HTTP Code Description Schema

200

OK

UserDetails

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.1.2. Remember

GET /api/auth/userDetails
Description

Login user if remembered

Responses
HTTP Code Description Schema

200

OK

UserDetails

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.1.3. Logout

DELETE /api/auth/userDetails
Description

Logout and forget user

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

Produces

  • application/json

2.1.4. Verify

POST /api/auth/userDetails/verification
Description

Validation utility operation, used to verify the user based on current password.

Parameters
Type Name Description Schema

Body

resource
required

resource

Login Submission
Responses
HTTP Code Description Schema

200

OK

UserDetails

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.1.5. Login

POST /apiauth/userDetails
Description

Login using a JSON object with email/password properties.

Parameters
Type Name Description Schema

Body

resource
required

resource

Login Submission
Responses
HTTP Code Description Schema

200

OK

UserDetails

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.1.6. Remember

GET /apiauth/userDetails
Description

Login user if remembered

Responses
HTTP Code Description Schema

200

OK

UserDetails

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.1.7. Logout

DELETE /apiauth/userDetails
Description

Logout and forget user

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

Produces

  • application/json

2.1.8. Verify

POST /apiauth/userDetails/verification
Description

Validation utility operation, used to verify the user based on current password.

Parameters
Type Name Description Schema

Body

resource
required

resource

Login Submission
Responses
HTTP Code Description Schema

200

OK

UserDetails

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.2. AuthAccount

User account operations

2.2.1. Register new account

POST /api/auth/account
Description

Register a new user

Parameters
Type Name Description Schema

Body

resource
required

resource

UserAccountRegistration
Responses
HTTP Code Description Schema

201

Created

User

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

2.2.2. Confirm registration email and/or update account password

PUT /api/auth/account
Description

Confirm registration email and/or update, reset, or request to reset an account password. The operation handles three cases. 1) When logged-in, provide currentPassword, password and passwordConfirmation to immediately change password. 2) when anonymous, provide resetPasswordToken, password and passwordConfirmation to immediatelychange password. 3) when anonymous, provide email or username to have a password reset token and link sent to your inbox.

Parameters
Type Name Description Schema

Body

resource
required

resource

EmailConfirmationOrPasswordResetRequest
Responses
HTTP Code Description Schema

200

OK

UserDetails

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

2.2.3. Update username

PUT /api/auth/account/username
Description

Updates the username of the curent user and updates the auth token cookie.

Parameters
Type Name Description Schema

Body

resource
required

resource

UsernameChangeRequest
Responses
HTTP Code Description Schema

200

OK

UserDetails

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

2.2.4. Register new account

POST /api/auth/accounts
Description

Register a new user

Parameters
Type Name Description Schema

Body

resource
required

resource

UserAccountRegistration
Responses
HTTP Code Description Schema

201

Created

User

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

2.2.5. Confirm registration email and/or update account password

PUT /api/auth/accounts
Description

Confirm registration email and/or update, reset, or request to reset an account password. The operation handles three cases. 1) When logged-in, provide currentPassword, password and passwordConfirmation to immediately change password. 2) when anonymous, provide resetPasswordToken, password and passwordConfirmation to immediatelychange password. 3) when anonymous, provide email or username to have a password reset token and link sent to your inbox.

Parameters
Type Name Description Schema

Body

resource
required

resource

EmailConfirmationOrPasswordResetRequest
Responses
HTTP Code Description Schema

200

OK

UserDetails

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

2.2.6. Update username

PUT /api/auth/accounts/username
Description

Updates the username of the curent user and updates the auth token cookie.

Parameters
Type Name Description Schema

Body

resource
required

resource

UsernameChangeRequest
Responses
HTTP Code Description Schema

200

OK

UserDetails

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

2.3. Client Errors

Client Error Operations

2.3.1. Create a new resource

POST /api/rest/clientErrors
Parameters
Type Name Description Schema

Body

model
required

model

ClientError
Responses
HTTP Code Description Schema

201

Created

Resource«ClientError»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.3.2. Search for resources (paginated).

GET /api/rest/clientErrors
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

PagedModelResources«ClientError»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.3.3. Get CORS headers

OPTIONS /api/rest/clientErrors
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.3.4. Get JSON Schema

GET /api/rest/clientErrors/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.3.5. Get UI schema

GET /api/rest/clientErrors/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.3.6. Update files

POST /api/rest/clientErrors/{id}/files
Description

The files are saved using the parameter names of the multipart files contained in this request. These are the field names of the form (like with normal parameters), not the original file names.

Parameters
Type Name Description Schema

Path

id
required

id

string

Body

request
optional

request

MultipartHttpServletRequest
Responses
HTTP Code Description Schema

200

OK

ClientError

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • multipart/*

Produces

  • application/xml

  • application/json

2.3.7. Find by pk

GET /api/rest/clientErrors/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«ClientError,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.3.8. Update a resource

PUT /api/rest/clientErrors/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

ClientError
Responses
HTTP Code Description Schema

200

OK

Resource«ClientError»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.3.9. Delete a resource

DELETE /api/rest/clientErrors/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.3.10. Patch (partially update) a resource

PATCH /api/rest/clientErrors/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

ClientError
Responses
HTTP Code Description Schema

200

OK

Resource«ClientError»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.3.11. Find related by root pk

GET /api/rest/clientErrors/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«ClientError»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.3.12. Find related by root pk

GET /api/rest/clientErrors/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«ClientError»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.4. ContactDetails

Contact details

2.4.1. Create a new JSON API Resource

POST /api/rest/contactDetails
Parameters
Type Name Description Schema

Body

document
required

document

JsonApiModelResourceDocument«ContactDetails,string»
Responses
HTTP Code Description Schema

201

Created

JsonApiModelResourceDocument«ContactDetails,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.4.2. Search by pks

GET /api/rest/contactDetails
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

pks
required

string

Query

pks[]
required

pks[]

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

ModelResources«ContactDetails»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.4.3. Get CORS headers

OPTIONS /api/rest/contactDetails
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.4.4. Get JSON Schema

GET /api/rest/contactDetails/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.4.5. Get UI schema

GET /api/rest/contactDetails/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.4.6. Find by pk

GET /api/rest/contactDetails/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«ContactDetails,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.4.7. Update a resource

PUT /api/rest/contactDetails/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

ContactDetails
Responses
HTTP Code Description Schema

200

OK

Resource«ContactDetails»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.4.8. Delete a resource

DELETE /api/rest/contactDetails/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.4.9. Patch (partially update) a resource

PATCH /api/rest/contactDetails/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

ContactDetails
Responses
HTTP Code Description Schema

200

OK

Resource«ContactDetails»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.4.10. Find related by root pk

GET /api/rest/contactDetails/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«ContactDetails»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.4.11. Find related by root pk

GET /api/rest/contactDetails/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«ContactDetails»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.5. Continents

Operations about continent

2.5.1. Create a new resource

POST /api/rest/continents
Parameters
Type Name Description Schema

Body

model
required

model

Continent
Responses
HTTP Code Description Schema

201

Created

Resource«Continent»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.5.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/continents
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceCollectionDocument«Continent,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.5.3. Get CORS headers

OPTIONS /api/rest/continents
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.5.4. Get JSON Schema

GET /api/rest/continents/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.5.5. Get UI schema

GET /api/rest/continents/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.5.6. Find by pk

GET /api/rest/continents/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«Continent,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.5.7. Update a resource

PUT /api/rest/continents/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

Continent
Responses
HTTP Code Description Schema

200

OK

Resource«Continent»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.5.8. Delete a resource

DELETE /api/rest/continents/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.5.9. Patch (partially update) a resource

PATCH /api/rest/continents/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

Continent
Responses
HTTP Code Description Schema

200

OK

Resource«Continent»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.5.10. Find related by root pk

GET /api/rest/continents/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«Continent»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.5.11. Find related by root pk

GET /api/rest/continents/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«Continent»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.6. Countries

Operations about countries

2.6.1. Create a new resource

POST /api/rest/countries
Parameters
Type Name Description Schema

Body

model
required

model

Country
Responses
HTTP Code Description Schema

201

Created

Resource«Country»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.6.2. Search for resources (paginated).

GET /api/rest/countries
Description

Find all resources matching the given criteria and return a paginated JSON API Document.

Parameters
Type Name Description Schema Default

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceCollectionDocument«Country,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.6.3. Get CORS headers

OPTIONS /api/rest/countries
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.6.4. Get JSON Schema

GET /api/rest/countries/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.6.5. Get UI schema

GET /api/rest/countries/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.6.6. Find by pk

GET /api/rest/countries/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

ModelResource«Country»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.6.7. Update a resource

PUT /api/rest/countries/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

Country
Responses
HTTP Code Description Schema

200

OK

Resource«Country»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.6.8. Delete a resource

DELETE /api/rest/countries/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.6.9. Patch (partially plainJsonPut) a resource given as a JSON API Document

PATCH /api/rest/countries/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

document
required

document

JsonApiModelResourceDocument«Country,string»
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«Country,string»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.6.10. Find related by root pk

GET /api/rest/countries/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«Country»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.6.11. Find related by root pk

GET /api/rest/countries/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«Country»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.7. ErrorLogs

Stacktrace or other error log details.

2.7.1. Create a new resource

POST /api/rest/errorLogs
Parameters
Type Name Description Schema

Body

model
required

model

ErrorLog
Responses
HTTP Code Description Schema

201

Created

Resource«ErrorLog»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.7.2. Search by pks

GET /api/rest/errorLogs
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

pks
required

string

Query

pks[]
required

pks[]

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

ModelResources«ErrorLog»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.7.3. Get CORS headers

OPTIONS /api/rest/errorLogs
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.7.4. Get JSON Schema

GET /api/rest/errorLogs/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.7.5. Get UI schema

GET /api/rest/errorLogs/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.7.6. Find by pk

GET /api/rest/errorLogs/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«ErrorLog,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.7.7. Update a resource

PUT /api/rest/errorLogs/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

ErrorLog
Responses
HTTP Code Description Schema

200

OK

Resource«ErrorLog»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.7.8. Delete a resource

DELETE /api/rest/errorLogs/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.7.9. Patch (partially update) a resource

PATCH /api/rest/errorLogs/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

ErrorLog
Responses
HTTP Code Description Schema

200

OK

Resource«ErrorLog»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.7.10. Find related by root pk

GET /api/rest/errorLogs/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«ErrorLog»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.7.11. Find related by root pk

GET /api/rest/errorLogs/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«ErrorLog»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.8. Errors

Generic error information (readonly)

2.8.1. Create a new resource

POST /api/rest/allErrors
Parameters
Type Name Description Schema

Body

model
required

model

BaseError
Responses
HTTP Code Description Schema

201

Created

Resource«BaseError»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.8.2. Search for resources (paginated).

GET /api/rest/allErrors
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

PagedModelResources«BaseError»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.8.3. Get CORS headers

OPTIONS /api/rest/allErrors
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.8.4. Get JSON Schema

GET /api/rest/allErrors/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.8.5. Get UI schema

GET /api/rest/allErrors/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.8.6. Find by pk

GET /api/rest/allErrors/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«BaseError,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.8.7. Update a resource

PUT /api/rest/allErrors/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

BaseError
Responses
HTTP Code Description Schema

200

OK

Resource«BaseError»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.8.8. Delete a resource

DELETE /api/rest/allErrors/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.8.9. Patch (partially plainJsonPut) a resource given as a JSON API Document

PATCH /api/rest/allErrors/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

document
required

document

JsonApiModelResourceDocument«BaseError,string»
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«BaseError,string»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.8.10. Find related by root pk

GET /api/rest/allErrors/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«BaseError»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.8.11. Find related by root pk

GET /api/rest/allErrors/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«BaseError»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.9. Friends

Friend searches

2.9.1. Find all friends (paginated)

GET /api/rest/friends/my
Description

Find all friends of the current user. Returns paginated results

Parameters
Type Name Description Schema Default

Query

page
optional

page

integer(int32)

"0"

Query

size
optional

size

integer(int32)

"10"

Query

sort
optional

sort

string

"pk"

Query

status
optional

status

< string > array(multi)

"CONFIRMED"
Responses
HTTP Code Description Schema

200

OK

Page«UserDTO»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

2.9.2. Find all friends of a friend (paginated)

GET /api/rest/friends/{friendId}
Description

Find all friends of a friend. Returns paginated results

Parameters
Type Name Description Schema Default

Path

friendId
required

string

string

Query

page
optional

page

integer(int32)

"0"

Query

size
optional

size

integer(int32)

"10"

Query

sort
optional

sort

string

"pk"

Query

status
optional

status

< string > array(multi)

"CONFIRMED"
Responses
HTTP Code Description Schema

200

OK

Page«UserDTO»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

2.10. Friendships

Operations about friendships

2.10.1. Create a new JSON API Resource

POST /api/rest/friendships
Parameters
Type Name Description Schema

Body

document
required

document

JsonApiModelResourceDocument«Friendship,FriendshipIdentifier»
Responses
HTTP Code Description Schema

201

Created

JsonApiModelResourceDocument«Friendship,FriendshipIdentifier»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.10.2. Search for resources (paginated).

GET /api/rest/friendships
Description

Find all resources matching the given criteria and return a paginated JSON API Document.

Parameters
Type Name Description Schema Default

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceCollectionDocument«Friendship,FriendshipIdentifier»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.10.3. Get CORS headers

OPTIONS /api/rest/friendships
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.10.4. Get JSON Schema

GET /api/rest/friendships/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.10.5. Get UI schema

GET /api/rest/friendships/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.10.6. Find by pk

GET /api/rest/friendships/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

ModelResource«Friendship»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.10.7. Update a resource

PUT /api/rest/friendships/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

Friendship
Responses
HTTP Code Description Schema

200

OK

Resource«Friendship»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.10.8. Delete a resource

DELETE /api/rest/friendships/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.10.9. Patch (partially update) a resource

PATCH /api/rest/friendships/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

Friendship
Responses
HTTP Code Description Schema

200

OK

Resource«Friendship»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.10.10. Find related by root pk

GET /api/rest/friendships/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«Friendship»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.10.11. Find related by root pk

GET /api/rest/friendships/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«Friendship»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.11. Hosts

Operations about hosts

2.11.1. Create a new resource

POST /api/rest/hosts
Parameters
Type Name Description Schema

Body

model
required

model

Host
Responses
HTTP Code Description Schema

201

Created

Resource«Host»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.11.2. Search by pks

GET /api/rest/hosts
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

pks
required

string

Query

pks[]
required

pks[]

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

ModelResources«Host»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.11.3. Get CORS headers

OPTIONS /api/rest/hosts
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.11.4. Get JSON Schema

GET /api/rest/hosts/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.11.5. Get UI schema

GET /api/rest/hosts/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.11.6. Find by pk

GET /api/rest/hosts/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«Host,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.11.7. Update a resource

PUT /api/rest/hosts/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

Host
Responses
HTTP Code Description Schema

200

OK

Resource«Host»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.11.8. Delete a resource

DELETE /api/rest/hosts/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.11.9. Patch (partially plainJsonPut) a resource given as a JSON API Document

PATCH /api/rest/hosts/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

document
required

document

JsonApiModelResourceDocument«Host,string»
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«Host,string»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.11.10. Find related by root pk

GET /api/rest/hosts/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«Host»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.11.11. Find related by root pk

GET /api/rest/hosts/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«Host»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.12. Invitations

Invite new users

2.12.1. Invite users

POST /api/rest/invitations
Description

Invite users by email

Parameters
Type Name Description Schema

Body

invitations
required

invitations

UserInvitationsDTO
Responses
HTTP Code Description Schema

201

Created

UserInvitationResultsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

2.13. Localities

Locality operations

2.13.1. Create a new JSON API Resource

POST /api/rest/localities
Parameters
Type Name Description Schema

Body

document
required

document

JsonApiModelResourceDocument«Locality,string»
Responses
HTTP Code Description Schema

201

Created

JsonApiModelResourceDocument«Locality,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.13.2. Search by pks

GET /api/rest/localities
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

pks
required

string

Query

pks[]
required

pks[]

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceCollectionDocument«Locality,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.13.3. Get CORS headers

OPTIONS /api/rest/localities
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.13.4. Get JSON Schema

GET /api/rest/localities/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.13.5. Get UI schema

GET /api/rest/localities/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.13.6. Find by pk

GET /api/rest/localities/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

ModelResource«Locality»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.13.7. Update a resource

PUT /api/rest/localities/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

Locality
Responses
HTTP Code Description Schema

200

OK

Resource«Locality»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.13.8. Delete a resource

DELETE /api/rest/localities/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.13.9. Patch (partially plainJsonPut) a resource given as a JSON API Document

PATCH /api/rest/localities/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

document
required

document

JsonApiModelResourceDocument«Locality,string»
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«Locality,string»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.13.10. Find related by root pk

GET /api/rest/localities/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«Locality»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.13.11. Find related by root pk

GET /api/rest/localities/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«Locality»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.14. PersonalDetails

Personal information operations

2.14.1. Create a new JSON API Resource

POST /api/rest/personalDetails
Parameters
Type Name Description Schema

Body

document
required

document

JsonApiModelResourceDocument«PersonalDetails,string»
Responses
HTTP Code Description Schema

201

Created

JsonApiModelResourceDocument«PersonalDetails,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.14.2. Search for resources (paginated).

GET /api/rest/personalDetails
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

PagedModelResources«PersonalDetails»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.14.3. Get CORS headers

OPTIONS /api/rest/personalDetails
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.14.4. Get JSON Schema

GET /api/rest/personalDetails/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.14.5. Get UI schema

GET /api/rest/personalDetails/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.14.6. Find by pk

GET /api/rest/personalDetails/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«PersonalDetails,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.14.7. Update a resource

PUT /api/rest/personalDetails/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

PersonalDetails
Responses
HTTP Code Description Schema

200

OK

Resource«PersonalDetails»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.14.8. Delete a resource

DELETE /api/rest/personalDetails/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.14.9. Patch (partially update) a resource

PATCH /api/rest/personalDetails/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

PersonalDetails
Responses
HTTP Code Description Schema

200

OK

Resource«PersonalDetails»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.14.10. Find related by root pk

GET /api/rest/personalDetails/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«PersonalDetails»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.14.11. Find related by root pk

GET /api/rest/personalDetails/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«PersonalDetails»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.15. PostalCodes

Postal code operations

2.15.1. Create a new JSON API Resource

POST /api/rest/postalCodes
Parameters
Type Name Description Schema

Body

document
required

document

JsonApiModelResourceDocument«PostalCode,string»
Responses
HTTP Code Description Schema

201

Created

JsonApiModelResourceDocument«PostalCode,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.15.2. Search for resources (paginated).

GET /api/rest/postalCodes
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

PagedModelResources«PostalCode»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.15.3. Get CORS headers

OPTIONS /api/rest/postalCodes
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.15.4. Get JSON Schema

GET /api/rest/postalCodes/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.15.5. Get UI schema

GET /api/rest/postalCodes/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.15.6. Find by pk

GET /api/rest/postalCodes/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

ModelResource«PostalCode»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.15.7. Update a resource

PUT /api/rest/postalCodes/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

PostalCode
Responses
HTTP Code Description Schema

200

OK

Resource«PostalCode»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.15.8. Delete a resource

DELETE /api/rest/postalCodes/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.15.9. Patch (partially plainJsonPut) a resource given as a JSON API Document

PATCH /api/rest/postalCodes/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

document
required

document

JsonApiModelResourceDocument«PostalCode,string»
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«PostalCode,string»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.15.10. Find related by root pk

GET /api/rest/postalCodes/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«PostalCode»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.15.11. Find related by root pk

GET /api/rest/postalCodes/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«PostalCode»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.16. RegistrationCodeBatches

Codes management (admin, operator)

2.16.1. Create a new JSON API Resource

POST /api/rest/registrationCodeBatches
Parameters
Type Name Description Schema

Body

document
required

document

JsonApiModelResourceDocument«UserRegistrationCodeBatch,string»
Responses
HTTP Code Description Schema

201

Created

JsonApiModelResourceDocument«UserRegistrationCodeBatch,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.16.2. Search by pks

GET /api/rest/registrationCodeBatches
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

pks
required

string

Query

pks[]
required

pks[]

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

ModelResources«UserRegistrationCodeBatch»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

2.16.3. Get CORS headers

OPTIONS /api/rest/registrationCodeBatches
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.16.4. Get JSON Schema

GET /api/rest/registrationCodeBatches/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.16.5. Get UI schema

GET /api/rest/registrationCodeBatches/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.16.6. Export batch to a spreadsheet (CSV) report

GET /api/rest/registrationCodeBatches/{id}/csv
Description

The filename will be [batch name]_[date: yyyyMMddHHmmss].csv

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

< UserRegistrationCodeInfo > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • text/csv

2.16.7. Find by pk

GET /api/rest/registrationCodeBatches/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

ModelResource«UserRegistrationCodeBatch»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

2.16.8. Update a resource

PUT /api/rest/registrationCodeBatches/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

UserRegistrationCodeBatch
Responses
HTTP Code Description Schema

200

OK

Resource«UserRegistrationCodeBatch»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

2.16.9. Delete a resource

DELETE /api/rest/registrationCodeBatches/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

2.16.10. Patch (partially update) a resource

PATCH /api/rest/registrationCodeBatches/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

UserRegistrationCodeBatch
Responses
HTTP Code Description Schema

200

OK

Resource«UserRegistrationCodeBatch»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

2.16.11. Find related by root pk

GET /api/rest/registrationCodeBatches/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«UserRegistrationCodeBatch»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.16.12. Find related by root pk

GET /api/rest/registrationCodeBatches/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«UserRegistrationCodeBatch»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/xml

  • application/json

2.17. Roles

Operations about roles

2.17.1. Create a new JSON API Resource

POST /api/rest/roles
Parameters
Type Name Description Schema

Body

document
required

document

JsonApiModelResourceDocument«Role,string»
Responses
HTTP Code Description Schema

201

Created

JsonApiModelResourceDocument«Role,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.17.2. Search for resources (paginated).

GET /api/rest/roles
Description

Find all resources matching the given criteria and return a paginated JSON API Document.

Parameters
Type Name Description Schema Default

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceCollectionDocument«Role,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.17.3. Get CORS headers

OPTIONS /api/rest/roles
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.17.4. Get JSON Schema

GET /api/rest/roles/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.17.5. Get UI schema

GET /api/rest/roles/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.17.6. Find by pk

GET /api/rest/roles/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

ModelResource«Role»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.17.7. Update a resource

PUT /api/rest/roles/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

Role
Responses
HTTP Code Description Schema

200

OK

Resource«Role»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.17.8. Delete a resource

DELETE /api/rest/roles/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.17.9. Patch (partially update) a resource

PATCH /api/rest/roles/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

Role
Responses
HTTP Code Description Schema

200

OK

Resource«Role»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.17.10. Find related by root pk

GET /api/rest/roles/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«Role»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.17.11. Find related by root pk

GET /api/rest/roles/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«Role»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.18. STOMP Sessions

STOMP Session Operations

2.18.1. Create a new resource

POST /api/rest/stompSessions
Parameters
Type Name Description Schema

Body

model
required

model

STOMP Session
Responses
HTTP Code Description Schema

201

Created

Resource«STOMP Session»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.18.2. Search for resources (paginated).

GET /api/rest/stompSessions
Description

Find all resources matching the given criteria and return a paginated collection.Predefined paging properties are _pn (page number), _ps (page size) and sort. All serialized member names of the resource are supported as search criteria in the form of HTTP URL parameters.

Parameters
Type Name Description Schema Default

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

PagedModelResources«STOMP Session»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.18.3. Get CORS headers

OPTIONS /api/rest/stompSessions
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.18.4. Get JSON Schema

GET /api/rest/stompSessions/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.18.5. Get UI schema

GET /api/rest/stompSessions/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.18.6. Find by pk

GET /api/rest/stompSessions/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«STOMP Session,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.18.7. Update a resource

PUT /api/rest/stompSessions/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

STOMP Session
Responses
HTTP Code Description Schema

200

OK

Resource«STOMP Session»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.18.8. Delete a resource

DELETE /api/rest/stompSessions/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.18.9. Patch (partially plainJsonPut) a resource given as a JSON API Document

PATCH /api/rest/stompSessions/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

document
required

document

JsonApiModelResourceDocument«STOMP Session,string»
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«STOMP Session,string»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.18.10. Find related by root pk

GET /api/rest/stompSessions/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«STOMP Session»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.18.11. Find related by root pk

GET /api/rest/stompSessions/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«STOMP Session»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.19. System Errors

System Error Operations (readonly)

2.19.1. Create a new resource

POST /api/rest/systemErrors
Parameters
Type Name Description Schema

Body

model
required

model

SystemError
Responses
HTTP Code Description Schema

201

Created

Resource«SystemError»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.19.2. Search by pks

GET /api/rest/systemErrors
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

pks
required

string

Query

pks[]
required

pks[]

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceCollectionDocument«SystemError,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.19.3. Get CORS headers

OPTIONS /api/rest/systemErrors
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.19.4. Get JSON Schema

GET /api/rest/systemErrors/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.19.5. Get UI schema

GET /api/rest/systemErrors/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.19.6. Find by pk

GET /api/rest/systemErrors/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«SystemError,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.19.7. Update a resource

PUT /api/rest/systemErrors/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

SystemError
Responses
HTTP Code Description Schema

200

OK

Resource«SystemError»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.19.8. Delete a resource

DELETE /api/rest/systemErrors/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.19.9. Patch (partially plainJsonPut) a resource given as a JSON API Document

PATCH /api/rest/systemErrors/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

document
required

document

JsonApiModelResourceDocument«SystemError,string»
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«SystemError,string»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.19.10. Find related by root pk

GET /api/rest/systemErrors/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«SystemError»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.19.11. Find related by root pk

GET /api/rest/systemErrors/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«SystemError»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.20. User Agents

Collection of UA signatures

2.20.1. Create a new JSON API Resource

POST /api/rest/userAgents
Parameters
Type Name Description Schema

Body

document
required

document

JsonApiModelResourceDocument«UserAgent,string»
Responses
HTTP Code Description Schema

201

Created

JsonApiModelResourceDocument«UserAgent,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.20.2. Search by pks

GET /api/rest/userAgents
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

pks
required

string

Query

pks[]
required

pks[]

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

ModelResources«UserAgent»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.20.3. Get CORS headers

OPTIONS /api/rest/userAgents
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.20.4. Get JSON Schema

GET /api/rest/userAgents/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.20.5. Get UI schema

GET /api/rest/userAgents/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.20.6. Find by pk

GET /api/rest/userAgents/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«UserAgent,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.20.7. Update a resource

PUT /api/rest/userAgents/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

UserAgent
Responses
HTTP Code Description Schema

200

OK

Resource«UserAgent»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.20.8. Delete a resource

DELETE /api/rest/userAgents/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.20.9. Patch (partially plainJsonPut) a resource given as a JSON API Document

PATCH /api/rest/userAgents/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

document
required

document

JsonApiModelResourceDocument«UserAgent,string»
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«UserAgent,string»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.20.10. Find related by root pk

GET /api/rest/userAgents/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«UserAgent»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.20.11. Find related by root pk

GET /api/rest/userAgents/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«UserAgent»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.21. User Credentials

Operations about user credentials

2.21.1. Create a new JSON API Resource

POST /api/rest/userCredentials
Parameters
Type Name Description Schema

Body

document
required

document

JsonApiModelResourceDocument«UserCredentials,string»
Responses
HTTP Code Description Schema

201

Created

JsonApiModelResourceDocument«UserCredentials,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.21.2. Search by pks

GET /api/rest/userCredentials
Description

Find the set of resources matching the given identifiers.

Parameters
Type Name Description Schema

Query

pks
required

string

Query

pks[]
required

pks[]

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceCollectionDocument«UserCredentials,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.21.3. Get CORS headers

OPTIONS /api/rest/userCredentials
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.21.4. Get JSON Schema

GET /api/rest/userCredentials/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.21.5. Get UI schema

GET /api/rest/userCredentials/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.21.6. Find by pk

GET /api/rest/userCredentials/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

ModelResource«UserCredentials»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.21.7. Update a resource

PUT /api/rest/userCredentials/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

UserCredentials
Responses
HTTP Code Description Schema

200

OK

Resource«UserCredentials»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.21.8. Delete a resource

DELETE /api/rest/userCredentials/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.21.9. Patch (partially plainJsonPut) a resource given as a JSON API Document

PATCH /api/rest/userCredentials/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

document
required

document

JsonApiModelResourceDocument«UserCredentials,string»
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«UserCredentials,string»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.21.10. Find related by root pk

GET /api/rest/userCredentials/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«UserCredentials»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.21.11. Find related by root pk

GET /api/rest/userCredentials/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

_pn
optional

The page number

integer(int32)

"0"

Query

_ps
optional

The page size

integer(int32)

"10"

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

ResponseEntity«UserCredentials»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.22. UserRegistrationCode

User registration codes (read-only)

2.22.1. Create a new JSON API Resource

POST /api/rest/userRegistrationCodes
Parameters
Type Name Description Schema

Body

document
required

document

JsonApiModelResourceDocument«UserRegistrationCode,string»
Responses
HTTP Code Description Schema

201

Created

JsonApiModelResourceDocument«UserRegistrationCode,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.22.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/userRegistrationCodes
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"
Responses
HTTP Code Description Schema

200

OK

ModelResources«UserRegistrationCode»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.22.3. Get CORS headers

OPTIONS /api/rest/userRegistrationCodes
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.22.4. Get JSON Schema

GET /api/rest/userRegistrationCodes/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.22.5. Get UI schema

GET /api/rest/userRegistrationCodes/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.22.6. Find by pk

GET /api/rest/userRegistrationCodes/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«UserRegistrationCode,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.22.7. Update a resource

PUT /api/rest/userRegistrationCodes/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

UserRegistrationCode
Responses
HTTP Code Description Schema

200

OK

Resource«UserRegistrationCode»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.22.8. Delete a resource

DELETE /api/rest/userRegistrationCodes/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.22.9. Patch (partially plainJsonPut) a resource given as a JSON API Document

PATCH /api/rest/userRegistrationCodes/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

document
required

document

JsonApiModelResourceDocument«UserRegistrationCode,string»
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«UserRegistrationCode,string»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.22.10. Find related by root pk

GET /api/rest/userRegistrationCodes/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«UserRegistrationCode»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.22.11. Find related by root pk

GET /api/rest/userRegistrationCodes/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«UserRegistrationCode»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.23. Users

User management operations

2.23.1. Create a new resource

POST /api/rest/users
Parameters
Type Name Description Schema

Body

model
required

model

User
Responses
HTTP Code Description Schema

201

Created

Resource«User»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.23.2. Get the full collection of resources (no paging or criteria)

GET /api/rest/users
Description

Find all resources, and return the full collection (i.e. VS a page of the total results)

Parameters
Type Name Schema Default

Query

page
required

enum (no)

"no"
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceCollectionDocument«User,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.23.3. Get CORS headers

OPTIONS /api/rest/users
Description

Get the CORS headers for the given path

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/vnd.api+json

Produces

  • application/json

  • application/vnd.api+json

2.23.4. Get one by username or email

GET /api/rest/users/byUserNameOrEmail/{userNameOrEmail}
Description

Get the single user with the given username or email.

Parameters
Type Name Description Schema

Path

userNameOrEmail
required

userNameOrEmail

string
Responses
HTTP Code Description Schema

200

OK

Resource«User»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.23.5. Get JSON Schema

GET /api/rest/users/jsonschema
Description

Get the JSON Schema for the controller entity type

Responses
HTTP Code Description Schema

200

OK

RawJson

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.23.6. Get UI schema

GET /api/rest/users/uischema
Caution

operation.deprecated
Description

Get the UI achema for the controller entity type, including fields, use-cases etc.

Responses
HTTP Code Description Schema

200

OK

UiSchema

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.23.7. Update files

POST /api/rest/users/{id}/files
Description

The files are saved using the parameter names of the multipart files contained in this request. These are the field names of the form (like with normal parameters), not the original file names.

Parameters
Type Name Description Schema

Path

id
required

id

string

Body

request
optional

request

MultipartHttpServletRequest
Responses
HTTP Code Description Schema

200

OK

User

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • multipart/*

Produces

  • application/xml

  • application/json

2.23.8. Find by pk

GET /api/rest/users/{pk}
Description

Find a resource by it’s identifier

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

200

OK

JsonApiModelResourceDocument«User,string»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.23.9. Update a resource

PUT /api/rest/users/{pk}
Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

User
Responses
HTTP Code Description Schema

200

OK

Resource«User»

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.23.10. Delete a resource

DELETE /api/rest/users/{pk}
Description

Delete a resource by its identifier.

Parameters
Type Name Description Schema

Path

pk
required

string

string
Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.23.11. Patch (partially update) a resource

PATCH /api/rest/users/{pk}
Description

Partial updates will apply all given properties (ignoring null values) to the persisted entity.

Parameters
Type Name Description Schema

Path

pk
required

string

string

Body

model
required

model

User
Responses
HTTP Code Description Schema

200

OK

Resource«User»

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.23.12. Find related by root pk

GET /api/rest/users/{pk}/relationships/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«User»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.23.13. Find related by root pk

GET /api/rest/users/{pk}/{relationName}
Description

Find the related resource for the given relation name and identifier

Parameters
Type Name Description Schema Default

Path

pk
required

string

string

Path

relationName
required

string

string

Query

filter
optional

The RSQL/FIQL query to use. Simply URL param based search will be used if missing.

string

Query

page[number]
optional

The page number

integer(int32)

"0"

Query

page[size]
optional

The page size

integer(int32)

"10"

Query

sort
optional

Comma separated list of attribute names, descending for each one prefixed with a dash, ascending otherwise

string

"pk"
Responses
HTTP Code Description Schema

200

OK

JsonApiDocument«User»

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.api+json

Produces

  • application/vnd.api+json

2.23.14. Add metadatum

PUT /api/rest/users/{subjectId}/metadata
Description

Add or update a resource metadatum

Parameters
Type Name Description Schema

Path

subjectId
required

subjectId

string

Body

dto
required

dto

MetadatumDTO
Responses
HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

  • application/hal+json

Produces

  • application/json

  • application/hal+json

2.24. Audit-events-mvc-endpoint

Audit Events Mvc Endpoint

2.24.1. findByPrincipalAndAfterAndType

GET /api/management/auditevents
Parameters
Type Name Description Schema

Query

after
optional

after

string(date-time)

Query

principal
optional

principal

string

Query

type
optional

type

string
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.24.2. findByPrincipalAndAfterAndType

GET /api/management/auditevents.json
Parameters
Type Name Description Schema

Query

after
optional

after

string(date-time)

Query

principal
optional

principal

string

Query

type
optional

type

string
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.25. Endpoint-mvc-adapter

Endpoint Mvc Adapter

2.25.1. invoke

GET /api/management/autoconfig
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.25.2. invoke

GET /api/management/autoconfig.json
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.25.3. invoke

GET /api/management/beans
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.25.4. invoke

GET /api/management/beans.json
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.25.5. invoke

GET /api/management/configprops
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.25.6. invoke

GET /api/management/configprops.json
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.25.7. invoke

GET /api/management/dump
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.25.8. invoke

GET /api/management/dump.json
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.25.9. invoke

GET /api/management/info
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.25.10. invoke

GET /api/management/info.json
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.25.11. invoke

GET /api/management/mappings
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.25.12. invoke

GET /api/management/mappings.json
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.25.13. invoke

GET /api/management/trace
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.25.14. invoke

GET /api/management/trace.json
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.26. Environment-mvc-endpoint

Environment Mvc Endpoint

2.26.1. invoke

GET /api/management/env
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.26.2. invoke

GET /api/management/env.json
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.26.3. value

GET /api/management/env/{name}
Parameters
Type Name Description Schema

Path

name
required

name

string
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.27. Hal-json-mvc-endpoint

Hal Json Mvc Endpoint

2.27.1. links

GET /api/management
Responses
HTTP Code Description Schema

200

OK

ResourceSupport

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.27.2. links

GET /api/management.json
Responses
HTTP Code Description Schema

200

OK

ResourceSupport

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.28. Health-mvc-endpoint

Health Mvc Endpoint

2.28.1. invoke

GET /api/management/health
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.28.2. invoke

GET /api/management/health.json
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.29. Heapdump-mvc-endpoint

Heapdump Mvc Endpoint

2.29.1. invoke

GET /api/management/heapdump
Parameters
Type Name Description Schema Default

Query

live
optional

live

boolean

"true"
Responses
HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/octet-stream

2.29.2. invoke

GET /api/management/heapdump.json
Parameters
Type Name Description Schema Default

Query

live
optional

live

boolean

"true"
Responses
HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/octet-stream

2.30. Index-jsp-controller

Index Jsp Controller

2.30.1. home

GET /
Responses
HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • text/html

2.30.2. client

GET /client/**
Parameters
Type Name Description Schema

Body

model
optional

model

Model
Responses
HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • text/html

2.31. Jwt-controller

Jwt Controller

2.31.1. createAccessToken

POST /api/auth/jwt/access
Parameters
Type Name Description Schema

Body

loginRequest
required

loginRequest

SimpleLoginRequest
Responses
HTTP Code Description Schema

201

Created

UserDetails

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.31.2. createRefreshToken

POST /api/auth/jwt/refresh
Responses
HTTP Code Description Schema

201

Created

JwtToken

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

2.32. Loggers-mvc-endpoint

Loggers Mvc Endpoint

2.32.1. invoke

GET /api/management/loggers
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.32.2. invoke

GET /api/management/loggers.json
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.32.3. set

POST /api/management/loggers/{name}
Parameters
Type Name Description Schema

Path

name
required

name

string

Body

configuration
required

configuration

< string, string > map
Responses
HTTP Code Description Schema

200

OK

object

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.32.4. get

GET /api/management/loggers/{name}
Parameters
Type Name Description Schema

Path

name
required

name

string
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.33. Metrics-mvc-endpoint

Metrics Mvc Endpoint

2.33.1. invoke

GET /api/management/metrics
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.33.2. invoke

GET /api/management/metrics.json
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

2.33.3. value

GET /api/management/metrics/{name}
Parameters
Type Name Description Schema

Path

name
required

name

string
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

3. Definitions

3.1. BaseError

Generic error superclass

Name Description Schema

createdBy
optional

The initial content author

UserDTO

createdDate
optional

Date created

LocalDateTime

errorLog
optional

ErrorLog

lastModifiedDate
optional

Date last modified

LocalDateTime

message
optional

Message for users

string

pk
optional

string

remoteAddress
optional

The address the request originated from

string

userAgent
optional

The UA string if provided with a request

UserAgent

3.2. BaseErrorService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.3. CellphoneDetail

CellphoneDetail

Name Schema

contactDetails
optional

ContactDetails

description
optional

string

number
optional

string

pk
optional

string

primary
optional

boolean

value
optional

string

verificationToken
optional

string

verified
optional

boolean

3.4. Character

Type : object

3.5. Chronology

Name Schema

calendarType
optional

string

id
optional

string

3.6. ClientError

Client errors are created upon client request and refer to exceptions occurred specifically within client application code.

Name Description Schema

createdBy
optional

The initial content author

UserDTO

createdDate
optional

Date created

LocalDateTime

description
optional

The error description provided by the user, if any.

string

errorLog
optional

ErrorLog

lastModifiedDate
optional

Date last modified

LocalDateTime

message
optional

Message for users

string

pk
optional

string

remoteAddress
optional

The address the request originated from

string

screenshotUrl
optional

A client application screenshot demonstrating the issue.

string

state
optional

A textual representation of the client application state, e.g. the DOM tree.

string

userAgent
optional

The UA string if provided with a request

UserAgent

viewUrl
optional

The URL relevant to application view state during the error e.g. window.location.href, if any

string

3.7. ClientErrorService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.8. Collection«ErrorModel«BaseError»»

Type : object

3.9. Collection«ErrorModel«ClientError»»

Type : object

3.10. Collection«ErrorModel«ContactDetails»»

Type : object

3.11. Collection«ErrorModel«Continent»»

Type : object

3.12. Collection«ErrorModel«Country»»

Type : object

3.13. Collection«ErrorModel«ErrorLog»»

Type : object

3.14. Collection«ErrorModel«Friendship»»

Type : object

3.15. Collection«ErrorModel«Host»»

Type : object

3.16. Collection«ErrorModel«Locality»»

Type : object

3.17. Collection«ErrorModel«PersonalDetails»»

Type : object

3.18. Collection«ErrorModel«PostalCode»»

Type : object

3.19. Collection«ErrorModel«Role»»

Type : object

3.20. Collection«ErrorModel«STOMP Session»»

Type : object

3.21. Collection«ErrorModel«SystemError»»

Type : object

3.22. Collection«ErrorModel«UserAgent»»

Type : object

3.23. Collection«ErrorModel«UserCredentials»»

Type : object

3.24. Collection«ErrorModel«UserRegistrationCodeBatch»»

Type : object

3.25. Collection«ErrorModel«UserRegistrationCode»»

Type : object

3.26. Collection«ErrorModel«User»»

Type : object

3.27. Collection«GrantedAuthority»

Type : object

3.28. Collection«JsonApiResource«BaseError,string»»

Type : object

3.29. Collection«JsonApiResource«ClientError,string»»

Type : object

3.30. Collection«JsonApiResource«ContactDetails,string»»

Type : object

3.31. Collection«JsonApiResource«Continent,string»»

Type : object

3.32. Collection«JsonApiResource«Country,string»»

Type : object

3.33. Collection«JsonApiResource«ErrorLog,string»»

Type : object

3.34. Collection«JsonApiResource«Friendship,FriendshipIdentifier»»

Type : object

3.35. Collection«JsonApiResource«Host,string»»

Type : object

3.36. Collection«JsonApiResource«Locality,string»»

Type : object

3.37. Collection«JsonApiResource«PersonalDetails,string»»

Type : object

3.38. Collection«JsonApiResource«PostalCode,string»»

Type : object

3.39. Collection«JsonApiResource«Role,string»»

Type : object

3.40. Collection«JsonApiResource«STOMP Session,string»»

Type : object

3.41. Collection«JsonApiResource«SystemError,string»»

Type : object

3.42. Collection«JsonApiResource«User,string»»

Type : object

3.43. Collection«JsonApiResource«UserAgent,string»»

Type : object

3.44. Collection«JsonApiResource«UserCredentials,string»»

Type : object

3.45. Collection«JsonApiResource«UserRegistrationCode,string»»

Type : object

3.46. Collection«JsonApiResource«UserRegistrationCodeBatch,string»»

Type : object

3.47. Collection«ModelResource«BaseError»»

Type : object

3.48. Collection«ModelResource«ClientError»»

Type : object

3.49. Collection«ModelResource«ContactDetails»»

Type : object

3.50. Collection«ModelResource«Continent»»

Type : object

3.51. Collection«ModelResource«Country»»

Type : object

3.52. Collection«ModelResource«ErrorLog»»

Type : object

3.53. Collection«ModelResource«Friendship»»

Type : object

3.54. Collection«ModelResource«Host»»

Type : object

3.55. Collection«ModelResource«Locality»»

Type : object

3.56. Collection«ModelResource«PersonalDetails»»

Type : object

3.57. Collection«ModelResource«PostalCode»»

Type : object

3.58. Collection«ModelResource«Role»»

Type : object

3.59. Collection«ModelResource«STOMP Session»»

Type : object

3.60. Collection«ModelResource«SystemError»»

Type : object

3.61. Collection«ModelResource«UserAgent»»

Type : object

3.62. Collection«ModelResource«UserCredentials»»

Type : object

3.63. Collection«ModelResource«UserRegistrationCodeBatch»»

Type : object

3.64. Collection«ModelResource«UserRegistrationCode»»

Type : object

3.65. Collection«ModelResource«User»»

Type : object

3.66. ConstraintViolationEntry

DTO class for serialization of bean validation violations.

Name Schema

message
optional

string

propertyPath
optional

string

3.67. ContactDetails

ContactDetails

Name Schema

new
optional

boolean

pk
optional

string

primaryAddress
optional

PostalAddressDetail

primaryCellphone
optional

CellphoneDetail

primaryEmail
optional

EmailDetail

user
optional

User

3.68. ContactDetailsService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.69. Continent

Name Schema

name
optional

string

new
optional

boolean

parent
optional

Continent

path
optional

string

pathLevel
optional

integer(int32)

pk
optional

string

3.70. ContinentService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.71. ConversionService

Type : object

3.72. Country

A model representing a country, meaning a region that is identified as a distinct entity in political geography.

Name Schema

callingCode
optional

string

capital
optional

string

currency
optional

string

languages
optional

string

name
optional

string

nativeName
optional

string

new
optional

boolean

parent
optional

Continent

path
optional

string

pathLevel
optional

integer(int32)

pk
optional

string

3.73. CountryService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.74. EmailConfirmationOrPasswordResetRequest

Submitting a password reset request triggers a reset token and email if resetPasswordToken is null, updates the password if resetPasswordToken is not null and valid,

Name Schema

currentPassword
optional

string

email
optional

string

password
optional

string

passwordConfirmation
optional

string

resetPasswordToken
optional

string

username
optional

string

3.75. EmailDetail

EmailDetail

Name Schema

contactDetails
optional

ContactDetails

description
optional

string

email
optional

string

pk
optional

string

primary
optional

boolean

value
optional

string

verificationToken
optional

string

verified
optional

boolean

3.76. Era

Name Schema

value
optional

integer(int32)

3.77. ErrorLog

Used to persist error stacktraces using the corresponding hash as the ID. The generated hash ignores line numbers (in case of SystemError) and is thus tolerant of small code changes, like adding a comment line.

Name Description Schema

errorCount
optional

The number of errors corresponding to this stacktrace.

integer(int32)

firstOccurred
required

First occurrence date

LocalDateTime

lastOccurred
required

Last occurrence date

LocalDateTime

name
optional

string

pk
optional

string

rootCauseMessage
optional

The root cause message.

string

stacktrace
required

The actual stacktrace.

string

3.78. ErrorLogService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.79. ErrorModel«BaseError»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.80. ErrorModel«ClientError»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.81. ErrorModel«ContactDetails»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.82. ErrorModel«Continent»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.83. ErrorModel«Country»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.84. ErrorModel«ErrorLog»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.85. ErrorModel«Friendship»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

FriendshipIdentifier

3.86. ErrorModel«Host»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.87. ErrorModel«Locality»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.88. ErrorModel«PersonalDetails»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.89. ErrorModel«PostalCode»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.90. ErrorModel«Role»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.91. ErrorModel«STOMP Session»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.92. ErrorModel«SystemError»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.93. ErrorModel«UserAgent»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.94. ErrorModel«UserCredentials»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.95. ErrorModel«UserRegistrationCodeBatch»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.96. ErrorModel«UserRegistrationCode»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.97. ErrorModel«User»

Name Schema

message
optional

string

new
optional

boolean

pk
optional

string

3.98. FilePersistenceService

Type : object

3.99. Friendship

A model representing a directional connection between two users.

Name Schema

pk
required

FriendshipIdentifier

status
required

enum (NEW, CONFIRMED, BLOCK, DELETE)

3.100. FriendshipIdentifier

An {@link javax.persistence;Embeddable} JPA composite key. The custom implementation provides support to all relevant de)serialization components (JSON, request mappings, pathFragment/param variables etc.) for both [ownerId_friendId] and [friendId] string representations.

Name Schema

left
required

User

right
required

User

3.101. FriendshipService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.102. GrantedAuthority

Name Schema

authority
optional

string

3.103. Host

Name Schema

aliases
optional

< string > array

country
optional

Country

description
optional

string

name
optional

string

pk
optional

string

3.104. HostService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.105. IsoChronology

Name Schema

calendarType
optional

string

id
optional

string

3.106. JsonApiDocument«BaseError»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«BaseError»»

included
optional

Collection«JsonApiResource«BaseError,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.107. JsonApiDocument«ClientError»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«ClientError»»

included
optional

Collection«JsonApiResource«ClientError,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.108. JsonApiDocument«ContactDetails»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«ContactDetails»»

included
optional

Collection«JsonApiResource«ContactDetails,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.109. JsonApiDocument«Continent»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«Continent»»

included
optional

Collection«JsonApiResource«Continent,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.110. JsonApiDocument«Country»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«Country»»

included
optional

Collection«JsonApiResource«Country,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.111. JsonApiDocument«ErrorLog»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«ErrorLog»»

included
optional

Collection«JsonApiResource«ErrorLog,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.112. JsonApiDocument«Friendship»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«Friendship»»

included
optional

Collection«JsonApiResource«Friendship,FriendshipIdentifier»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.113. JsonApiDocument«Host»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«Host»»

included
optional

Collection«JsonApiResource«Host,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.114. JsonApiDocument«Locality»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«Locality»»

included
optional

Collection«JsonApiResource«Locality,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.115. JsonApiDocument«PersonalDetails»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«PersonalDetails»»

included
optional

Collection«JsonApiResource«PersonalDetails,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.116. JsonApiDocument«PostalCode»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«PostalCode»»

included
optional

Collection«JsonApiResource«PostalCode,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.117. JsonApiDocument«Role»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«Role»»

included
optional

Collection«JsonApiResource«Role,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.118. JsonApiDocument«STOMP Session»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«STOMP Session»»

included
optional

Collection«JsonApiResource«STOMP Session,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.119. JsonApiDocument«SystemError»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«SystemError»»

included
optional

Collection«JsonApiResource«SystemError,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.120. JsonApiDocument«UserAgent»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«UserAgent»»

included
optional

Collection«JsonApiResource«UserAgent,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.121. JsonApiDocument«UserCredentials»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«UserCredentials»»

included
optional

Collection«JsonApiResource«UserCredentials,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.122. JsonApiDocument«UserRegistrationCodeBatch»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«UserRegistrationCodeBatch»»

included
optional

Collection«JsonApiResource«UserRegistrationCodeBatch,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.123. JsonApiDocument«UserRegistrationCode»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«UserRegistrationCode»»

included
optional

Collection«JsonApiResource«UserRegistrationCode,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.124. JsonApiDocument«User»

Name Schema

data
optional

object

errors
optional

Collection«ErrorModel«User»»

included
optional

Collection«JsonApiResource«User,string»»

links
optional

< string, JsonApiLink > map

meta
optional

< string, Serializable > map

3.125. JsonApiLink

Name Schema

href
optional

string

meta
optional

< string, Serializable > map

rel
optional

string

3.126. JsonApiModelResourceCollectionDocument«BaseError,string»

Type : object

3.127. JsonApiModelResourceCollectionDocument«ClientError,string»

Type : object

3.128. JsonApiModelResourceCollectionDocument«ContactDetails,string»

Type : object

3.129. JsonApiModelResourceCollectionDocument«Continent,string»

Type : object

3.130. JsonApiModelResourceCollectionDocument«Country,string»

Type : object

3.131. JsonApiModelResourceCollectionDocument«ErrorLog,string»

Type : object

3.132. JsonApiModelResourceCollectionDocument«Friendship,FriendshipIdentifier»

Type : object

3.133. JsonApiModelResourceCollectionDocument«Host,string»

Type : object

3.134. JsonApiModelResourceCollectionDocument«Locality,string»

Type : object

3.135. JsonApiModelResourceCollectionDocument«PersonalDetails,string»

Type : object

3.136. JsonApiModelResourceCollectionDocument«PostalCode,string»

Type : object

3.137. JsonApiModelResourceCollectionDocument«Role,string»

Type : object

3.138. JsonApiModelResourceCollectionDocument«STOMP Session,string»

Type : object

3.139. JsonApiModelResourceCollectionDocument«SystemError,string»

Type : object

3.140. JsonApiModelResourceCollectionDocument«User,string»

Type : object

3.141. JsonApiModelResourceCollectionDocument«UserAgent,string»

Type : object

3.142. JsonApiModelResourceCollectionDocument«UserCredentials,string»

Type : object

3.143. JsonApiModelResourceCollectionDocument«UserRegistrationCode,string»

Type : object

3.144. JsonApiModelResourceCollectionDocument«UserRegistrationCodeBatch,string»

Type : object

3.145. JsonApiModelResourceDocument«BaseError,string»

Type : object

3.146. JsonApiModelResourceDocument«ClientError,string»

Type : object

3.147. JsonApiModelResourceDocument«ContactDetails,string»

Type : object

3.148. JsonApiModelResourceDocument«Continent,string»

Type : object

3.149. JsonApiModelResourceDocument«Country,string»

Type : object

3.150. JsonApiModelResourceDocument«ErrorLog,string»

Type : object

3.151. JsonApiModelResourceDocument«Friendship,FriendshipIdentifier»

Type : object

3.152. JsonApiModelResourceDocument«Host,string»

Type : object

3.153. JsonApiModelResourceDocument«Locality,string»

Type : object

3.154. JsonApiModelResourceDocument«PersonalDetails,string»

Type : object

3.155. JsonApiModelResourceDocument«PostalCode,string»

Type : object

3.156. JsonApiModelResourceDocument«Role,string»

Type : object

3.157. JsonApiModelResourceDocument«STOMP Session,string»

Type : object

3.158. JsonApiModelResourceDocument«SystemError,string»

Type : object

3.159. JsonApiModelResourceDocument«User,string»

Type : object

3.160. JsonApiModelResourceDocument«UserAgent,string»

Type : object

3.161. JsonApiModelResourceDocument«UserCredentials,string»

Type : object

3.162. JsonApiModelResourceDocument«UserRegistrationCode,string»

Type : object

3.163. JsonApiModelResourceDocument«UserRegistrationCodeBatch,string»

Type : object

3.164. JsonApiResource«BaseError,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.165. JsonApiResource«ClientError,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.166. JsonApiResource«ContactDetails,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.167. JsonApiResource«Continent,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.168. JsonApiResource«Country,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.169. JsonApiResource«ErrorLog,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.170. JsonApiResource«Friendship,FriendshipIdentifier»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.171. JsonApiResource«Host,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.172. JsonApiResource«Locality,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.173. JsonApiResource«PersonalDetails,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.174. JsonApiResource«PostalCode,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.175. JsonApiResource«Role,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.176. JsonApiResource«STOMP Session,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.177. JsonApiResource«SystemError,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.178. JsonApiResource«User,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.179. JsonApiResource«UserAgent,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.180. JsonApiResource«UserCredentials,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.181. JsonApiResource«UserRegistrationCode,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.182. JsonApiResource«UserRegistrationCodeBatch,string»

Name Schema

attributes
optional

Serializable

links
optional

< string, JsonApiLink > map

3.183. JwtToken

Name Schema

token
optional

string

3.184. Link

Name Schema

href
optional

string

rel
optional

string

templated
optional

boolean

3.185. LocalDate

Name Schema

chronology
optional

IsoChronology

dayOfMonth
optional

integer(int32)

dayOfWeek
optional

enum (MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY)

dayOfYear
optional

integer(int32)

era
optional

Era

leapYear
optional

boolean

month
optional

enum (JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER)

monthValue
optional

integer(int32)

year
optional

integer(int32)

3.186. LocalDateTime

Name Schema

chronology
optional

Chronology

dayOfMonth
optional

integer(int32)

dayOfWeek
optional

enum (MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY)

dayOfYear
optional

integer(int32)

hour
optional

integer(int32)

minute
optional

integer(int32)

month
optional

enum (JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER)

monthValue
optional

integer(int32)

nano
optional

integer(int32)

second
optional

integer(int32)

year
optional

integer(int32)

3.187. Locale

Name Schema

country
optional

string

displayCountry
optional

string

displayLanguage
optional

string

displayName
optional

string

displayScript
optional

string

displayVariant
optional

string

extensionKeys
optional

< Character > array

iso3Country
optional

string

iso3Language
optional

string

language
optional

string

script
optional

string

unicodeLocaleAttributes
optional

< string > array

unicodeLocaleKeys
optional

< string > array

variant
optional

string

3.188. Locality

A model representing an incorporated city or town political entity

Name Schema

name
optional

string

new
optional

boolean

parent
optional

Country

path
optional

string

pathLevel
optional

integer(int32)

pk
optional

string

3.189. LocalityService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.190. Login Submission

A DTO representing a login request

Name Schema

email
optional

string

password
optional

string

resetPasswordToken
optional

string

username
optional

string

3.191. MetadatumDTO

Name Schema

object
optional

string

predicate
optional

string

3.192. ModelResources«BaseError»

Name Schema

content
optional

Collection«ModelResource«BaseError»»

links
optional

< Link > array

3.193. ModelResources«ClientError»

Name Schema

content
optional

Collection«ModelResource«ClientError»»

links
optional

< Link > array

3.194. ModelResources«ContactDetails»

Name Schema

content
optional

Collection«ModelResource«ContactDetails»»

links
optional

< Link > array

3.195. ModelResources«Continent»

Name Schema

content
optional

Collection«ModelResource«Continent»»

links
optional

< Link > array

3.196. ModelResources«Country»

Name Schema

content
optional

Collection«ModelResource«Country»»

links
optional

< Link > array

3.197. ModelResources«ErrorLog»

Name Schema

content
optional

Collection«ModelResource«ErrorLog»»

links
optional

< Link > array

3.198. ModelResources«Friendship»

Name Schema

content
optional

Collection«ModelResource«Friendship»»

links
optional

< Link > array

3.199. ModelResources«Host»

Name Schema

content
optional

Collection«ModelResource«Host»»

links
optional

< Link > array

3.200. ModelResources«Locality»

Name Schema

content
optional

Collection«ModelResource«Locality»»

links
optional

< Link > array

3.201. ModelResources«PersonalDetails»

Name Schema

content
optional

Collection«ModelResource«PersonalDetails»»

links
optional

< Link > array

3.202. ModelResources«PostalCode»

Name Schema

content
optional

Collection«ModelResource«PostalCode»»

links
optional

< Link > array

3.203. ModelResources«Role»

Name Schema

content
optional

Collection«ModelResource«Role»»

links
optional

< Link > array

3.204. ModelResources«STOMP Session»

Name Schema

content
optional

Collection«ModelResource«STOMP Session»»

links
optional

< Link > array

3.205. ModelResources«SystemError»

Name Schema

content
optional

Collection«ModelResource«SystemError»»

links
optional

< Link > array

3.206. ModelResources«UserAgent»

Name Schema

content
optional

Collection«ModelResource«UserAgent»»

links
optional

< Link > array

3.207. ModelResources«UserCredentials»

Name Schema

content
optional

Collection«ModelResource«UserCredentials»»

links
optional

< Link > array

3.208. ModelResources«UserRegistrationCodeBatch»

Name Schema

content
optional

Collection«ModelResource«UserRegistrationCodeBatch»»

links
optional

< Link > array

3.209. ModelResources«UserRegistrationCode»

Name Schema

content
optional

Collection«ModelResource«UserRegistrationCode»»

links
optional

< Link > array

3.210. ModelResources«User»

Name Schema

content
optional

Collection«ModelResource«User»»

links
optional

< Link > array

3.211. ModelResource«BaseError»

Name Description Schema

createdBy
optional

The initial content author

UserDTO

createdDate
optional

Date created

LocalDateTime

lastModifiedDate
optional

Date last modified

LocalDateTime

links
optional

< Link > array

message
optional

Message for users

string

remoteAddress
optional

The address the request originated from

string

userAgent
optional

The UA string if provided with a request

UserAgent

3.212. ModelResource«ClientError»

Name Description Schema

createdBy
optional

The initial content author

UserDTO

createdDate
optional

Date created

LocalDateTime

description
optional

The error description provided by the user, if any.

string

lastModifiedDate
optional

Date last modified

LocalDateTime

links
optional

< Link > array

message
optional

Message for users

string

remoteAddress
optional

The address the request originated from

string

screenshotUrl
optional

A client application screenshot demonstrating the issue.

string

state
optional

A textual representation of the client application state, e.g. the DOM tree.

string

userAgent
optional

The UA string if provided with a request

UserAgent

viewUrl
optional

The URL relevant to application view state during the error e.g. window.location.href, if any

string

3.213. ModelResource«ContactDetails»

Name Schema

links
optional

< Link > array

new
optional

boolean

pk
optional

string

primaryAddress
optional

PostalAddressDetail

primaryCellphone
optional

CellphoneDetail

primaryEmail
optional

EmailDetail

user
optional

User

3.214. ModelResource«Continent»

Name Schema

links
optional

< Link > array

name
optional

string

new
optional

boolean

parent
optional

Continent

path
optional

string

pathLevel
optional

integer(int32)

pk
optional

string

3.215. ModelResource«Country»

Name Schema

callingCode
optional

string

capital
optional

string

currency
optional

string

languages
optional

string

links
optional

< Link > array

name
optional

string

nativeName
optional

string

new
optional

boolean

parent
optional

Continent

path
optional

string

pathLevel
optional

integer(int32)

pk
optional

string

3.216. ModelResource«ErrorLog»

Name Description Schema

errorCount
optional

The number of errors corresponding to this stacktrace.

integer(int32)

firstOccurred
required

First occurrence date

LocalDateTime

lastOccurred
required

Last occurrence date

LocalDateTime

links
optional

< Link > array

name
optional

string

new
optional

boolean

pk
optional

string

rootCauseMessage
optional

The root cause message.

string

stacktrace
required

The actual stacktrace.

string

3.217. ModelResource«Friendship»

Name Schema

links
optional

< Link > array

pk
required

FriendshipIdentifier

status
required

enum (NEW, CONFIRMED, BLOCK, DELETE)

3.218. ModelResource«Host»

Name Schema

aliases
optional

< string > array

country
optional

Country

description
optional

string

links
optional

< Link > array

name
optional

string

pk
optional

string

3.219. ModelResource«Locality»

Name Schema

links
optional

< Link > array

name
optional

string

new
optional

boolean

parent
optional

Country

path
optional

string

pathLevel
optional

integer(int32)

pk
optional

string

3.220. ModelResource«PersonalDetails»

Name Schema

birthDay
optional

LocalDate

links
optional

< Link > array

new
optional

boolean

pk
optional

string

user
optional

User

3.221. ModelResource«PostalCode»

Name Schema

links
optional

< Link > array

name
optional

string

new
optional

boolean

parent
optional

Locality

path
optional

string

pathLevel
optional

integer(int32)

pk
optional

string

3.222. ModelResource«Role»

Name Schema

authority
optional

string

description
optional

string

links
optional

< Link > array

name
optional

string

pk
optional

string

3.223. ModelResource«STOMP Session»

Name Schema

links
optional

< Link > array

new
optional

boolean

pk
optional

string

user
optional

User

3.224. ModelResource«SystemError»

Name Description Schema

createdBy
optional

The initial content author

UserDTO

createdDate
optional

Date created

LocalDateTime

errorLogId
optional

The corresponding log/stacktrace ID, if any

string

httpStatusCode
optional

The HTTP response status code

integer(int32)

httpStatusMessage
optional

The phrase corresponding to the HTTP status

string

lastModifiedDate
optional

Date last modified

LocalDateTime

links
optional

< Link > array

message
optional

Message for users

string

remoteAddress
optional

The address the request originated from

string

requestMethod
optional

The HTTP request method

string

requestUrl
optional

The HTTP request URL, relative to system base URL

string

userAgent
optional

The UA string if provided with a request

UserAgent

validationErrors
optional

Failed constraint validation errors, if any

< ConstraintViolationEntry > array

3.225. ModelResource«UserAgent»

Name Description Schema

links
optional

< Link > array

new
optional

boolean

pk
optional

string

value
optional

UA signature string pathFragment

string

3.226. ModelResource«UserCredentials»

Name Schema

active
optional

boolean

inactivationDate
optional

LocalDateTime

inactivationReason
optional

string

lastLogin
optional

LocalDateTime

lastPassWordChangeDate
optional

LocalDateTime

links
optional

< Link > array

loginAttempts
optional

integer(int32)

new
optional

boolean

pk
optional

string

resetPasswordToken
optional

string

resetPasswordTokenCreated
optional

LocalDateTime

3.227. ModelResource«UserRegistrationCodeBatch»

Name Description Schema

available
optional
read-only

The number of available codes in the batch

integer(int32)

batchSize
required

The number of codes to generate (1 to 20), non-updatable.
Example : 10

integer(int32)

createdDate
optional

Date created

LocalDateTime

description
required

The batch description.
Example : "A batch for CompanyName"

string

expirationDate
optional

Expiration date.

LocalDate

lastModifiedDate
optional

Date last modified

LocalDateTime

links
optional

< Link > array

name
required

Unique short code, non-updatable.
Example : "CompanyName01"

string

pk
optional

string

3.228. ModelResource«UserRegistrationCode»

Name Schema

available
optional

boolean

batch
optional

UserRegistrationCodeBatch

links
optional

< Link > array

pk
optional

string

3.229. ModelResource«User»

Name Schema

active
optional

boolean

avatarUrl
optional

string

bannerUrl
optional

string

description
optional

string

emailHash
optional

string

firstName
optional

string

fullName
optional

string

lastName
optional

string

lastVisit
optional

LocalDateTime

links
optional

< Link > array

locale
optional

string

metadata
optional

< string, UserMetadatum > map

name
optional

string

pk
optional

string

roles
optional

< GrantedAuthority > array

stringCount
optional

integer(int32)

strings
optional

< string > array

username
optional

string

3.230. PageMetadata

Name Schema

number
optional

integer(int64)

size
optional

integer(int64)

totalElements
optional

integer(int64)

totalPages
optional

integer(int64)

3.231. PagedModelResources«BaseError»

Name Schema

content
optional

Collection«ModelResource«BaseError»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.232. PagedModelResources«ClientError»

Name Schema

content
optional

Collection«ModelResource«ClientError»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.233. PagedModelResources«ContactDetails»

Name Schema

content
optional

Collection«ModelResource«ContactDetails»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.234. PagedModelResources«Continent»

Name Schema

content
optional

Collection«ModelResource«Continent»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.235. PagedModelResources«Country»

Name Schema

content
optional

Collection«ModelResource«Country»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.236. PagedModelResources«ErrorLog»

Name Schema

content
optional

Collection«ModelResource«ErrorLog»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.237. PagedModelResources«Friendship»

Name Schema

content
optional

Collection«ModelResource«Friendship»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.238. PagedModelResources«Host»

Name Schema

content
optional

Collection«ModelResource«Host»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.239. PagedModelResources«Locality»

Name Schema

content
optional

Collection«ModelResource«Locality»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.240. PagedModelResources«PersonalDetails»

Name Schema

content
optional

Collection«ModelResource«PersonalDetails»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.241. PagedModelResources«PostalCode»

Name Schema

content
optional

Collection«ModelResource«PostalCode»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.242. PagedModelResources«Role»

Name Schema

content
optional

Collection«ModelResource«Role»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.243. PagedModelResources«STOMP Session»

Name Schema

content
optional

Collection«ModelResource«STOMP Session»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.244. PagedModelResources«SystemError»

Name Schema

content
optional

Collection«ModelResource«SystemError»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.245. PagedModelResources«UserAgent»

Name Schema

content
optional

Collection«ModelResource«UserAgent»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.246. PagedModelResources«UserCredentials»

Name Schema

content
optional

Collection«ModelResource«UserCredentials»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.247. PagedModelResources«UserRegistrationCodeBatch»

Name Schema

content
optional

Collection«ModelResource«UserRegistrationCodeBatch»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.248. PagedModelResources«UserRegistrationCode»

Name Schema

content
optional

Collection«ModelResource«UserRegistrationCode»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.249. PagedModelResources«User»

Name Schema

content
optional

Collection«ModelResource«User»»

links
optional

< Link > array

page
optional

PageMetadata

urlParameters
optional

< string, Array > map

3.250. Page«UserDTO»

Name Schema

content
optional

< UserDTO > array

first
optional

boolean

last
optional

boolean

number
optional

integer(int32)

numberOfElements
optional

integer(int32)

size
optional

integer(int32)

sort
optional

Sort

totalElements
optional

integer(int64)

totalPages
optional

integer(int32)

3.251. PersonalDetails

PersonalDetails

Name Schema

birthDay
optional

LocalDate

new
optional

boolean

pk
optional

string

user
optional

User

3.252. PersonalDetailsService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.253. PostalAddressDetail

PostalAddressDetail

Name Schema

addressLine1
optional

string

addressLine2
optional

string

contactDetails
optional

ContactDetails

description
optional

string

pk
optional

string

postCode
optional

PostalCode

postOfficeBoxNumber
optional

string

primary
optional

boolean

value
optional

string

verificationToken
optional

string

verified
optional

boolean

3.254. PostalCode

A model representing apostal code

Name Schema

name
optional

string

new
optional

boolean

parent
optional

Locality

path
optional

string

pathLevel
optional

integer(int32)

pk
optional

string

3.255. PostalCodeService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.256. RawJson

Type : object

3.257. ResourceSupport

Name Schema

links
optional

< Link > array

3.258. Resource«BaseError»

Name Description Schema

createdBy
optional

The initial content author

UserDTO

createdDate
optional

Date created

LocalDateTime

lastModifiedDate
optional

Date last modified

LocalDateTime

links
optional

< Link > array

message
optional

Message for users

string

remoteAddress
optional

The address the request originated from

string

userAgent
optional

The UA string if provided with a request

UserAgent

3.259. Resource«ClientError»

Name Description Schema

createdBy
optional

The initial content author

UserDTO

createdDate
optional

Date created

LocalDateTime

description
optional

The error description provided by the user, if any.

string

lastModifiedDate
optional

Date last modified

LocalDateTime

links
optional

< Link > array

message
optional

Message for users

string

remoteAddress
optional

The address the request originated from

string

screenshotUrl
optional

A client application screenshot demonstrating the issue.

string

state
optional

A textual representation of the client application state, e.g. the DOM tree.

string

userAgent
optional

The UA string if provided with a request

UserAgent

viewUrl
optional

The URL relevant to application view state during the error e.g. window.location.href, if any

string

3.260. Resource«ContactDetails»

Name Schema

links
optional

< Link > array

new
optional

boolean

pk
optional

string

primaryAddress
optional

PostalAddressDetail

primaryCellphone
optional

CellphoneDetail

primaryEmail
optional

EmailDetail

user
optional

User

3.261. Resource«Continent»

Name Schema

links
optional

< Link > array

name
optional

string

new
optional

boolean

parent
optional

Continent

path
optional

string

pathLevel
optional

integer(int32)

pk
optional

string

3.262. Resource«Country»

Name Schema

callingCode
optional

string

capital
optional

string

currency
optional

string

languages
optional

string

links
optional

< Link > array

name
optional

string

nativeName
optional

string

new
optional

boolean

parent
optional

Continent

path
optional

string

pathLevel
optional

integer(int32)

pk
optional

string

3.263. Resource«ErrorLog»

Name Description Schema

errorCount
optional

The number of errors corresponding to this stacktrace.

integer(int32)

firstOccurred
required

First occurrence date

LocalDateTime

lastOccurred
required

Last occurrence date

LocalDateTime

links
optional

< Link > array

name
optional

string

new
optional

boolean

pk
optional

string

rootCauseMessage
optional

The root cause message.

string

stacktrace
required

The actual stacktrace.

string

3.264. Resource«Friendship»

Name Schema

links
optional

< Link > array

pk
required

FriendshipIdentifier

status
required

enum (NEW, CONFIRMED, BLOCK, DELETE)

3.265. Resource«Host»

Name Schema

aliases
optional

< string > array

country
optional

Country

description
optional

string

links
optional

< Link > array

name
optional

string

pk
optional

string

3.266. Resource«Locality»

Name Schema

links
optional

< Link > array

name
optional

string

new
optional

boolean

parent
optional

Country

path
optional

string

pathLevel
optional

integer(int32)

pk
optional

string

3.267. Resource«PersonalDetails»

Name Schema

birthDay
optional

LocalDate

links
optional

< Link > array

new
optional

boolean

pk
optional

string

user
optional

User

3.268. Resource«PostalCode»

Name Schema

links
optional

< Link > array

name
optional

string

new
optional

boolean

parent
optional

Locality

path
optional

string

pathLevel
optional

integer(int32)

pk
optional

string

3.269. Resource«Role»

Name Schema

authority
optional

string

description
optional

string

links
optional

< Link > array

name
optional

string

pk
optional

string

3.270. Resource«STOMP Session»

Name Schema

links
optional

< Link > array

new
optional

boolean

pk
optional

string

user
optional

User

3.271. Resource«SystemError»

Name Description Schema

createdBy
optional

The initial content author

UserDTO

createdDate
optional

Date created

LocalDateTime

errorLogId
optional

The corresponding log/stacktrace ID, if any

string

httpStatusCode
optional

The HTTP response status code

integer(int32)

httpStatusMessage
optional

The phrase corresponding to the HTTP status

string

lastModifiedDate
optional

Date last modified

LocalDateTime

links
optional

< Link > array

message
optional

Message for users

string

remoteAddress
optional

The address the request originated from

string

requestMethod
optional

The HTTP request method

string

requestUrl
optional

The HTTP request URL, relative to system base URL

string

userAgent
optional

The UA string if provided with a request

UserAgent

validationErrors
optional

Failed constraint validation errors, if any

< ConstraintViolationEntry > array

3.272. Resource«UserAgent»

Name Description Schema

links
optional

< Link > array

new
optional

boolean

pk
optional

string

value
optional

UA signature string pathFragment

string

3.273. Resource«UserCredentials»

Name Schema

active
optional

boolean

inactivationDate
optional

LocalDateTime

inactivationReason
optional

string

lastLogin
optional

LocalDateTime

lastPassWordChangeDate
optional

LocalDateTime

links
optional

< Link > array

loginAttempts
optional

integer(int32)

new
optional

boolean

pk
optional

string

resetPasswordToken
optional

string

resetPasswordTokenCreated
optional

LocalDateTime

3.274. Resource«UserRegistrationCodeBatch»

Name Description Schema

available
optional
read-only

The number of available codes in the batch

integer(int32)

batchSize
required

The number of codes to generate (1 to 20), non-updatable.
Example : 10

integer(int32)

createdDate
optional

Date created

LocalDateTime

description
required

The batch description.
Example : "A batch for CompanyName"

string

expirationDate
optional

Expiration date.

LocalDate

lastModifiedDate
optional

Date last modified

LocalDateTime

links
optional

< Link > array

name
required

Unique short code, non-updatable.
Example : "CompanyName01"

string

pk
optional

string

3.275. Resource«UserRegistrationCode»

Name Schema

available
optional

boolean

batch
optional

UserRegistrationCodeBatch

links
optional

< Link > array

pk
optional

string

3.276. Resource«User»

Name Schema

active
optional

boolean

avatarUrl
optional

string

bannerUrl
optional

string

description
optional

string

emailHash
optional

string

firstName
optional

string

fullName
optional

string

lastName
optional

string

lastVisit
optional

LocalDateTime

links
optional

< Link > array

locale
optional

string

metadata
optional

< string, UserMetadatum > map

name
optional

string

pk
optional

string

roles
optional

< GrantedAuthority > array

stringCount
optional

integer(int32)

strings
optional

< string > array

username
optional

string

3.277. ResponseEntity«BaseError»

Name Schema

body
optional

BaseError

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.278. ResponseEntity«ClientError»

Name Schema

body
optional

ClientError

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.279. ResponseEntity«ContactDetails»

Name Schema

body
optional

ContactDetails

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.280. ResponseEntity«Continent»

Name Schema

body
optional

Continent

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.281. ResponseEntity«Country»

Name Schema

body
optional

Country

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.282. ResponseEntity«ErrorLog»

Name Schema

body
optional

ErrorLog

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.283. ResponseEntity«Friendship»

Name Schema

body
optional

Friendship

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.284. ResponseEntity«Host»

Name Schema

body
optional

Host

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.285. ResponseEntity«Locality»

Name Schema

body
optional

Locality

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.286. ResponseEntity«PersonalDetails»

Name Schema

body
optional

PersonalDetails

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.287. ResponseEntity«PostalCode»

Name Schema

body
optional

PostalCode

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.288. ResponseEntity«Role»

Name Schema

body
optional

Role

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.289. ResponseEntity«STOMP Session»

Name Schema

body
optional

STOMP Session

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.290. ResponseEntity«SystemError»

Name Schema

body
optional

SystemError

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.291. ResponseEntity«UserAgent»

Name Schema

body
optional

UserAgent

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.292. ResponseEntity«UserCredentials»

Name Schema

body
optional

UserCredentials

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.293. ResponseEntity«UserRegistrationCodeBatch»

Name Schema

body
optional

UserRegistrationCodeBatch

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.294. ResponseEntity«UserRegistrationCode»

Name Schema

body
optional

UserRegistrationCode

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.295. ResponseEntity«User»

Name Schema

body
optional

User

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

3.296. Role

User principal roles. Roles are principals themselves and can be assigned to users.

Name Schema

description
optional

string

name
optional

string

pk
optional

string

3.297. RoleService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.298. STOMP Session

A model representing a websocket STOMP session

Name Schema

new
optional

boolean

pk
optional

string

user
optional

User

3.299. Serializable

Type : object

3.300. SimpleLoginRequest

Name Schema

password
required

string

username
required

string

3.301. Sort

Type : object

3.302. StompSessionService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.303. SystemError

SystemErrors are created exclusively by the system (i.e. without manual intervention) to handle and inform the user about runtime exceptions. They may be persisted automatically according to restdude.validationErrors.system.persist* configuration properties. System validationErrors have a many-to-one relationship with ErrorLog records, as those are shared based on their hash to save space.

Name Description Schema

createdBy
optional

The initial content author

UserDTO

createdDate
optional

Date created

LocalDateTime

errorLog
optional

ErrorLog

errorLogId
optional

The corresponding log/stacktrace ID, if any

string

httpStatusCode
optional

The HTTP response status code

integer(int32)

httpStatusMessage
optional

The phrase corresponding to the HTTP status

string

lastModifiedDate
optional

Date last modified

LocalDateTime

message
optional

Message for users

string

pk
optional

string

remoteAddress
optional

The address the request originated from

string

requestMethod
optional

The HTTP request method

string

requestUrl
optional

The HTTP request URL, relative to system base URL

string

userAgent
optional

The UA string if provided with a request

UserAgent

validationErrors
optional

Failed constraint validation errors, if any

< ConstraintViolationEntry > array

3.304. SystemErrorService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.305. UiSchema

Name Schema

json
optional

string

3.306. User

Human users

Name Schema

active
optional

boolean

avatarUrl
optional

string

bannerUrl
optional

string

description
optional

string

emailHash
optional

string

firstName
optional

string

fullName
optional

string

lastName
optional

string

lastVisit
optional

LocalDateTime

locale
optional

string

metadata
optional

< string, UserMetadatum > map

name
optional

string

pk
optional

string

roles
optional

< GrantedAuthority > array

stringCount
optional

integer(int32)

strings
optional

< string > array

username
optional

string

3.307. UserAccountRegistration

User registration

Name Schema

email
optional

string

firstName
optional

string

lastName
optional

string

locale
optional

string

password
optional

string

passwordConfirmation
optional

string

redirectUrl
optional

string

registrationCode
optional

string

username
optional

string

3.308. UserAgent

UA signatures

Name Description Schema

new
optional

boolean

pk
optional

string

value
optional

UA signature string pathFragment

string

3.309. UserAgentService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.310. UserCredentials

User login information

Name Schema

active
optional

boolean

inactivationDate
optional

LocalDateTime

inactivationReason
optional

string

lastLogin
optional

LocalDateTime

lastPassWordChangeDate
optional

LocalDateTime

loginAttempts
optional

integer(int32)

new
optional

boolean

pk
optional

string

resetPasswordToken
optional

string

resetPasswordTokenCreated
optional

LocalDateTime

3.311. UserCredentialsService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.312. UserDTO

UserDTO is a lightweight DTO version of User

Name Schema

avatarUrl
optional

string

bannerUrl
optional

string

emailHash
optional

string

firstName
optional

string

lastName
optional

string

name
optional

string

pk
optional

string

stompSessionCount
optional

integer(int32)

username
optional

string

3.313. UserDetails

Name Schema

accountNonExpired
optional

boolean

accountNonLocked
optional

boolean

active
optional

boolean

admin
optional

boolean

authorities
optional

Collection«GrantedAuthority»

avatarUrl
optional

string

birthDay
optional

LocalDate

cellphone
optional

string

credentialsNonExpired
optional

boolean

dateFormat
optional

string

emailHash
optional

string

enabled
optional

boolean

firstName
optional

string

inactivationDate
optional

LocalDateTime

inactivationReason
optional

string

lastName
optional

string

lastPassWordChangeDate
optional

LocalDateTime

lastPost
optional

LocalDateTime

lastVisit
optional

LocalDateTime

locale
optional

string

loginAttempts
optional

integer(int32)

metadata
optional

< string, string > map

name
optional

string

new
optional

boolean

password
optional

string

pk
optional

string

redirectUrl
optional

string

siteAdmin
optional

boolean

telephone
optional

string

userId
optional

string

username
optional

string

3.314. UserInvitationResultsDTO

Data transfer object for user invitation resultss

Name Description Schema

duplicate
optional

A list of ignored duplicate addressess.

< string > array

existing
optional

A list of ignored, pre-existing addressess.

< string > array

invalid
optional

A list of invalid addressess.

< string > array

invited
optional

A list of invited addressess.

< string > array

3.315. UserInvitationsDTO

Data transfer object for user invitations

Name Description Schema

addressLines
optional

A line and/or comma delimeted string of RFC 2822 email addresses.

string

recepients
optional

A list of UserDTO instances.

< UserDTO > array

3.316. UserMetadatum

Name Schema

object
optional

string

pk
optional

string

predicate
optional

string

3.317. UserModel

Name Schema

active
optional

boolean

avatarUrl
optional

string

bannerUrl
optional

string

description
optional

string

emailHash
optional

string

firstName
optional

string

fullName
optional

string

lastName
optional

string

lastVisit
optional

LocalDateTime

locale
optional

string

localeObject
optional

Locale

name
optional

string

roles
optional

< GrantedAuthority > array

username
optional

string

3.318. UserRegistrationCode

UserRegistrationCode

Name Schema

available
optional

boolean

batch
optional

UserRegistrationCodeBatch

pk
optional

string

3.319. UserRegistrationCodeBatch

UserRegistrationCodeBatch

Name Description Schema

available
optional
read-only

The number of available codes in the batch

integer(int32)

batchSize
required

The number of codes to generate (1 to 20), non-updatable.
Example : 10

integer(int32)

createdDate
optional

Date created

LocalDateTime

description
required

The batch description.
Example : "A batch for CompanyName"

string

expirationDate
optional

Expiration date.

LocalDate

lastModifiedDate
optional

Date last modified

LocalDateTime

name
required

Unique short code, non-updatable.
Example : "CompanyName01"

string

pk
optional

string

3.320. UserRegistrationCodeBatchService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.321. UserRegistrationCodeInfo

Name Schema

available
optional

boolean

batchId
optional

string

batchName
optional

string

pk
optional

string

username
optional

string

3.322. UserRegistrationCodeService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.323. UserService

Name Schema

conversionService
optional

ConversionService

filePersistenceService
optional

FilePersistenceService

principal
optional

UserDetails

principalLocalUser
optional

UserModel

3.324. UsernameChangeRequest

A request to change one’s username,

Name Schema

password
optional

string

username
optional

string