control-item-groups

Operations addressed under /control-item-groups — 8 operations.

get-control-item-group-list

GET

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups

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<ControlItemGroupDto>.

Field	Declared type	Nullable
`Name`	`string`	no
`Description`	`string`	no
`IsActive`	`bool`	no
`ControlItems`	`List<ControlItemGroupMapDto>` (collection)	no

Member names are the service's declaration names.

get-control-item-group-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-control-item-group-list › Responses

Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.

object[]

Array of catalog-declared response records.

object[]

description

string

id

string · uuid

isActive

boolean

name

string

create-control-item-group

POST

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups

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_CUSEVL_2`	400	`CONTROL_ITEM_IS_NOT_FOUND`	Control item is cannot be found with the given id: `{0}`.
`ERR_CUSEVL_3`	400	`CONTROL_ITEM_GROUP_NAME_MUST_BE_UNIQUE`	Control item group name should be unique.
`ERR_CUSEVL_4`	400	`CONTROL_ITEM_GROUP_EFFECT_MUST_CONTAIN_AT_LEAST_ONE_AND`	The effect value of at least one control item in a control group must be and.
`ERR_CUSEVL_5`	400	`CONTROL_ITEM_GROUP_CAN_NOT_CONTAIN_PASSIVE_CONTROL_ITEM`	Control item that is in passive status cannot be included in the control item group. : `{0}`.
`ERR_CUSEVL_7`	400	`CONTROL_ITEM_GROUP_CAN_NOT_CONTAIN_DUPLICATE_CONTROL_ITEM`	The same control item cannot be added to a group more than once.

create-control-item-group › Request Body

object[] · required

description

string · required

name

string · required

create-control-item-group › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

POST/control-item-groups

curl https://dg-sandbox.dgpays.com/customer-evaluation-service/control-item-groups \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "controlItems": [
    {
      "condition": "",
      "controlItemId": "",
      "effect": 0,
      "processOrder": 0,
      "viewOrder": 0
    }
  ],
  "description": "",
  "name": ""
}'

Example Request Body

{
  "controlItems": [
    {
      "condition": "",
      "controlItemId": "",
      "effect": 0,
      "processOrder": 0,
      "viewOrder": 0
    }
  ],
  "description": "",
  "name": ""
}

json

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

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

application/json

get-control-item-group-by-id

GET

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups/{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 ControlItemGroupDto.

Field	Declared type	Nullable
`Name`	`string`	no
`Description`	`string`	no
`IsActive`	`bool`	no
`ControlItems`	`List<ControlItemGroupMapDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CUSEVL_6`	400	`CONTROL_ITEM_GROUP_IS_NOT_FOUND`	Control item group cannot be found with the given: `{0}`.

get-control-item-group-by-id › path Parameters

id

string · uuid · required

get-control-item-group-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.

object[]

description

string

id

string · uuid

isActive

boolean

name

string

update-control-item-group

PUT

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups/{id}

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_CUSEVL_3`	400	`CONTROL_ITEM_GROUP_NAME_MUST_BE_UNIQUE`	Control item group name should be unique.
`ERR_CUSEVL_6`	400	`CONTROL_ITEM_GROUP_IS_NOT_FOUND`	Control item group cannot be found with the given: `{0}`.

update-control-item-group › path Parameters

id

string · uuid · required

update-control-item-group › Request Body

description

string · required

isActive

boolean · required

name

string · required

update-control-item-group › 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.

No data returned

delete-control-item-group

DELETE

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups/{id}

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_CUSEVL_6`	400	`CONTROL_ITEM_GROUP_IS_NOT_FOUND`	Control item group cannot be found with the given: `{0}`.

delete-control-item-group › path Parameters

id

string · uuid · required

delete-control-item-group › Responses

No data returned

create-control-item-group-map

POST

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups/{id}/maps

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 AuraCommandDto.

Field	Declared type	Nullable
`Id`	`Guid`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CUSEVL_2`	400	`CONTROL_ITEM_IS_NOT_FOUND`	Control item is cannot be found with the given id: `{0}`.
`ERR_CUSEVL_5`	400	`CONTROL_ITEM_GROUP_CAN_NOT_CONTAIN_PASSIVE_CONTROL_ITEM`	Control item that is in passive status cannot be included in the control item group. : `{0}`.
`ERR_CUSEVL_6`	400	`CONTROL_ITEM_GROUP_IS_NOT_FOUND`	Control item group cannot be found with the given: `{0}`.
`ERR_CUSEVL_7`	400	`CONTROL_ITEM_GROUP_CAN_NOT_CONTAIN_DUPLICATE_CONTROL_ITEM`	The same control item cannot be added to a group more than once.

