FMS Api Request Failures

FMS DevelopersThis article sits within the FMS Developers section

Here is a detailed list of errors that have occurred during failure scenarios related to FMS requests. These errors stem from issues at both the database and form-mapping levels, which caused the requests to fail.

To assist you in better understanding these failures, we have included several sample cases as examples.

These samples demonstrate how the errors manifest and the potential causes behind them. By analysing these, you can gain insight into the specific problems encountered, whether related to data retrieval, incorrect mappings, or other system-level inconsistencies.

If you require further help on any of these errors, please contact us.

Here's a rewritten version of the table with more detailed explanations for each entry:

S. No	Scenario	Type	Details
1	UPIN and Company Number is missing in consent Auth	UPIN & Company number missing	The user will not be able to consent to the form and generate an authorisation token.
2	Provided both UPIN and Company Number in consent form	Both UPIN & Company number given	The user will not be able to consent to the form and generate an authorisation token.
3	No Data transfer Approver(DTA) role	No DTA role	The user will not be able to consent to the form and generate an authorisation token.
4	Collection Period Missing		The required query parameter { Period id } must be provided to proceed with the request.
5	Collection Period is not an integer		The { Period id } parameter must be a positive integer value.
6	Authentication token missing	unknownException	The request is missing the Authorisation Bearer Token header, which is required for authentication.
7	UPIN missing in the authentication token		The Trust UPIN is missing from the Bearer Token in the authorisation header.
8	Form submitted twice or the Trust not set up in metadata	invalidFormSubmissionStatus	This error occurs when the form is submitted multiple times or if the trust is not set up in metadata.
9	CoA code must be numeric	coaValueInvalidType	The Chart of Accounts (CoA) code must be a numeric value.
10	Trust/Counterparty/Academy - Invalid JSON format	invalidRequestBody	An error occurs when any part of the JSON body for Trust, Counterparty, or Academy is invalid.
11	FMS Request CoA version is lower than the latest version in the database	unknownCoaVersion	If the CoA version in the request is lower than the latest version in the database, an error is thrown.
12	CoA code does not match the mapping	invalidCoaCode	This error occurs when the CoA code does not match the expected mapping: [ "matOverview.<coa code>" ], ["counterpartyData.<coa code>"].
13	Trust data balances issue - Trial balance excluding opening balance not equal to zero	trustDataNotInBalance	The error is thrown when the trust data trial balance (excluding the opening balance) does not equal zero.
14	Database Connection Issue	unknownException	An error occurred while trying to access the database.
15	Invalid Academy code in request	unknownAcademy	If the request contains invalid academy code(s), the error will return details like "Invalid academy(ies) found:" and the corresponding academy code.
16	General Exceptions	unknownException	A general exception occurred. Details about the exception type and its description are provided.
17	If request json is not in valid format	schemaValidation	list the failed items
18	Submission closed	newFmsSubmissionsClosed	1. No further data uploads are permitted once your form has begun the approval process. 2. Any changes required can be completed manually. Your form has been submitted for internal/auditor approval. No further data uploads are permitted.