blocked-items
Operations addressed under /blocked-items — 4 operations.
create-blocked-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 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_ACCNT_1 | 400 | THERE_IS_A_DEFINITION_WITH_THE_SAME_CODE | There is a definition with the same code. |
ERR_ACCNT_2 | 400 | THERE_SHOULD_BE_NO_SPACES_BETWEEN_THE_VALUES | There should be no spaces between the value entered in the code field. |
ERR_ACCNT_3 | 400 | PARENT_ID_IS_NOT_FOUND | Parent product not found. |
ERR_ACCNT_4 | 400 | PARENT_PRODUCT_IS_NOT_ACTIVE | Parent product is not active. |
create-blocked-item › Request Body
blockedContentPermitted values — validated against the blocked_content parameter.
| Value | Meaning |
|---|---|
1 | Current |
2 | Future |
codedescriptionisCreditBlockedisDebitBlockedisDoubleBlockedisManualBlockedisManualUnblockedisPartialBlockedisSortednameisDistraintparentBlockedItemIdprioritycreate-blocked-item › 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.
idupdate-blocked-item
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_ACCNT_24 | 400 | BLOCKED_ITEM_NOT_FOUND | Blocked item not found. |
ERR_ACCNT_3 | 400 | PARENT_ID_IS_NOT_FOUND | Parent product not found. |
ERR_ACCNT_4 | 400 | PARENT_PRODUCT_IS_NOT_ACTIVE | Parent product is not active. |
ERR_ACCNT_71 | 400 | IS_ACTIVE_MUST_NOT_BE_EMPTY | Is Active must not be empty. |
path Parameters
idupdate-blocked-item › Request Body
blockedContentPermitted values — validated against the blocked_content parameter.
| Value | Meaning |
|---|---|
1 | Current |
2 | Future |
descriptionisActiveisCreditBlockedisDebitBlockedisDoubleBlockedisManualBlockedisManualUnblockedisPartialBlockedisSortednameisDistraintparentBlockedItemIdpriorityupdate-blocked-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.
delete-blocked-item
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_ACCNT_10 | 400 | RECORD_CANNOT_BE_DELETED_IT_IS_PARENT_OF_ANOTHER_PRODUCT_DEFINITION | This record cannot be deleted because it is defined as a parent on another product definition. First delete child products. |
ERR_ACCNT_24 | 400 | BLOCKED_ITEM_NOT_FOUND | Blocked item not found. |
ERR_ACCNT_92 | 400 | BLOCKED_ITEM_IS_USED | Blocked Item is used. |
path Parameters
iddelete-blocked-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.
is-blocked-item-usaged
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 bool, a scalar rather than an object. There is no field tree below because there are no fields: the body is the JSON literal true or false. This is a complete answer read from the declaration, not a gap.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCNT_24 | 400 | BLOCKED_ITEM_NOT_FOUND | Blocked item not found. |
path Parameters
idis-blocked-item-usaged › 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.