control-views

Operations addressed under /control-views — 8 operations.

get-control-view-list

GET

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

/control-views

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Name`	`string`	no
`Description`	`string`	no
`IsActive`	`bool`	no
`ControlItemGroups`	`IEnumerable<ControlViewMapDto>` (collection)	no

Member names are the service's declaration names.

get-control-view-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-control-view-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

id

string · uuid

isActive

boolean

name

string

create-control-view

POST

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

/control-views

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_10`	400	`THE_SAME_CONTROL_ITEM_GROUP_CANNOT_BE_ADDED_TO_CONTROL_GROUP_MORE_THAN_ONCE`	The same control item group cannot be added to a control view more than once.
`ERR_CUSEVL_6`	400	`CONTROL_ITEM_GROUP_IS_NOT_FOUND`	Control item group cannot be found with the given: `{0}`.
`ERR_CUSEVL_8`	400	`CONTROL_GROUP_NAME_SHOULD_BE_UNIQUE`	Control view name should be unique.
`ERR_CUSEVL_9`	400	`CONTROL_ITEM_GROUP_THAT_IS_IN_PASSIVE_STATUS_CANNOT_BE_INCLUDED_IN_THE_CONTROL_VIEW`	Control item group that is in passive status cannot be included in the control view.

create-control-view › Request Body

object[] · required

description

string · required

name

string · required

create-control-view › Responses

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

No data returned

POST/control-views

curl https://dg-sandbox.dgpays.com/customer-evaluation-service/control-views \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "controlItemGroups": [
    {
      "controlItemGroupId": "",
      "controlItemGroupProcessOrder": 0,
      "controlItemGroupViewOrder": 0
    }
  ],
  "description": "",
  "name": ""
}'

Example Request Body

{
  "controlItemGroups": [
    {
      "controlItemGroupId": "",
      "controlItemGroupProcessOrder": 0,
      "controlItemGroupViewOrder": 0
    }
  ],
  "description": "",
  "name": ""
}

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

calculate-control-view

POST

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

/control-views/calculate

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

Field	Declared type	Nullable
`ControlViewName`	`string`	no
`ControlItemGroups`	`List<ControlItemGroupItem>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CUSEVL_11`	400	`CONTROL_VIEW_IS_NOT_FOUND`	Control view is cannot be found with the given: `{0}`.
`ERR_CUSEVL_16`	400	`CONTROL_VIEW_RELATED_ITEM_GROUP_MAP_IS_NOT_FOUND`	Query process failed because a control item group defined within the control view could not be found.
`ERR_CUSEVL_17`	400	`QUERY_PARAMETER_TYPE_VALUE_MISMATCH`	not published in this snapshot

calculate-control-view › Request Body

controlViewId

string · uuid · required

object[] · required

calculate-control-view › Responses

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

No data returned

get-control-view-by-id

GET

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

