services

Operations addressed under /services — 25 operations.

get-service-definition-list

GET

https://dg-sandbox.dgpays.com/core-service

/services

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Name`	`string`	no
`Code`	`string`	no
`HasFilter`	`bool`	no
`HasSharedCacheData`	`bool`	no
`HasPaging`	`bool`	no
`DefaultPagingSize`	`int?`	yes
`HasOrder`	`bool`	no
`DefaultOrderField`	`string`	no
`DefaultOrderType`	`int?`	yes
`IsCacheable`	`bool`	no
`CacheDuration`	`int?`	yes
`IsActive`	`bool`	no
`Path`	`string`	no
`DomainId`	`Guid`	no
`OperationType`	`int`	no
`Type`	`int`	no
`UsageType`	`int`	no
`Weight`	`double?`	yes
`BusinessWeight`	`double?`	yes
`HasBpmVariable`	`bool`	no
`ResponseFieldDefinitionId`	`Guid?`	yes
`RequestFieldId`	`Guid?`	yes
`IsTransactional`	`bool?`	yes
`IsRedirect`	`bool?`	yes
`RoutingServiceDefinitionId`	`Guid?`	yes
`FraudServiceDefinitionId`	`Guid?`	yes
`TimeoutDuration`	`long?`	yes
`IsLogDetailEnabled`	`bool`	no
`HasTranslationData`	`bool?`	yes
`RollbackServiceDefinitionId`	`Guid?`	yes
`RollbackEventDefinitionId`	`Guid?`	yes
`KeywordIdList`	`IEnumerable<Guid>` (collection)	no
`Translations`	`IEnumerable<ServiceDefinitionTranslationDto>` (collection)	no

Member names are the service's declaration names.

get-service-definition-list › query Parameters

object

keywordIdList

string[]

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-service-definition-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.

businessWeight

number

cacheDuration

integer · int32

code

string

defaultOrderField

string

defaultOrderType

integer · int32

Permitted values — validated against the order_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Asc`	en: Asc · tr: Asc · ar: تصاعدي
`2`	`Desc`	en: Desc · tr: Desc · ar: وصف

defaultPagingSize

integer · int32

domainId

string · uuid

fraudServiceDefinitionId

string · uuid

hasBpmVariable

boolean

hasFilter

boolean

hasOrder

boolean

hasPaging

boolean

hasSharedCacheData

boolean

hasTranslationData

boolean

id

string · uuid

isActive

boolean

isCacheable

boolean

isLogDetailEnabled

boolean

isRedirect

boolean

isTransactional

boolean

keywordIdList

string[]

name

string

operationType

integer · int32

Permitted values — validated against the operation_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`GET`	no label seeded
`2`	`POST`	no label seeded
`3`	`PUT`	no label seeded
`4`	`DELETE`	no label seeded
`5`	`PATCH`	no label seeded

path

string

requestFieldId

string · uuid

responseFieldId

string · uuid

rollbackEventDefinitionId

string · uuid

rollbackServiceDefinitionId

string · uuid

routingServiceDefinitionId

string · uuid

timeoutDuration

integer · int64

object[]

type

integer · int32

usageType

integer · int32

