potential-users
Operations addressed under /potential-users — 4 operations.
create-potential-user
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_CORE_191 | 400 | POTENTIAL_USER_ALREADY_EXISTS |
create-potential-user › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
update-potential-user
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Declared as Route-bound but absent from the route template, so not sendable: phoneNumber.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_CORE_188 | 400 | POTENTIAL_USER_NOT_FOUND |
path Parameters
citizenIdupdate-potential-user › Request Body
customerIdcustomerNocustomerTypeuserNamebirthDateupdate-potential-user › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
passworduserIdget-potential-user-credentials-by-citizen-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as PotentialUserCredentialsDto.
| Field | Declared type | Nullable |
|---|---|---|
UserName | string | no |
Token | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_CORE_188 | 400 | POTENTIAL_USER_NOT_FOUND |
path Parameters
citizenIdget-potential-user-credentials-by-citizen-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-current-user-citizen-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as CurrentUserCitizenIdDto.
| Field | Declared type | Nullable |
|---|---|---|
CitizenId | string | no |
CustomerId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_CORE_188 | 400 | POTENTIAL_USER_NOT_FOUND |
get-current-user-citizen-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.