create-control-item-group-map › path Parameters

id

string · uuid · required

create-control-item-group-map › Request Body

condition

string · required

controlItemId

string · uuid · required

controlItemProcessOrder

integer · int32 · required

controlItemViewOrder

integer · int32 · required

effectType

integer · enum · int32 · required

Permitted values (2):

1 — And
2 — Or

Enum values:

create-control-item-group-map › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

update-control-item-group-map

PUT

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups/{id}/maps/{controlItemGroupMapId}

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_CUSEVL_13`	400	`CONTROL_ITEM_GROUP_MAP_IS_NOT_FOUND`	The record of the relationship is cannot be found with the given: `{0}`.
`ERR_CUSEVL_4`	400	`CONTROL_ITEM_GROUP_EFFECT_MUST_CONTAIN_AT_LEAST_ONE_AND`	The effect value of at least one control item in a control group must be and.
`ERR_CUSEVL_6`	400	`CONTROL_ITEM_GROUP_IS_NOT_FOUND`	Control item group cannot be found with the given: `{0}`.

update-control-item-group-map › path Parameters

id

string · uuid · required

controlItemGroupMapId

string · uuid · required

update-control-item-group-map › Request Body

condition

string · required

controlItemProcessOrder

integer · int32 · required

controlItemViewOrder

integer · int32 · required

effect

integer · enum · int32 · required

Permitted values (2):

1 — And
2 — Or

Enum values:

update-control-item-group-map › Responses

No data returned

delete-control-item-group-map

DELETE

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups/{id}/maps/{controlItemGroupMapId}

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_CUSEVL_13`	400	`CONTROL_ITEM_GROUP_MAP_IS_NOT_FOUND`	The record of the relationship is cannot be found with the given: `{0}`.
`ERR_CUSEVL_6`	400	`CONTROL_ITEM_GROUP_IS_NOT_FOUND`	Control item group cannot be found with the given: `{0}`.

delete-control-item-group-map › path Parameters

id

string · uuid · required

controlItemGroupMapId

string · uuid · required

delete-control-item-group-map › Responses

No data returned

compensating-transactions control-items

Customer Evaluation Service

control-item-groups

Operations addressed under /control-item-groups — 8 operations.

get-control-item-group-list

GET

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups

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<ControlItemGroupDto>.

Field	Declared type	Nullable
`Name`	`string`	no
`Description`	`string`	no
`IsActive`	`bool`	no
`ControlItems`	`List<ControlItemGroupMapDto>` (collection)	no

Member names are the service's declaration names.

get-control-item-group-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-control-item-group-list › Responses

object[]

Array of catalog-declared response records.

object[]

description

string

id

string · uuid

isActive

boolean

name

string

create-control-item-group

POST

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups

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

Response body, read from the service source

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_CUSEVL_2`	400	`CONTROL_ITEM_IS_NOT_FOUND`	Control item is cannot be found with the given id: `{0}`.
`ERR_CUSEVL_3`	400	`CONTROL_ITEM_GROUP_NAME_MUST_BE_UNIQUE`	Control item group name should be unique.
`ERR_CUSEVL_4`	400	`CONTROL_ITEM_GROUP_EFFECT_MUST_CONTAIN_AT_LEAST_ONE_AND`	The effect value of at least one control item in a control group must be and.
`ERR_CUSEVL_5`	400	`CONTROL_ITEM_GROUP_CAN_NOT_CONTAIN_PASSIVE_CONTROL_ITEM`	Control item that is in passive status cannot be included in the control item group. : `{0}`.
`ERR_CUSEVL_7`	400	`CONTROL_ITEM_GROUP_CAN_NOT_CONTAIN_DUPLICATE_CONTROL_ITEM`	The same control item cannot be added to a group more than once.

create-control-item-group › Request Body

object[] · required

description

string · required

name

string · required

create-control-item-group › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

POST/control-item-groups

curl https://dg-sandbox.dgpays.com/customer-evaluation-service/control-item-groups \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "controlItems": [
    {
      "condition": "",
      "controlItemId": "",
      "effect": 0,
      "processOrder": 0,
      "viewOrder": 0
    }
  ],
  "description": "",
  "name": ""
}'

Example Request Body

{
  "controlItems": [
    {
      "condition": "",
      "controlItemId": "",
      "effect": 0,
      "processOrder": 0,
      "viewOrder": 0
    }
  ],
  "description": "",
  "name": ""
}

json

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

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

application/json

get-control-item-group-by-id

GET

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups/{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 ControlItemGroupDto.

Field	Declared type	Nullable
`Name`	`string`	no
`Description`	`string`	no
`IsActive`	`bool`	no
`ControlItems`	`List<ControlItemGroupMapDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CUSEVL_6`	400	`CONTROL_ITEM_GROUP_IS_NOT_FOUND`	Control item group cannot be found with the given: `{0}`.

get-control-item-group-by-id › path Parameters

id

string · uuid · required

get-control-item-group-by-id › Responses

object[]

description

string

id

string · uuid

isActive

boolean

name

string

update-control-item-group

PUT

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups/{id}

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_CUSEVL_3`	400	`CONTROL_ITEM_GROUP_NAME_MUST_BE_UNIQUE`	Control item group name should be unique.
`ERR_CUSEVL_6`	400	`CONTROL_ITEM_GROUP_IS_NOT_FOUND`	Control item group cannot be found with the given: `{0}`.