Permitted values — validated against the usage_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Service`	no label seeded
`2`	`BPM`	no label seeded
`3`	`Formula`	en: Formula · tr: Formül · ar: صيغة
`4`	`Rule`	en: Rule · tr: Kural · ar: قاعدة
`5`	`DistributedQuery`	en: Distributed Query · ar: استعلام موزع
`6`	`Keycloak`	en: Keycloak · ar: كيكلوك
`7`	`Camunda`	en: Camunda · ar: كاموندا
`8`	`TaskList`	en: Keylocak BPM Process · ar: عملية إدارة عمليات Keylocak BPM
`9`	`Partner`	en: Partner · ar: شريك
`10`	`BFF`	en: BFF · ar: أفضل صديق إلى الأبد
`11`	`Fraud`	en: Fraud · ar: الاحتيال

weight

number

GET/services

curl https://dg-sandbox.dgpays.com/core-service/services

Example Responses

[
  {
    "businessWeight": 0,
    "cacheDuration": 0,
    "code": "code",
    "defaultOrderField": "defaultOrderField",
    "defaultOrderType": 0,
    "defaultPagingSize": 0,
    "domainId": "00000000-0000-0000-0000-000000000000",
    "fraudServiceDefinitionId": "00000000-0000-0000-0000-000000000000",
    "hasBpmVariable": true,
    "hasFilter": true,
    "hasOrder": true,
    "hasPaging": true,
    "hasSharedCacheData": true,
    "hasTranslationData": true,
    "id": "00000000-0000-0000-0000-000000000000",
    "isActive": true,
    "isCacheable": true,
    "isLogDetailEnabled": true,
    "isRedirect": true,
    "isTransactional": true,
    "keywordIdList": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "name": "name",
    "operationType": 0,
    "path": "path",
    "requestFieldId": "00000000-0000-0000-0000-000000000000",
    "responseFieldId": "00000000-0000-0000-0000-000000000000",
    "rollbackEventDefinitionId": "00000000-0000-0000-0000-000000000000",
    "rollbackServiceDefinitionId": "00000000-0000-0000-0000-000000000000",
    "routingServiceDefinitionId": "00000000-0000-0000-0000-000000000000",
    "timeoutDuration": 0,
    "translations": [
      {
        "languageCode": "languageCode",
        "name": "name"
      }
    ],
    "type": 0,
    "usageType": 0,
    "weight": 0
  }
]

json

application/json

create-service-definition

POST

https://dg-sandbox.dgpays.com/core-service

/services

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_CORE_132`	400	`SERVICE_PARAMETERS_IS_NOT_UNIQUE`	Tenant Service parameters is not unique. [Path:`{0}`, Domain Id:`{1}`, Operation Type:`{2}`, Tenant Id:`{3}`]
`ERR_CORE_35`	400	`THERE_IS_ALREADY_SERVICE_WITH_THIS_CODE`	There is already a service with this code.

create-service-definition › Request Body

code

string · required

domainId

string · uuid · required

hasFilter

boolean · required

hasOrder

boolean · required

hasPaging

boolean · required

isActive

boolean · required

isLogDetailEnabled

boolean · required

operationType

integer · int32 · required

Permitted values — validated against the operation_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`GET`	no label seeded
`2`	`POST`	no label seeded
`3`	`PUT`	no label seeded
`4`	`DELETE`	no label seeded
`5`	`PATCH`	no label seeded

object[] · required

type

integer · int32 · required

urlPath

string · required

usageType

integer · int32 · required

Permitted values — validated against the usage_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Service`	no label seeded
`2`	`BPM`	no label seeded
`3`	`Formula`	en: Formula · tr: Formül · ar: صيغة
`4`	`Rule`	en: Rule · tr: Kural · ar: قاعدة
`5`	`DistributedQuery`	en: Distributed Query · ar: استعلام موزع
`6`	`Keycloak`	en: Keycloak · ar: كيكلوك
`7`	`Camunda`	en: Camunda · ar: كاموندا
`8`	`TaskList`	en: Keylocak BPM Process · ar: عملية إدارة عمليات Keylocak BPM
`9`	`Partner`	en: Partner · ar: شريك
`10`	`BFF`	en: BFF · ar: أفضل صديق إلى الأبد
`11`	`Fraud`	en: Fraud · ar: الاحتيال

businessWeight

number

cacheDuration

integer · int32

defaultOrderField

string

defaultOrderType

integer · int32

Permitted values — validated against the order_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Asc`	en: Asc · tr: Asc · ar: تصاعدي
`2`	`Desc`	en: Desc · tr: Desc · ar: وصف

defaultPagingSize

integer · int32

fraudServiceDefinitionId

string · uuid

hasBpmVariable

boolean

hasSharedCacheData

boolean

hasTranslationData

boolean

isCacheable

boolean

isRedirect

boolean

isTransactional

boolean

requestFieldId

string · uuid

responseFieldId

string · uuid

rollbackEventDefinitionId

string · uuid

rollbackServiceDefinitionId

string · uuid

routingServiceDefinitionId

string · uuid

timeoutDuration

integer · int64

weight

number

create-service-definition › 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/services

