easy-addresses
Operations addressed under /easy-addresses — 4 operations.
create-easy-address
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.
create-easy-address › Request Body
accountIdaddressTypeValuedescriptionstatusPermitted values — validated against the easy_address_status parameter.
| Value | Meaning |
|---|---|
1 | Deleted |
2 | Active |
3 | Moved |
4 | Deleted From Different Channel |
Permitted values — validated against the status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | Pending | no label seeded |
1 | Done | no label seeded |
2 | Cancel | no label seeded |
3 | Write | no label seeded |
systemReferenceNumbertransactionidtypePermitted values — validated against the easy_address_type parameter.
| Value | Meaning |
|---|---|
1 | Phone Number |
2 | |
3 | TCKN |
4 | VKN |
5 | YKN |
6 | Passport Number |
Permitted values — validated against the easy_address_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Phone Number | no label seeded |
2 | Email | no label seeded |
3 | TCKN | no label seeded |
4 | VKN | no label seeded |
5 | YKN | no label seeded |
6 | Passport Number | no label seeded |
create-easy-address › 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.
get-easy-address-by-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 EasyAddressDto.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Status | — | int? | yes |
Type | — | int? | yes |
AccountId | — | Guid? | yes |
AddressTypeValue | — | string | no |
Description | — | string | no |
TransactionId | transactionid | string | no |
SystemReferenceNumber | — | string | no |
ChannelId | — | Guid? | yes |
Member names are the service's declaration names, except where a member states a wire name — there the wire name is the key to send.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_MNYTRNS_37 | 400 | EASY_ADDRESS_NOT_FOUND | Easy Address Not Found |
path Parameters
idget-easy-address-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
update-easy-address
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_MNYTRNS_37 | 400 | EASY_ADDRESS_NOT_FOUND | Easy Address Not Found |
path Parameters
idupdate-easy-address › Request Body
accountIdaddressTypeValuedescriptionstatusPermitted values — validated against the easy_address_status parameter.
| Value | Meaning |
|---|---|
1 | Deleted |
2 | Active |
3 | Moved |
4 | Deleted From Different Channel |
Permitted values — validated against the status parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | Pending | no label seeded |
1 | Done | no label seeded |
2 | Cancel | no label seeded |
3 | Write | no label seeded |
systemReferenceNumbertransactionidtypePermitted values — validated against the easy_address_type parameter.
| Value | Meaning |
|---|---|
1 | Phone Number |
2 | |
3 | TCKN |
4 | VKN |
5 | YKN |
6 | Passport Number |
Permitted values — validated against the easy_address_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Phone Number | no label seeded |
2 | Email | no label seeded |
3 | TCKN | no label seeded |
4 | VKN | no label seeded |
5 | YKN | no label seeded |
6 | Passport Number | no label seeded |
update-easy-address › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-easy-address
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_MNYTRNS_37 | 400 | EASY_ADDRESS_NOT_FOUND | Easy Address Not Found |
path Parameters
iddelete-easy-address › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.