qr-formats
Operations addressed under /qr-formats — 6 operations.
get-qr-format-list
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 IEnumerable<QrFormatDto>.
| Field | Declared type | Nullable |
|---|---|---|
OutputType | int | no |
Code | string | no |
IsActive | bool | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-qr-format-list › 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.
create-qr-format
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 | Message |
|---|---|---|---|
ERR_QR_1 | 400 | QR_FORMAT_EXIST_WITH_SAME_CODE | There is a QR Format definition with the same code: {0} |
create-qr-format › Request Body
codeisActiveoutputTypePermitted values — validated against the qr_output_type parameter.
| Value | Meaning |
|---|---|
1 | text |
2 | link |
Permitted values — validated against the qr_output_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | text | no label seeded |
2 | link | no label seeded |
create-qr-format › 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.
generate-qr-code
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 GenerateQrCodeDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
QrCodeOutput | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_QR_10 | 400 | QR_FORMAT_LINK_VALUE_IS_NULL_OR_EMPTY_OR_NOT_WELL_FORMED_URI | The LinkValue should be not null or empty and must be well formed URI: {0} |
ERR_QR_5 | 400 | QR_FORMAT_NOT_FOUND_BY_CODE | There is no QR Format definition with the code: {0} |
ERR_QR_6 | 400 | QR_FORMAT_DOES_NOT_HAVE_QR_FORMAT_ITEMS_BY_QR_FORMAT_CODE | There is no QR Format Items with the Qr Format Code: {0} |
ERR_QR_8 | 400 | QR_FORMAT_BOTH_ITEM_VALUES_AND_LINK_VALUE_CANNOT_BE_SENT | Both LinkValue and ItemValues information cannot be sent. |
ERR_QR_9 | 400 | QR_FORMAT_BOTH_ITEM_VALUES_AND_LINK_VALUE_CANNOT_BE_NULL_OR_EMPTY | Both LinkValue and ItemValues cannot be null or empty. |
path Parameters
codegenerate-qr-code › 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.
get-qr-format-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 QrFormatDto.
| Field | Declared type | Nullable |
|---|---|---|
OutputType | int | no |
Code | string | no |
IsActive | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_QR_2 | 400 | QR_FORMAT_NOT_FOUND_BY_ID | There is no definition with the QR Format Id: {0} |
path Parameters
idget-qr-format-by-id › 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.
get-qr-format-item-list-by-qr-format-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 QrFormatItemListDto.
| Field | Declared type | Nullable |
|---|---|---|
ItemList | IEnumerable<QrFormatItemDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_QR_2 | 400 | QR_FORMAT_NOT_FOUND_BY_ID | There is no definition with the QR Format Id: {0} |
path Parameters
idget-qr-format-item-list-by-qr-format-id › 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.
create-qr-format-item
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 CreateQrFormatItemListDto.
| Field | Declared type | Nullable |
|---|---|---|
ItemList | IEnumerable<CreateQrFormatItemDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_QR_2 | 400 | QR_FORMAT_NOT_FOUND_BY_ID | There is no definition with the QR Format Id: {0} |
ERR_QR_3 | 400 | QR_FORMAT_ITEM_EXIST_WITH_SAME_NAME | There are existing QR Format Item definitions with same Name : {0} |
path Parameters
idcreate-qr-format-item › 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.