curl https://dg-sandbox.dgpays.com/core-service/services \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "businessWeight": 0,
  "cacheDuration": 0,
  "code": "",
  "defaultOrderField": "",
  "defaultOrderType": 0,
  "defaultPagingSize": 0,
  "domainId": "",
  "fraudServiceDefinitionId": "",
  "hasBpmVariable": false,
  "hasFilter": false,
  "hasOrder": false,
  "hasPaging": false,
  "hasSharedCacheData": false,
  "hasTranslationData": false,
  "isActive": false,
  "isCacheable": false,
  "isLogDetailEnabled": false,
  "isRedirect": false,
  "isTransactional": false,
  "operationType": 0,
  "requestFieldId": "",
  "responseFieldId": "",
  "rollbackEventDefinitionId": "",
  "rollbackServiceDefinitionId": "",
  "routingServiceDefinitionId": "",
  "timeoutDuration": 0,
  "translations": [
    {
      "languageCode": "",
      "name": ""
    }
  ],
  "type": 0,
  "urlPath": "",
  "usageType": 0,
  "weight": 0
}'

Example Request Body

{
  "businessWeight": 0,
  "cacheDuration": 0,
  "code": "",
  "defaultOrderField": "",
  "defaultOrderType": 0,
  "defaultPagingSize": 0,
  "domainId": "",
  "fraudServiceDefinitionId": "",
  "hasBpmVariable": false,
  "hasFilter": false,
  "hasOrder": false,
  "hasPaging": false,
  "hasSharedCacheData": false,
  "hasTranslationData": false,
  "isActive": false,
  "isCacheable": false,
  "isLogDetailEnabled": false,
  "isRedirect": false,
  "isTransactional": false,
  "operationType": 0,
  "requestFieldId": "",
  "responseFieldId": "",
  "rollbackEventDefinitionId": "",
  "rollbackServiceDefinitionId": "",
  "routingServiceDefinitionId": "",
  "timeoutDuration": 0,
  "translations": [
    {
      "languageCode": "",
      "name": ""
    }
  ],
  "type": 0,
  "urlPath": "",
  "usageType": 0,
  "weight": 0
}

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-service-by-code

GET

https://dg-sandbox.dgpays.com/core-service

/services/by-code/{code}

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

get-service-by-code › path Parameters

code

string · required

get-service-by-code › 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.

code

string

id

string · uuid

name

string

object[]

GET/services/by-code/{code}

curl https://dg-sandbox.dgpays.com/core-service/services/by-code/:code

Example Responses

{
  "code": "code",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "tenantServices": [
    {
      "businessWeight": 0,
      "cacheDuration": 0,
      "defaultOrderField": "defaultOrderField",
      "defaultOrderType": 0,
      "defaultPagingSize": 0,
      "domainId": "00000000-0000-0000-0000-000000000000",
      "hasFilter": true,
      "hasOrder": true,
      "hasPaging": true,
      "hasRollback": true,
      "id": "id",
      "isActive": true,
      "isCacheable": true,
      "isTransactional": true,
      "keywordIdList": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "operationType": 0,
      "path": "path",
      "requestFieldDefinitionId": "00000000-0000-0000-0000-000000000000",
      "responseFieldDefinitionId": "00000000-0000-0000-0000-000000000000",
      "serviceDefinitionId": "00000000-0000-0000-0000-000000000000",
      "tenantId": "00000000-0000-0000-0000-000000000000",
      "type": 0,
      "usageType": 0,
      "weight": 0
    }
  ],
  "translations": [
    {
      "languageCode": "languageCode",
      "name": "name"
    }
  ]
}

json

application/json

get-service-definition-code-list

GET

https://dg-sandbox.dgpays.com/core-service

/services/codes

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 IEnumerable<string>, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON array of JSON strings. This is a complete answer read from the declaration, not a gap.

get-service-definition-code-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-service-definition-code-list › Responses

Success. The catalog declares no response fields for this operation. It returns a collection of records — but the record's fields are not declared.

No data returned

get-service-definition-detail-list

GET

https://dg-sandbox.dgpays.com/core-service

