Core - Import Controller
This controller is meant to be used for automatic import process.
The base url for the APIs in this page is at:
/api/admin
A JSON file with OpenAPI data about all core-related admin APIs can be downloaded here
.
Add new user
Creates a new user on the platform:
The API is found at the url /v1/import/user/{adminId}
The parameter adminId
must be the Guid of and Administrator user.
With a request body like this:
{
Email: "user@email.com", // String
AdditionalData: [{Type:"", FieldName: "selfie"},{/* ... */}], // String (JSON Dictionary)
LicenseDocumentNumber: "", // String
LicenseDocumentIssuer: "", // String
LicenseDocumentCategory: "", // String
LicenseDocumentFront: "", // String
LicenseDocumentBack: "" // String
}
Returns a plain Json positive response with the Guid
of the new user record if the request was successful:
{
Guid: "53155c4a-b2a0-412f-ab41-552d9ccdf784" // Guid
}
or a negative one if the Guid provided in the request does not correspond to a valid administrator operator.
Delete all users
Deletes all users from the database:
The API is found at the url /v1/import/user/remove-all/{adminId}
The parameter adminId
must be the Guid of and Administrator user.
Returns a plain Json positive response if the request was successful, or a negative one if the Guid provided in the request does not correspond to a valid administrator operator.
Remove attachments
Deletes all attachments from the platform:
The API is found at the url /v1/import/attachments/remove-all/{adminId}
The parameter adminId
must be the Guid of and Administrator user.
Returns a plain Json positive response if the request was successful, or a negative one if the Guid provided in the request does not correspond to a valid administrator operator.