Frontend | Backend | Api

Users routes (Backend)

Name Request Response variables Description
addAuthor

GET /cdna-admin/users/add-author/{person.id}

person.id \d+
Name Type Description
author Author Single (empty) Author record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Add a new record. Assigns an empty record to the template.
editAuthor

GET /cdna-admin/users/author/{id}

id \d+
Name Type Description
author Author Retrieved Author record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve a single record and display the edit page for the record
manageAuthors

GET /cdna-admin/users/authors

Name Type Description
authors Collection (Author) Collection of Authors
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve available records and assign them to the template for editing.
addUser

GET /cdna-admin/users/add-user/{person.id}

person.id \d+
Name Type Description
user User Single (empty) User record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Add a new record. Assigns an empty record to the template.
addAuthorUser

GET /cdna-admin/users/add-author-user/{author.id}

author.id \d+
Name Type Description
user User Single (empty) User record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Add a new record. Assigns an empty record to the template.
editUser

GET /cdna-admin/users/user/{id}

id \d+
Name Type Description
user User Retrieved User record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve a single record and display the edit page for the record
manageUsers

GET /cdna-admin/users/users/{person.groups.id}

person.groups.id \d+
Name Type Description
users Collection (User) Collection of Users
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve available records and assign them to the template for editing.
addPerson

GET /cdna-admin/users/add-person

Name Type Description
person Person Single (empty) Person record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Add a new record. Assigns an empty record to the template.
editPerson

GET /cdna-admin/users/person/{id}

id \d+
Name Type Description
person Person Retrieved Person record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve a single record and display the edit page for the record
managePeople

GET /cdna-admin/users/people/{groups.id}

groups.id \d+
Name Type Description
people Collection (Person) Collection of People
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve available records and assign them to the template for editing.
addGroup

GET /cdna-admin/users/add-group

Name Type Description
group Group Single (empty) Group record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Add a new record. Assigns an empty record to the template.
editGroup

GET /cdna-admin/users/group/{id}

id \d+
Name Type Description
group Group Retrieved Group record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve a single record and display the edit page for the record
manageGroups

GET /cdna-admin/users/groups

Name Type Description
groups Collection (Group) Collection of Groups
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve available records and assign them to the template for editing.
addAddressType

GET /cdna-admin/users/add-address-type

Name Type Description
addressType AddressType Single (empty) AddressType record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Add a new record. Assigns an empty record to the template.
editAddressType

GET /cdna-admin/users/address-type/{id}

id \d+
Name Type Description
addressType AddressType Retrieved AddressType record
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve a single record and display the edit page for the record
manageAddressTypes

GET /cdna-admin/users/address-types

Name Type Description
addressTypes Collection (AddressType) Collection of AddressTypes
_messages Coredna\Kernel\Helper\Response\Messages Messages helper; used to retrieve messages from the controller
_currentSite Site Current site
_url Coredna\Kernel\Helper\Url URL helper; used to generate urls
_request Coredna\Kernel\Helper\Response\Request Current HTTP request
_configuration Coredna\Kernel\Helper\Response\Configuration Configuration helper; provides access to the site's configuration
__ Coredna\Kernel\Helper\Translator Translation helper; allows translating keys to text
_validation Coredna\Kernel\Helper\Validation Validation helper; allows displaying error messages from validation errors
Retrieve available records and assign them to the template for editing.