/services/details

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`DomainId`	`Guid`	no
`OperationType`	`int`	no
`UrlPath`	`string`	no
`UsageType`	`int`	no
`Type`	`int`	no
`HasFilter`	`bool`	no
`HasPaging`	`bool`	no
`DefaultPagingSize`	`int?`	yes
`HasOrder`	`bool`	no
`DefaultOrderField`	`string`	no
`DefaultOrderType`	`int?`	yes
`IsCacheable`	`bool`	no
`IsTransactional`	`bool?`	yes
`CacheDuration`	`int?`	yes
`HasSharedCacheData`	`bool`	no
`IsActive`	`bool`	no
`DaprAppId`	`string`	no
`DaprNamespace`	`string`	no
`Weight`	`decimal?`	yes
`BusinessWeight`	`decimal?`	yes
`HasBpmVariable`	`bool`	no
`Priority`	`int`	no
`HasCompensation`	`bool`	no
`IsRedirect`	`bool?`	yes
`RoutingServiceDefinitionId`	`Guid?`	yes
`RoutingServiceDefinitionCode`	`string`	no
`FraudServiceDefinitionId`	`Guid?`	yes
`FraudServiceDefinitionCode`	`string`	no
`TimeoutDuration`	`long?`	yes
`IsLogDetailEnabled`	`bool`	no
`HasTranslationData`	`bool?`	yes
`RollbackServiceDefinitionId`	`Guid?`	yes
`RollbackServiceDefinitionCode`	`string`	no
`RollbackEventDefinitionId`	`Guid?`	yes
`RequestFieldDetail`	`ServiceDefinitionRequestFieldDefinitionDetailDto`	no
`ResponseFieldDetail`	`ServiceDefinitionResponseFieldDefinitionDetailDto`	no
`Requests`	`IEnumerable<ServiceDefinitionRequestDetailDto>` (collection)	no
`Responses`	`IEnumerable<ServiceDefinitionResponseDetailDto>` (collection)	no
`ValidationDetails`	`IEnumerable<ServiceDefinitionValidationDetailDto>` (collection)	no
`RefreshCacheMapDetails`	`IEnumerable<ServiceDefinitionRefreshCacheMapDetailDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status
`ERR000001`	400

get-service-definition-detail-list › query Parameters

code

string

daprAppId

string

hasRoutingService

boolean

operationType

integer · int32

Permitted values — validated against the operation_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`GET`	no label seeded
`2`	`POST`	no label seeded
`3`	`PUT`	no label seeded
`4`	`DELETE`	no label seeded
`5`	`PATCH`	no label seeded

urlPath

string

get-service-definition-detail-list › Responses

Success. An exact, uniquely bound route registration classifies this response as a collection.

No data returned

feed-service-catalog

POST

https://dg-sandbox.dgpays.com/core-service

/services/feed-catalog

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_CORE_110`	400	`SERVICE_CODE_IS_NOT_FOUND_WITH_SERVICE_CODE_TAG`	Service code cannot not be found: serviceCode: `{0}`
`ERR_CORE_24`	400	`CODE_FIELD_CANNOT_CONTAIN_SPACE`	Code field cannot contain space.
`ERR_CORE_86`	400	`NO_DOMAIN_FOUND_TO_FEED_CATALOG`	No record found for the code sent.

feed-service-catalog › Request Body

domainCode

string · required

serviceCodes

string[]

feed-service-catalog › 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

get-service-definition-by-id

GET

https://dg-sandbox.dgpays.com/core-service

