/
BE
beis
/
METS API Documentation
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 1h ago · Updated 3w ago
Details
Filter operations
Account Details History
1
get
Get the account details history for an account
Account Notes
7
get
Get an account note
put
Update an account note
delete
Delete an account note
get
Retrieves the notes for account id
post
Creates a new account note
post
Upload a note file
get
Generate the token to get the file that belongs to the provided account note id
Account Reporting
1
post
Retrieves the year's emissions for account
Account verification body
5
post
Appoint verification body to account
patch
Reappoint verification body to account
get
Get the verification body of the account (if exists)
get
Get all active verification bodies
delete
Unappoint verification body from account
AccountFileAttachment
1
get
Generate the token to get the file that belongs to the provided account id
Aircraft Types
1
post
Retrieves the aircraft types for the given search criteria
Authorities
4
get
Retrieves the verifier role codes
get
Returns all regulator roles
get
Retrieves the status of the logged in user
get
Retrieves the operator roles
Aviation Account Reporting
1
post
Retrieves the year's emissions for an aviation account
Aviation account reporting status
3
get
Get the reporting status history list for an account for all reporting years
post
Submits an aviation account reporting status
get
Get reporting status history list for an aviation account
Aviation account update
2
post
Update the aviation account
post
Validate and update the first year of reporting obligation for an aviation account
Aviation account view
3
get
Get the account information that will be sent to registry for a manual account creation
get
Get the aviation account with the provided id
get
Get the account header info for the provided aviation account
Aviation accounts
4
get
Retrieves the current user associated aviation accounts
post
Creates an aviation account
get
Checks if account name exists
get
Checks if central route charges office code exists
Aviation Reported Airports
1
post
Retrieves information for given list of ICAO codes
Aviation Reporting
9
post
Calculate total emissions for the scheme year
post
Retrieves total emissions for standard fuels
post
Retrieves domestic flights emissions
post
Retrieves domestic flights emissions
post
Calculate total emissions for aerodrome pairs
post
Calculate total emissions for the scheme year
post
Retrieves total emissions for standard fuels
post
Retrieves corsia international flights emissions
post
Calculate total emissions for aerodrome pairs
aviation-account-creation-registry-controller
1
get
Check if the account connected to the provided request can be sent to registry
BulkDownload
5
get
Retrieves the list of available workflow types for bulk download.
get
Retrieves the list of periods available for bulk download for a specific workflow type.
get
Downloads bulk export for the selected workflow and period
get
Get the file attachment resource for the provided file attachment token
get
Check if the regulator has access bulk download.
Ca external contacts
5
get
Retrieves the current regulator external contacts
post
Creates a new ca external contact
delete
Deletes the ca external contact with specified id
patch
Edits the ca external contact with specified id
get
Returns the ca external contacts with specified ids
Ca site contacts
2
get
Retrieves the accounts and competent authority site contact of the accounts
post
Updates competent authority site contacts
Company Information
1
get
Retrieves information about the company that corresponds to the provided registration number
digitized-mmp-migration-upload-file-controller
1
post
Upload MMP file to temporary storage to be used for MMP migration
Document Preview
1
post
Get the file for preview
Document Template Files
1
get
Generates the token to get the file with the provided uuid that belongs to the provided document template
Document Templates
3
get
Retrieves the document template with the provided id
post
Updates the document template with the provided id
get
Retrieves the document templates associated with current user
Emps
2
get
Generate the token to get the document that belongs to the provided emp id
get
Generate the token to get the file that belongs to the provided emp id
File Attachments
1
get
Get the file attachment resource for the provided file attachment token
File Document Templates
1
get
Get the file document template resource for the provided file token
File Documents
1
get
Get the file document resource for the provided file token
File Notes
1
get
Get the file note resource for the provided file token
Forgot Password
3
post
Verifies the JWT token provided in the email
post
Resets user's password
post
Sends a reset password email
Installation account update
8
put
Update the installation free allocation status of the account
post
Update the sop id of the account
post
Update the site name of the account
post
Update the first year of registry reporting obligation field of the account
post
Update the installation name of the account
post
Updates the legal entity of the account
post
Update the commencement date of the account
post
Updates the address of the account
Installation account view
2
get
Get the account with the provided id
get
Get the account header info for the provided account
Installation accounts
2
get
Retrieves the current user associated accounts
get
Checks if account name exists
Issuing Authorities
1
get
Retrieves the EMP issuing authority names
Items Assigned To Me
1
get
Retrieves the items assigned to the logged-in user
Items Assigned To Others
1
get
Retrieves the items assigned to users different than the logged-in user of the same role type who participate in the same accounts
Legal Entities
3
get
Retrieves all legal entities associated with the user
get
Returns legal entity with the specified id that is associated with the user
get
Checks if legal entity name exists
Mi Reports User defined
12
get
Retrieves the report that matches the provided id
put
Updates the report that matches the provided id
delete
Deletes the report that matches the provided id
post
Previews custom mi report user defined
post
Generates custom mi report user defined
post
Adds the mi report that corresponds to the provided id to the user's favourites
delete
Removes the mi report that corresponds to the provided id from the user's favourites
post
Creates a user defined custom mi report
get
Retrieves all enabled user defined mi reports
get
Check if the regulator can manage (create/update/delete) custom mi reports
get
Retrieves the history of a user defined mi report
get
Retrieves all enabled user defined mi report categories
MiReports
3
post
Generates the report identified by the provided report type
get
Retrieves the mi report types for current user
get
Get regulator related request task types
Notification Templates
3
get
Retrieves the notification template with the provided id
put
Updates the notification template with the provided id
get
Retrieves the notification templates associated with current user
Operator Authorities
4
get
Retrieves the authorities of type OPERATOR for the given account id along with the account contact types
post
Updates authorities for users of type OPERATOR for the given account id
delete
Deletes logged in authority from the account
delete
Deletes authority from the account
Operator Users
4
patch
Updates logged in operator user
get
Retrieves info of operator user by account and user id
patch
Updates operator user by account and user id
patch
Resets the 2FA device for an operator user by account and user id
Operator Users invitation
1
post
Adds a new operator user to an account with a specified role.
Operator users registration
7
put
Accept authority and set credentials to user
put
Accept authority and enable operator user from invitation token without credentials
put
Accept authority and enable operator user from invitation token
post
Sends a verification email
post
Verifies the JWT token provided in the email
post
Register a new operator user
post
Accept invitation for operator user
Payments
2
post
Process existing card payment that corresponds to the provided task
post
Create card payment for the provided task
Permits
2
get
Generate the token to get the document that belongs to the provided permit id
get
Generate the token to get the file that belongs to the provided permit id
Reference Data
1
get
Retrieves reference data by type
Regulator Authorities
7
get
Retrieves the users of type REGULATOR
post
Updates regulator users status
delete
Delete the current regulator user
get
Retrieves the current regulator user's permissions
get
Retrieves the regulator user's permissions
get
Retrieves the regulator permissions group levels
delete
Delete the regulator user that corresponds to the provided user id
Regulator Users
6
post
Updates the current regulator user
get
Retrieves the user of type REGULATOR that corresponds to the provided user id
post
Updates the user of type REGULATOR that corresponds to the provided user id
post
Resets the 2FA device for the user of type REGULATOR that corresponds to the provided user id
post
Invite new regulator user
get
Generate the token to get the signature of the user with the provided user id
Regulator users registration
2
put
Accept authority and activate regulator user from invitation
post
Accept invitation for regulator user
Reporting
4
post
/v1.0/reporting/measurement/n2o/calculate-emissions
post
/v1.0/reporting/measurement/co2/calculate-emissions
post
Calculates emissions using AER PFC calculation approach
post
Calculates emissions using AER calculation approach
Reporting Data
5
get
Returns reporting year inventory data existence
get
Returns regional emission calculation parameters for the provided year and charging zone
get
Returns national inventory data for the provided year
get
Returns charging zones associated with the provided post code
get
Returns calculation parameters information by source stream type
Request action attachments handling
1
get
Generate the token to get the file with the provided uuid that belongs to the provided request action
Request action file documents handling
1
get
Generate the token to get the file document with the provided uuid that belongs to the provided request action
Request actions
2
get
Retrieves the actions associated with the request
get
Get request action by id
Request items
1
get
Retrieves the items by request
Request Notes
7
get
Get a request note
put
Update a request note
delete
Delete a request note
get
Retrieves the notes for request id
post
Creates a new request note
post
Upload a note file
get
Generate the token to get the file that belongs to the provided request note id
Request task attachments handling
2
post
Upload a request task attachment
get
Generate the token to get the file with the provided uuid that belongs to the provided task
Requests
11
post
Processes a request create action
post
Get the workflows for the given search criteria
post
Mark as not required the given request and terminate Aer workflow
post
Mark as not required the given request and terminate Alr workflow
get
Get the batch reissue requests
get
Get request details by id
get
Retrieves request types based on user role and service (INSTALLATION, AVIATION)
get
Get workflows to start a task
get
Get workflows to start a task
get
Check if the user has access to mark as not required for an alr workflow
get
Check if the user has access to mark as not required
Settings
2
get
Retrieves the settings sections accessible to the current regulator user
get
Retrieves the changeable fee rows on the Settings Fees page for the current regulator's CA
Source Streams
1
get
Returns source stream types with categories
SubInstallationTypes
1
get
Retrieves the list of sub installation types with details.
Tasks
2
post
Processes a request task action
get
Get task item info by id
Tasks Assignment
3
post
Assigns a task to a user
get
Returns all users to whom can be assigned the provided task
get
Returns all users to whom can be assigned the provided task type
Tasks Release
1
delete
Releases a task
Terms and conditions
3
get
Retrieves accepted terms and conditions version of the logged in user
patch
Updates accepted terms and conditions of the logged in user
get
Retrieves the latest version of terms and conditions
UI Configuration
1
get
Retrieves configuration for UI features
Unassigned Items
1
get
Retrieves the unassigned items
User signatures
1
get
Get the user signature resource for the provided file token
Users
4
put
Updates the last login domain of the logged in user
post
Provides the feedback about the service for the logged in user
get
Generate the token to get the signature of the current user
get
Retrieves info of the logged in user
Users Security Setup
2
post
Requests the update of the two factor authentication
patch
Delete the two factor authentication
Validate Password
1
post
Check if password matches the password policy rules
VB site contacts
2
get
Retrieves the accounts and verification body site contact of the accounts
post
Updates verification body site contacts
Verification Bodies
6
get
Retrieves all verification bodies
put
Update the verification body
post
Creates a verification body
patch
Update the verification bodies status
get
Get the verification body with the provided id
delete
Delete the verification body with the provided id
Verifier authorities
6
get
Retrieves the list of verifier authorities related to the verification body to which I have been assigned to
post
Updates the verifier authorities
delete
Delete the current verifier user
get
Retrieves the list of verifier authorities related to the verification body
post
Updates the verifier authorities of the specified verification body
delete
Delete the verifier user that corresponds to the provided user id
Verifier Users
4
get
Retrieves the user of type VERIFIER for the given user id
patch
Updates verifier user by user id
patch
Resets the 2FA device for a verifier user by user id
patch
Updates logged in verifier user
Verifier Users Invitation
2
post
Invite new verifier user to the verification body
post
Invite new admin verifier user to the verification body
Verifier users registration
2
put
Accept authority and activate verifier user from invitation
post
Accept invitation for verifier user
Withhold Flag Requests
1
get
Check if the account can reopen a completed withhold flag workflow
Verifier users registration
Accept authority and activate verifier user from invitation
put
/v1.0/verifier-users/registration/accept-authority-and-activate-verifier-user-from-invitation
Request body
InvitedUserCredentialsDTO
required
The operator user credentials
invitationToken
string
required
password
string
required
Response
No Content
Changes