update-control-item-group › path Parameters

id

string · uuid · required

update-control-item-group › Request Body

description

string · required

isActive

boolean · required

name

string · required

update-control-item-group › Responses

No data returned

delete-control-item-group

DELETE

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups/{id}

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_CUSEVL_6`	400	`CONTROL_ITEM_GROUP_IS_NOT_FOUND`	Control item group cannot be found with the given: `{0}`.

delete-control-item-group › path Parameters

id

string · uuid · required

delete-control-item-group › Responses

No data returned

create-control-item-group-map

POST

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups/{id}/maps

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 AuraCommandDto.

Field	Declared type	Nullable
`Id`	`Guid`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CUSEVL_2`	400	`CONTROL_ITEM_IS_NOT_FOUND`	Control item is cannot be found with the given id: `{0}`.
`ERR_CUSEVL_5`	400	`CONTROL_ITEM_GROUP_CAN_NOT_CONTAIN_PASSIVE_CONTROL_ITEM`	Control item that is in passive status cannot be included in the control item group. : `{0}`.
`ERR_CUSEVL_6`	400	`CONTROL_ITEM_GROUP_IS_NOT_FOUND`	Control item group cannot be found with the given: `{0}`.
`ERR_CUSEVL_7`	400	`CONTROL_ITEM_GROUP_CAN_NOT_CONTAIN_DUPLICATE_CONTROL_ITEM`	The same control item cannot be added to a group more than once.

create-control-item-group-map › path Parameters

id

string · uuid · required

create-control-item-group-map › Request Body

condition

string · required

controlItemId

string · uuid · required

controlItemProcessOrder

integer · int32 · required

controlItemViewOrder

integer · int32 · required

effectType

integer · enum · int32 · required

Permitted values (2):

1 — And
2 — Or

Enum values:

create-control-item-group-map › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

update-control-item-group-map

PUT

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups/{id}/maps/{controlItemGroupMapId}

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_CUSEVL_13`	400	`CONTROL_ITEM_GROUP_MAP_IS_NOT_FOUND`	The record of the relationship is cannot be found with the given: `{0}`.
`ERR_CUSEVL_4`	400	`CONTROL_ITEM_GROUP_EFFECT_MUST_CONTAIN_AT_LEAST_ONE_AND`	The effect value of at least one control item in a control group must be and.
`ERR_CUSEVL_6`	400	`CONTROL_ITEM_GROUP_IS_NOT_FOUND`	Control item group cannot be found with the given: `{0}`.

update-control-item-group-map › path Parameters

id

string · uuid · required

controlItemGroupMapId

string · uuid · required

update-control-item-group-map › Request Body

condition

string · required

controlItemProcessOrder

integer · int32 · required

controlItemViewOrder

integer · int32 · required

effect

integer · enum · int32 · required

Permitted values (2):

1 — And
2 — Or

Enum values:

update-control-item-group-map › Responses

No data returned

delete-control-item-group-map

DELETE

https://dg-sandbox.dgpays.com/customer-evaluation-service

/control-item-groups/{id}/maps/{controlItemGroupMapId}

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_CUSEVL_13`	400	`CONTROL_ITEM_GROUP_MAP_IS_NOT_FOUND`	The record of the relationship is cannot be found with the given: `{0}`.
`ERR_CUSEVL_6`	400	`CONTROL_ITEM_GROUP_IS_NOT_FOUND`	Control item group cannot be found with the given: `{0}`.

delete-control-item-group-map › path Parameters

id

string · uuid · required

controlItemGroupMapId

string · uuid · required

delete-control-item-group-map › Responses

No data returned

compensating-transactions control-items