/control-views/{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 ControlViewDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Name`	`string`	no
`Description`	`string`	no
`IsActive`	`bool`	no
`ControlItemGroups`	`IEnumerable<ControlViewMapDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CUSEVL_11`	400	`CONTROL_VIEW_IS_NOT_FOUND`	Control view is cannot be found with the given: `{0}`.

get-control-view-by-id › path Parameters

id

string · uuid · required

get-control-view-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-view

PUT

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

/control-views/{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_11`	400	`CONTROL_VIEW_IS_NOT_FOUND`	Control view is cannot be found with the given: `{0}`.
`ERR_CUSEVL_8`	400	`CONTROL_GROUP_NAME_SHOULD_BE_UNIQUE`	Control view name should be unique.

update-control-view › path Parameters

id

string · uuid · required

update-control-view › Request Body

description

string · required

isActive

boolean · required

name

string · required

update-control-view › 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-view

DELETE

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

/control-views/{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_11`	400	`CONTROL_VIEW_IS_NOT_FOUND`	Control view is cannot be found with the given: `{0}`.

delete-control-view › path Parameters

id

string · uuid · required

delete-control-view › Responses

No data returned

delete-control-view-map

DELETE

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

/control-views/{id}/control-view-maps/{controlViewMapId}

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_11`	400	`CONTROL_VIEW_IS_NOT_FOUND`	Control view is cannot be found with the given: `{0}`.
`ERR_CUSEVL_14`	400	`CONTROL_VIEW_MAP_IS_NOT_FOUND`	The record of the relationship is cannot be found with the given: `{0}`.

delete-control-view-map › path Parameters

id

string · uuid · required

controlViewMapId

string · uuid · required

delete-control-view-map › Responses

No data returned

create-control-view-map

POST

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

/control-views/{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_10`	400	`THE_SAME_CONTROL_ITEM_GROUP_CANNOT_BE_ADDED_TO_CONTROL_GROUP_MORE_THAN_ONCE`	The same control item group cannot be added to a control view more than once.
`ERR_CUSEVL_11`	400	`CONTROL_VIEW_IS_NOT_FOUND`	Control view 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}`.
`ERR_CUSEVL_9`	400	`CONTROL_ITEM_GROUP_THAT_IS_IN_PASSIVE_STATUS_CANNOT_BE_INCLUDED_IN_THE_CONTROL_VIEW`	Control item group that is in passive status cannot be included in the control view.

create-control-view-map › path Parameters

id

string · uuid · required

create-control-view-map › Request Body

controlItemGroupId

string · uuid · required

controlItemGroupProcessOrder

integer · int32 · required

controlItemGroupViewOrder

integer · int32 · required

create-control-view-map › Responses

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

No data returned

control-items data-migrations

Customer Evaluation Service

control-views

Operations addressed under /control-views — 8 operations.

get-control-view-list

GET

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

/control-views

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Name`	`string`	no
`Description`	`string`	no
`IsActive`	`bool`	no
`ControlItemGroups`	`IEnumerable<ControlViewMapDto>` (collection)	no

Member names are the service's declaration names.

get-control-view-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-control-view-list › Responses

object[]

Array of catalog-declared response records.

object[]

description

id

string · uuid

isActive

boolean

name

string

create-control-view

POST

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

/control-views

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_10`	400	`THE_SAME_CONTROL_ITEM_GROUP_CANNOT_BE_ADDED_TO_CONTROL_GROUP_MORE_THAN_ONCE`	The same control item group cannot be added to a control view more than once.
`ERR_CUSEVL_6`	400	`CONTROL_ITEM_GROUP_IS_NOT_FOUND`	Control item group cannot be found with the given: `{0}`.
`ERR_CUSEVL_8`	400	`CONTROL_GROUP_NAME_SHOULD_BE_UNIQUE`	Control view name should be unique.
`ERR_CUSEVL_9`	400	`CONTROL_ITEM_GROUP_THAT_IS_IN_PASSIVE_STATUS_CANNOT_BE_INCLUDED_IN_THE_CONTROL_VIEW`	Control item group that is in passive status cannot be included in the control view.

create-control-view › Request Body

object[] · required

description

string · required

name

string · required

create-control-view › Responses

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

No data returned

POST/control-views

curl https://dg-sandbox.dgpays.com/customer-evaluation-service/control-views \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "controlItemGroups": [
    {
      "controlItemGroupId": "",
      "controlItemGroupProcessOrder": 0,
      "controlItemGroupViewOrder": 0
    }
  ],
  "description": "",
  "name": ""
}'

Example Request Body

{
  "controlItemGroups": [
    {
      "controlItemGroupId": "",
      "controlItemGroupProcessOrder": 0,
      "controlItemGroupViewOrder": 0
    }
  ],
  "description": "",
  "name": ""
}

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

calculate-control-view

POST

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

/control-views/calculate

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

Field	Declared type	Nullable
`ControlViewName`	`string`	no
`ControlItemGroups`	`List<ControlItemGroupItem>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CUSEVL_11`	400	`CONTROL_VIEW_IS_NOT_FOUND`	Control view is cannot be found with the given: `{0}`.
`ERR_CUSEVL_16`	400	`CONTROL_VIEW_RELATED_ITEM_GROUP_MAP_IS_NOT_FOUND`	Query process failed because a control item group defined within the control view could not be found.
`ERR_CUSEVL_17`	400	`QUERY_PARAMETER_TYPE_VALUE_MISMATCH`	not published in this snapshot

calculate-control-view › Request Body

controlViewId

string · uuid · required

object[] · required

calculate-control-view › Responses

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

No data returned

get-control-view-by-id

GET

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

/control-views/{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 ControlViewDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Name`	`string`	no
`Description`	`string`	no
`IsActive`	`bool`	no
`ControlItemGroups`	`IEnumerable<ControlViewMapDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CUSEVL_11`	400	`CONTROL_VIEW_IS_NOT_FOUND`	Control view is cannot be found with the given: `{0}`.

get-control-view-by-id › path Parameters

id

string · uuid · required

get-control-view-by-id › Responses

object[]

description

string

id

string · uuid

isActive

boolean

name

string

update-control-view

PUT

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

/control-views/{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_11`	400	`CONTROL_VIEW_IS_NOT_FOUND`	Control view is cannot be found with the given: `{0}`.
`ERR_CUSEVL_8`	400	`CONTROL_GROUP_NAME_SHOULD_BE_UNIQUE`	Control view name should be unique.

update-control-view › path Parameters

id

string · uuid · required

update-control-view › Request Body

description

string · required

isActive

boolean · required

name

string · required

update-control-view › Responses

No data returned

delete-control-view

DELETE

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

/control-views/{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_11`	400	`CONTROL_VIEW_IS_NOT_FOUND`	Control view is cannot be found with the given: `{0}`.

delete-control-view › path Parameters

id

string · uuid · required

delete-control-view › Responses

No data returned

delete-control-view-map

DELETE

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

/control-views/{id}/control-view-maps/{controlViewMapId}

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_11`	400	`CONTROL_VIEW_IS_NOT_FOUND`	Control view is cannot be found with the given: `{0}`.
`ERR_CUSEVL_14`	400	`CONTROL_VIEW_MAP_IS_NOT_FOUND`	The record of the relationship is cannot be found with the given: `{0}`.

delete-control-view-map › path Parameters

id

string · uuid · required

controlViewMapId

string · uuid · required

delete-control-view-map › Responses

No data returned

create-control-view-map

POST

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

/control-views/{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_10`	400	`THE_SAME_CONTROL_ITEM_GROUP_CANNOT_BE_ADDED_TO_CONTROL_GROUP_MORE_THAN_ONCE`	The same control item group cannot be added to a control view more than once.
`ERR_CUSEVL_11`	400	`CONTROL_VIEW_IS_NOT_FOUND`	Control view 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}`.
`ERR_CUSEVL_9`	400	`CONTROL_ITEM_GROUP_THAT_IS_IN_PASSIVE_STATUS_CANNOT_BE_INCLUDED_IN_THE_CONTROL_VIEW`	Control item group that is in passive status cannot be included in the control view.

create-control-view-map › path Parameters

id

string · uuid · required

create-control-view-map › Request Body

controlItemGroupId

string · uuid · required

controlItemGroupProcessOrder

integer · int32 · required

controlItemGroupViewOrder

integer · int32 · required

create-control-view-map › Responses

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

No data returned

control-items data-migrations