/services/{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 ServiceDefinitionDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Name`	`string`	no
`Code`	`string`	no
`HasFilter`	`bool`	no
`HasSharedCacheData`	`bool`	no
`HasPaging`	`bool`	no
`DefaultPagingSize`	`int?`	yes
`HasOrder`	`bool`	no
`DefaultOrderField`	`string`	no
`DefaultOrderType`	`int?`	yes
`IsCacheable`	`bool`	no
`CacheDuration`	`int?`	yes
`IsActive`	`bool`	no
`Path`	`string`	no
`DomainId`	`Guid`	no
`OperationType`	`int`	no
`Type`	`int`	no
`UsageType`	`int`	no
`Weight`	`double?`	yes
`BusinessWeight`	`double?`	yes
`HasBpmVariable`	`bool`	no
`ResponseFieldDefinitionId`	`Guid?`	yes
`RequestFieldId`	`Guid?`	yes
`IsTransactional`	`bool?`	yes
`IsRedirect`	`bool?`	yes
`RoutingServiceDefinitionId`	`Guid?`	yes
`FraudServiceDefinitionId`	`Guid?`	yes
`TimeoutDuration`	`long?`	yes
`IsLogDetailEnabled`	`bool`	no
`HasTranslationData`	`bool?`	yes
`RollbackServiceDefinitionId`	`Guid?`	yes
`RollbackEventDefinitionId`	`Guid?`	yes
`KeywordIdList`	`IEnumerable<Guid>` (collection)	no
`Translations`	`IEnumerable<ServiceDefinitionTranslationDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.

get-service-definition-by-id › path Parameters

id

string · uuid · required

get-service-definition-by-id › Responses

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

No data returned

update-service-definition

PUT

https://dg-sandbox.dgpays.com/core-service

/services/{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_CORE_132`	400	`SERVICE_PARAMETERS_IS_NOT_UNIQUE`	Tenant Service parameters is not unique. [Path:`{0}`, Domain Id:`{1}`, Operation Type:`{2}`, Tenant Id:`{3}`]
`ERR_CORE_159`	400	`DEFINITION_USE_IN_FRAUD_DEFINITION_ID`	Fraud service definition is in use, usage type can not be changed
`ERR_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.

update-service-definition › path Parameters

id

string · uuid · required

update-service-definition › Request Body

domainId

string · uuid · required

hasFilter

boolean · required

hasOrder

boolean · required

hasPaging

boolean · required

isActive

boolean · required

isLogDetailEnabled

boolean · required

operationType

integer · int32 · required

Permitted values — validated against the operation_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`GET`	no label seeded
`2`	`POST`	no label seeded
`3`	`PUT`	no label seeded
`4`	`DELETE`	no label seeded
`5`	`PATCH`	no label seeded

object[] · required

type

integer · int32 · required

urlPath

string · required

usageType

integer · int32 · required

Permitted values — validated against the usage_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Service`	no label seeded
`2`	`BPM`	no label seeded
`3`	`Formula`	en: Formula · tr: Formül · ar: صيغة
`4`	`Rule`	en: Rule · tr: Kural · ar: قاعدة
`5`	`DistributedQuery`	en: Distributed Query · ar: استعلام موزع
`6`	`Keycloak`	en: Keycloak · ar: كيكلوك
`7`	`Camunda`	en: Camunda · ar: كاموندا
`8`	`TaskList`	en: Keylocak BPM Process · ar: عملية إدارة عمليات Keylocak BPM
`9`	`Partner`	en: Partner · ar: شريك
`10`	`BFF`	en: BFF · ar: أفضل صديق إلى الأبد
`11`	`Fraud`	en: Fraud · ar: الاحتيال

businessWeight

number

cacheDuration

integer · int32

defaultOrderField

string

defaultOrderType

integer · int32

Permitted values — validated against the order_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Asc`	en: Asc · tr: Asc · ar: تصاعدي
`2`	`Desc`	en: Desc · tr: Desc · ar: وصف

defaultPagingSize

integer · int32

fraudServiceDefinitionId

string · uuid

hasBpmVariable

boolean

hasSharedCacheData

boolean

hasTranslationData

boolean

isCacheable

boolean

isRedirect

boolean

isTransactional

boolean

requestFieldId

string · uuid

responseFieldId

string · uuid

rollbackEventDefinitionId

string · uuid

rollbackServiceDefinitionId

string · uuid

routingServiceDefinitionId

string · uuid

timeoutDuration

integer · int64

weight

number

update-service-definition › Responses

No data returned

PUT/services/{id}

curl https://dg-sandbox.dgpays.com/core-service/services/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "businessWeight": 0,
  "cacheDuration": 0,
  "defaultOrderField": "",
  "defaultOrderType": 0,
  "defaultPagingSize": 0,
  "domainId": "",
  "fraudServiceDefinitionId": "",
  "hasBpmVariable": false,
  "hasFilter": false,
  "hasOrder": false,
  "hasPaging": false,
  "hasSharedCacheData": false,
  "hasTranslationData": false,
  "isActive": false,
  "isCacheable": false,
  "isLogDetailEnabled": false,
  "isRedirect": false,
  "isTransactional": false,
  "operationType": 0,
  "requestFieldId": "",
  "responseFieldId": "",
  "rollbackEventDefinitionId": "",
  "rollbackServiceDefinitionId": "",
  "routingServiceDefinitionId": "",
  "timeoutDuration": 0,
  "translations": [
    {
      "languageCode": "",
      "name": ""
    }
  ],
  "type": 0,
  "urlPath": "",
  "usageType": 0,
  "weight": 0
}'

Example Request Body

{
  "businessWeight": 0,
  "cacheDuration": 0,
  "defaultOrderField": "",
  "defaultOrderType": 0,
  "defaultPagingSize": 0,
  "domainId": "",
  "fraudServiceDefinitionId": "",
  "hasBpmVariable": false,
  "hasFilter": false,
  "hasOrder": false,
  "hasPaging": false,
  "hasSharedCacheData": false,
  "hasTranslationData": false,
  "isActive": false,
  "isCacheable": false,
  "isLogDetailEnabled": false,
  "isRedirect": false,
  "isTransactional": false,
  "operationType": 0,
  "requestFieldId": "",
  "responseFieldId": "",
  "rollbackEventDefinitionId": "",
  "rollbackServiceDefinitionId": "",
  "routingServiceDefinitionId": "",
  "timeoutDuration": 0,
  "translations": [
    {
      "languageCode": "",
      "name": ""
    }
  ],
  "type": 0,
  "urlPath": "",
  "usageType": 0,
  "weight": 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

delete-service-definition

DELETE

https://dg-sandbox.dgpays.com/core-service

/services/{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_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.

delete-service-definition › path Parameters

id

string · uuid · required

delete-service-definition › Responses

No data returned

get-service-definition-refresh-cache-map-list

GET

https://dg-sandbox.dgpays.com/core-service

/services/{id}/refresh-cache-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 IEnumerable<ServiceDefinitionRefreshCacheMapDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`SourceServiceId`	`Guid`	no
`TargetServiceId`	`Guid`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.

get-service-definition-refresh-cache-map-list › path Parameters

id

string · uuid · required

get-service-definition-refresh-cache-map-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-service-definition-refresh-cache-map-list › Responses

object[]

Array of catalog-declared response records.

id

string · uuid

sourceServiceId

string · uuid

targetServiceId

string · uuid

create-service-definition-refresh-cache-map

POST

https://dg-sandbox.dgpays.com/core-service

/services/{id}/refresh-cache-maps

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

Invokes the create-service-definition-refresh-cache-map service definition through POST /services/{id}/refresh-cache-maps.

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_CORE_126`	400	`REFRESH_CACHE_MAP_WITH_THIS_SOURCE_AND_TARGET_SERVICE_DEFINITION_ALREADY_EXISTS`	There is already a refresh cache map with this source and target services.
`ERR_CORE_128`	400	`CANNOT_DEFINE_SOURCE_SERVICE_DEFINITION_ID_AS_TARGET_SERVICE_DEFINITION_ID`	Cannot define source service definition as target service definition.
`ERR_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.

create-service-definition-refresh-cache-map › path Parameters

id

string · uuid · required

create-service-definition-refresh-cache-map › Request Body

targetServiceId

string · uuid · required

create-service-definition-refresh-cache-map › 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.

update-service-definition-refresh-cache-map

PUT

https://dg-sandbox.dgpays.com/core-service

/services/{id}/refresh-cache-maps/{serviceRefreshCacheMapId}

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

Invokes the update-service-definition-refresh-cache-map service definition through PUT /services/{id}/refresh-cache-maps/{serviceRefreshCacheMapId}.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_126`	400	`REFRESH_CACHE_MAP_WITH_THIS_SOURCE_AND_TARGET_SERVICE_DEFINITION_ALREADY_EXISTS`	There is already a refresh cache map with this source and target services.
`ERR_CORE_127`	400	`REFRESH_CACHE_MAP_ID_NOT_FOUND`	Refresh cache map cannot not be found.
`ERR_CORE_128`	400	`CANNOT_DEFINE_SOURCE_SERVICE_DEFINITION_ID_AS_TARGET_SERVICE_DEFINITION_ID`	Cannot define source service definition as target service definition.
`ERR_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.

update-service-definition-refresh-cache-map › path Parameters

id

string · uuid · required

serviceRefreshCacheMapId

string · uuid · required

update-service-definition-refresh-cache-map › Request Body

targetServiceId

string · uuid · required

update-service-definition-refresh-cache-map › Responses

No data returned

delete-service-definition-refresh-cache-map

DELETE

https://dg-sandbox.dgpays.com/core-service

/services/{id}/refresh-cache-maps/{serviceRefreshCacheMapId}

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_CORE_127`	400	`REFRESH_CACHE_MAP_ID_NOT_FOUND`	Refresh cache map cannot not be found.
`ERR_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.

delete-service-definition-refresh-cache-map › path Parameters

id

string · uuid · required

serviceRefreshCacheMapId

string · uuid · required

delete-service-definition-refresh-cache-map › Responses

No data returned

get-service-definition-request-list

GET

https://dg-sandbox.dgpays.com/core-service

/services/{id}/requests

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`FieldId`	`Guid`	no
`Name`	`string`	no
`DefaultValue`	`string`	no
`Location`	`int`	no
`Necessity`	`int`	no
`ParentServiceRequestId`	`Guid?`	yes
`TransactionalFieldId`	`Guid?`	yes
`NecessityFormulaId`	`Guid?`	yes
`NecessityLocalizationCode`	`string`	no
`CustomName`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.

get-service-definition-request-list › path Parameters

id

string · uuid · required

get-service-definition-request-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-service-definition-request-list › Responses

object[]

Array of catalog-declared response records.

defaultValue

string

fieldId

string · uuid

id

string · uuid

location

integer · int32

Permitted values — validated against the binding_source parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Query`	no label seeded
`2`	`Route`	no label seeded
`3`	`Body`	no label seeded
`4`	`Form`	no label seeded
`5`	`Headers`	no label seeded
`6`	`Claim`	en: Claim · ar: مطالبة

name

string

necessity

integer · int32

necessityFormulaId

string · uuid

necessityLocalizationCode

string

parentServiceRequestId

string · uuid

transactionalFieldId

string · uuid

create-service-definition-request

POST

https://dg-sandbox.dgpays.com/core-service

/services/{id}/requests

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_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.
`ERR_CORE_66`	400	`FIELD_ID_IS_NOT_FOUND`	Field cannot be found.

create-service-definition-request › path Parameters

id

string · uuid · required

create-service-definition-request › Request Body

fieldId

string · uuid · required

location

integer · int32 · required

Permitted values — validated against the binding_source parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Query`	no label seeded
`2`	`Route`	no label seeded
`3`	`Body`	no label seeded
`4`	`Form`	no label seeded
`5`	`Headers`	no label seeded
`6`	`Claim`	en: Claim · ar: مطالبة

name

string · required

customName

string

defaultValue

string

necessity

integer · int32

necessityFormulaId

string · uuid

necessityLocalizationCode

string

parentServiceRequestId

string · uuid

transactionalFieldId

string · uuid

create-service-definition-request › 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/services/{id}/requests

curl https://dg-sandbox.dgpays.com/core-service/services/:id/requests \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "customName": "",
  "defaultValue": "",
  "fieldId": "",
  "location": 0,
  "name": "",
  "necessity": 0,
  "necessityFormulaId": "",
  "necessityLocalizationCode": "",
  "parentServiceRequestId": "",
  "transactionalFieldId": ""
}'

Example Request Body

{
  "customName": "",
  "defaultValue": "",
  "fieldId": "",
  "location": 0,
  "name": "",
  "necessity": 0,
  "necessityFormulaId": "",
  "necessityLocalizationCode": "",
  "parentServiceRequestId": "",
  "transactionalFieldId": ""
}

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

update-service-definition-request

PUT

https://dg-sandbox.dgpays.com/core-service

/services/{id}/requests/{serviceRequestId}

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_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.
`ERR_CORE_52`	400	`PARENT_SERVICE_REQUEST_ID_IS_NOT_FOUND`	Parent Tenant Service Request cannot be cannot be found.
`ERR_CORE_66`	400	`FIELD_ID_IS_NOT_FOUND`	Field cannot be found.

update-service-definition-request › path Parameters

id

string · uuid · required

serviceRequestId

string · uuid · required

update-service-definition-request › Request Body

fieldId

string · uuid · required

customName

string

defaultValue

string

necessity

integer · int32

necessityFormulaId

string · uuid

necessityLocalizationCode

string

parentServiceRequestId

string · uuid

transactionalFieldId

string · uuid

update-service-definition-request › Responses

No data returned

PUT/services/{id}/requests/{serviceRequestId}

curl https://dg-sandbox.dgpays.com/core-service/services/:id/requests/:serviceRequestId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "customName": "",
  "defaultValue": "",
  "fieldId": "",
  "necessity": 0,
  "necessityFormulaId": "",
  "necessityLocalizationCode": "",
  "parentServiceRequestId": "",
  "transactionalFieldId": ""
}'

Example Request Body

{
  "customName": "",
  "defaultValue": "",
  "fieldId": "",
  "necessity": 0,
  "necessityFormulaId": "",
  "necessityLocalizationCode": "",
  "parentServiceRequestId": "",
  "transactionalFieldId": ""
}

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

delete-service-definition-request

DELETE

https://dg-sandbox.dgpays.com/core-service

/services/{id}/requests/{serviceRequestId}

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_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.
`ERR_CORE_55`	400	`THIS_RECORD_IS_DEFINED_AS_PARENT`	This record is defined as a parent.

delete-service-definition-request › path Parameters

id

string · uuid · required

serviceRequestId

string · uuid · required

delete-service-definition-request › Responses

No data returned

get-service-definition-response-list

GET

https://dg-sandbox.dgpays.com/core-service

/services/{id}/responses

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`FieldId`	`Guid`	no
`Name`	`string`	no
`ParentServiceResponseId`	`Guid?`	yes
`MaskFormatId`	`Guid?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.

get-service-definition-response-list › path Parameters

id

string · uuid · required

get-service-definition-response-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-service-definition-response-list › Responses

object[]

Array of catalog-declared response records.

fieldId

string · uuid

id

string · uuid

maskFormatId

string · uuid

name

string

parentServiceResponseId

string · uuid

create-service-definition-response

POST

https://dg-sandbox.dgpays.com/core-service

/services/{id}/responses

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_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.
`ERR_CORE_66`	400	`FIELD_ID_IS_NOT_FOUND`	Field cannot be found.

create-service-definition-response › path Parameters

id

string · uuid · required

create-service-definition-response › Request Body

fieldId

string · uuid · required

name

string · required

maskFormatId

string · uuid

parentServiceResponseId

string · uuid

create-service-definition-response › 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.

update-service-definition-response

PUT

https://dg-sandbox.dgpays.com/core-service

/services/{id}/responses/{serviceResponseId}

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_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.
`ERR_CORE_66`	400	`FIELD_ID_IS_NOT_FOUND`	Field cannot be found.

update-service-definition-response › path Parameters

id

string · uuid · required

serviceResponseId

string · uuid · required

update-service-definition-response › Request Body

fieldId

string · uuid · required

maskFormatId

string · uuid

parentServiceResponseId

string · uuid

update-service-definition-response › Responses

No data returned

delete-service-definition-response

DELETE

https://dg-sandbox.dgpays.com/core-service

/services/{id}/responses/{serviceResponseId}

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_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.
`ERR_CORE_55`	400	`THIS_RECORD_IS_DEFINED_AS_PARENT`	This record is defined as a parent.

delete-service-definition-response › path Parameters

id

string · uuid · required

serviceResponseId

string · uuid · required

delete-service-definition-response › Responses

No data returned

Validation

GET

https://dg-sandbox.dgpays.com/core-service

/services/{id}/validations

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

Invokes the get-service-definition-validation-list service definition through GET /services/{id}/validations.

Response body, read from the service source

The route declares its response as IEnumerable<ServiceDefinitionValidationDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`ServiceId`	`Guid`	no
`ValidationId`	`Guid`	no
`SortOrder`	`int`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.

Validation › path Parameters

id

string · uuid · required

Validation › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

Validation › Responses

Success. An exact, uniquely bound route registration classifies this response as a collection.

No data returned

create-service-definition-validation

POST

https://dg-sandbox.dgpays.com/core-service

/services/{id}/validations

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_CORE_102`	400	`VALIDATION_ID_NOT_FOUND`	Validation cannot be found.
`ERR_CORE_151`	400	`SORT_ORDER_MUST_BE_NON_NEGATIVE`	Sort Order cannot be negative
`ERR_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.

create-service-definition-validation › path Parameters

id

string · uuid · required

create-service-definition-validation › Request Body

sortOrder

number · required

validationId

string · uuid · required

create-service-definition-validation › 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.

update-service-definition-validation

PUT

https://dg-sandbox.dgpays.com/core-service

/services/{id}/validations/{serviceValidationId}

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_CORE_102`	400	`VALIDATION_ID_NOT_FOUND`	Validation cannot be found.
`ERR_CORE_151`	400	`SORT_ORDER_MUST_BE_NON_NEGATIVE`	Sort Order cannot be negative
`ERR_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.

update-service-definition-validation › path Parameters

id

string · uuid · required

serviceValidationId

string · uuid · required

update-service-definition-validation › Request Body

sortOrder

number · required

validationId

string · uuid · required

update-service-definition-validation › Responses

No data returned

delete-service-definition-validation

DELETE

https://dg-sandbox.dgpays.com/core-service

/services/{id}/validations/{serviceValidationId}

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_CORE_40`	400	`SERVICE_ID_IS_NOT_FOUND`	Service cannot be found.

delete-service-definition-validation › path Parameters

id

string · uuid · required

serviceValidationId

string · uuid · required

delete-service-definition-validation › Responses

No data returned

queries tenants