blocked-items

Operations addressed under /blocked-items — 4 operations.

aurax-bff-dynamic-get-blocked-item-list

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/blocked-items

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Request and response fields are declared on the routing target get-blocked-item-list; this entry declares none of its own.

Response body, read from the service source

The route declares its response as IEnumerable<BlockedItemDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`Description`	`string`	no
`ParentBlockedItemId`	`Guid?`	yes
`IsActive`	`bool`	no
`IsLeafLevel`	`bool`	no
`BlockedContent`	`int?`	yes
`IsSorted`	`bool?`	yes
`IsPartialBlocked`	`bool?`	yes
`IsCreditBlocked`	`bool?`	yes
`IsDebitBlocked`	`bool?`	yes
`IsDoubleBlocked`	`bool?`	yes
`IsManualBlocked`	`bool?`	yes
`IsManualUnblocked`	`bool?`	yes
`Priority`	`int?`	yes
`IsDistraint`	`bool`	no

Member names are the service's declaration names.

aurax-bff-dynamic-get-blocked-item-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

aurax-bff-dynamic-get-blocked-item-list › Responses

Success. Returns a page of records: the collection under data, with total carrying the unpaged count.

Paged response envelope observed on the BFF response path.

object[] · required

Response records carried by this page.

total

integer · int64

Total matching records, ignoring paging.

aurax-bff-dynamic-create-blocked-item-ui-bpmn

POST

https://dg-sandbox.dgpays.com/aurax-bff-service

/blocked-items

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Request and response fields are declared on the routing target create-blocked-item-ui-bpmn; this entry declares none of its own.

aurax-bff-dynamic-create-blocked-item-ui-bpmn › Request Body

blockedContent

integer · int32 · required

code

string · required

description

string · required

isCreditBlocked

boolean · required

isDebitBlocked

boolean · required

isDoubleBlocked

boolean · required

isManualBlocked

boolean · required

isManualUnblocked

boolean · required

isPartialBlocked

boolean · required

isSorted

boolean · required

name

string · required

parentBlockedItemId

string · uuid

priority

integer · int32

aurax-bff-dynamic-create-blocked-item-ui-bpmn › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

POST/blocked-items

curl https://dg-sandbox.dgpays.com/aurax-bff-service/blocked-items \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "blockedContent": 0,
  "code": "",
  "description": "",
  "isCreditBlocked": false,
  "isDebitBlocked": false,
  "isDoubleBlocked": false,
  "isManualBlocked": false,
  "isManualUnblocked": false,
  "isPartialBlocked": false,
  "isSorted": false,
  "name": "",
  "parentBlockedItemId": "",
  "priority": 0
}'

Example Request Body

{
  "blockedContent": 0,
  "code": "",
  "description": "",
  "isCreditBlocked": false,
  "isDebitBlocked": false,
  "isDoubleBlocked": false,
  "isManualBlocked": false,
  "isManualUnblocked": false,
  "isPartialBlocked": false,
  "isSorted": false,
  "name": "",
  "parentBlockedItemId": "",
  "priority": 0
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

aurax-bff-dynamic-get-blocked-item-by-id

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/blocked-items/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Request and response fields are declared on the routing target get-blocked-item-by-id; this entry declares none of its own.

Response body, read from the service source

The route declares its response as BlockedItemDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`Description`	`string`	no
`ParentBlockedItemId`	`Guid?`	yes
`IsActive`	`bool`	no
`IsLeafLevel`	`bool`	no
`BlockedContent`	`int?`	yes
`IsSorted`	`bool?`	yes
`IsPartialBlocked`	`bool?`	yes
`IsCreditBlocked`	`bool?`	yes
`IsDebitBlocked`	`bool?`	yes
`IsDoubleBlocked`	`bool?`	yes
`IsManualBlocked`	`bool?`	yes
`IsManualUnblocked`	`bool?`	yes
`Priority`	`int?`	yes
`IsDistraint`	`bool`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCNT_24`	400	`BLOCKED_ITEM_NOT_FOUND`	Blocked item not found.

aurax-bff-dynamic-get-blocked-item-by-id › path Parameters

id

string · uuid · required

aurax-bff-dynamic-get-blocked-item-by-id › 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.

blockedContent

integer · int32

code

string

description

string

id

string · uuid

isActive

boolean

isCreditBlocked

boolean

isDebitBlocked

boolean

isDistraint

boolean

isDoubleBlocked

boolean

isLeafLevel

boolean

isManualBlocked

boolean

isManualUnblocked

boolean

isPartialBlocked

boolean

isSorted

boolean

name

string

parentBlockedItemId

string · uuid

parentId

string · uuid

priority

integer · int32

aurax-bff-dynamic-update-blocked-item-ui-bpmn

PUT

https://dg-sandbox.dgpays.com/aurax-bff-service

/blocked-items/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Request and response fields are declared on the routing target update-blocked-item-ui-bpmn; this entry declares none of its own.

aurax-bff-dynamic-update-blocked-item-ui-bpmn › path Parameters

id

string · uuid · required

aurax-bff-dynamic-update-blocked-item-ui-bpmn › Request Body

blockedContent

integer · int32 · required

description

string · required

isActive

boolean · required

isCreditBlocked

boolean · required

isDebitBlocked

boolean · required

isDoubleBlocked

boolean · required

isManualBlocked

boolean · required

isManualUnblocked

boolean · required

isPartialBlocked

boolean · required

isSorted

boolean · required

name

string · required

parentBlockedItemId

string · uuid

priority

integer · int32

aurax-bff-dynamic-update-blocked-item-ui-bpmn › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

PUT/blocked-items/{id}

curl https://dg-sandbox.dgpays.com/aurax-bff-service/blocked-items/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "blockedContent": 0,
  "description": "",
  "isActive": false,
  "isCreditBlocked": false,
  "isDebitBlocked": false,
  "isDoubleBlocked": false,
  "isManualBlocked": false,
  "isManualUnblocked": false,
  "isPartialBlocked": false,
  "isSorted": false,
  "name": "",
  "parentBlockedItemId": "",
  "priority": 0
}'

Example Request Body

{
  "blockedContent": 0,
  "description": "",
  "isActive": false,
  "isCreditBlocked": false,
  "isDebitBlocked": false,
  "isDoubleBlocked": false,
  "isManualBlocked": false,
  "isManualUnblocked": false,
  "isPartialBlocked": false,
  "isSorted": false,
  "name": "",
  "parentBlockedItemId": "",
  "priority": 0
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

blacklists business-core