events

Operations addressed under /events — 15 operations.

get-event-definition-list

GET

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

/events

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`EventType`	`int?`	yes

Member names are the service's declaration names.

get-event-definition-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-event-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.

code

string

eventType

integer · int32

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

Value	Token	Labels
`1`	`boundary`	no label seeded
`2`	`intermediate`	no label seeded

id

string · uuid

name

string

create-event-definition

POST

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

/events

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_24`	400	`CODE_FIELD_CANNOT_CONTAIN_SPACE`	Code field cannot contain space.
`ERR_CORE_73`	400	`THERE_IS_ALREADY_EVENT_WITH_THIS_NAME`	There is already an event with this code

create-event-definition › Request Body

code

string · required

eventType

integer · int32 · required

Permitted values — validated against the event_type parameter.

Value	Meaning
`1`	boundary
`2`	intermediate

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

Value	Token	Labels
`1`	`boundary`	no label seeded
`2`	`intermediate`	no label seeded

name

string · required

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

id

string · uuid

get-event-definition-detail-by-code

GET

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

/events/by-code/{code}

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`EventType`	`int?`	yes
`EventRequests`	`IEnumerable<EventDefinitionRequestDetailDto>` (collection)	no

Member names are the service's declaration names.

get-event-definition-detail-by-code › path Parameters

code

string · required

get-event-definition-detail-by-code › Responses

code

string

object[]

eventType

integer · int32

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

Value	Token	Labels
`1`	`boundary`	no label seeded
`2`	`intermediate`	no label seeded

id

string · uuid

name

string

get-event-definition-detail-list

GET

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

/events/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<EventDefinitionDetailDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`EventType`	`int?`	yes
`EventRequests`	`IEnumerable<EventDefinitionRequestDetailDto>` (collection)	no

Member names are the service's declaration names.

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

object

get-event-definition-detail-list › Responses

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

No data returned

get-event-definition-by-id

GET

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

/events/{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 EventDefinitionDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`EventType`	`int?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_63`	400	`EVENT_ID_IS_NOT_FOUND`	Event cannot be found.

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

id

string · uuid · required

get-event-definition-by-id › Responses

code

string

eventType

integer · int32

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

Value	Token	Labels
`1`	`boundary`	no label seeded
`2`	`intermediate`	no label seeded

id

string · uuid

name

string

update-event-definition

PUT

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

/events/{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_63`	400	`EVENT_ID_IS_NOT_FOUND`	Event cannot be found.

update-event-definition › path Parameters

id

string · uuid · required

update-event-definition › Request Body

eventType

integer · int32 · required

Permitted values — validated against the event_type parameter.

Value	Meaning
`1`	boundary
`2`	intermediate

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

Value	Token	Labels
`1`	`boundary`	no label seeded
`2`	`intermediate`	no label seeded

name

string · required

update-event-definition › 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-event-definition

DELETE

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

/events/{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_63`	400	`EVENT_ID_IS_NOT_FOUND`	Event cannot be found.

delete-event-definition › path Parameters

id

string · uuid · required

delete-event-definition › Responses

No data returned

get-event-definition-request-list

GET

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

/events/{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<EventDefinitionRequestDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Name`	`string`	no
`DefaultValue`	`string`	no
`Necessity`	`int?`	yes
`Location`	`int?`	yes
`FieldId`	`Guid?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_63`	400	`EVENT_ID_IS_NOT_FOUND`	Event cannot be found.

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

id

string · uuid · required

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

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-event-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

create-event-definition-request

POST

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

/events/{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_63`	400	`EVENT_ID_IS_NOT_FOUND`	Event cannot be found.
`ERR_CORE_64`	400	`THERE_IS_ALREADY_EVENT_REQUEST_WITH_THIS_NAME`	There is already an event request with this name.
`ERR_CORE_65`	400	`NAME_FIELD_CANNOT_CONTAIN_SPACE`	Name field cannot contain space.
`ERR_CORE_66`	400	`FIELD_ID_IS_NOT_FOUND`	Field cannot be found.

create-event-definition-request › path Parameters

id

string · uuid · required

create-event-definition-request › Request Body

fieldId

string · uuid · required

location

integer · int32 · required

Permitted values — validated against the binding_source parameter.

Value	Meaning
`1`	Query
`2`	Route
`3`	Body
`4`	Form
`5`	Headers
`6`	Claim

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

necessity

integer · int32 · required

Permitted values — validated against the event_necessity parameter.

Value	Meaning
`1`	Mandatory
`2`	Optional

defaultValue

string

create-event-definition-request › Responses

id

string · uuid

update-event-definition-request

PUT

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

/events/{id}/requests/{eventRequestId}

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_63`	400	`EVENT_ID_IS_NOT_FOUND`	Event cannot be found.
`ERR_CORE_64`	400	`THERE_IS_ALREADY_EVENT_REQUEST_WITH_THIS_NAME`	There is already an event request with this name.
`ERR_CORE_65`	400	`NAME_FIELD_CANNOT_CONTAIN_SPACE`	Name field cannot contain space.
`ERR_CORE_66`	400	`FIELD_ID_IS_NOT_FOUND`	Field cannot be found.
`ERR_CORE_67`	400	`EVENT_REQUEST_ID_IS_NOT_FOUND`	Request cannot be found.

update-event-definition-request › path Parameters

id

string · uuid · required

eventRequestId

string · uuid · required

update-event-definition-request › Request Body

fieldId

string · uuid · required

location

integer · int32 · required

Permitted values — validated against the binding_source parameter.

Value	Meaning
`1`	Query
`2`	Route
`3`	Body
`4`	Form
`5`	Headers
`6`	Claim

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

necessity

integer · int32 · required

Permitted values — validated against the event_necessity parameter.

Value	Meaning
`1`	Mandatory
`2`	Optional

defaultValue

string

update-event-definition-request › Responses

No data returned

delete-event-definition-request

DELETE

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

/events/{id}/requests/{eventRequestId}

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_63`	400	`EVENT_ID_IS_NOT_FOUND`	Event cannot be found.
`ERR_CORE_67`	400	`EVENT_REQUEST_ID_IS_NOT_FOUND`	Request cannot be found.

delete-event-definition-request › path Parameters

id

string · uuid · required

eventRequestId

string · uuid · required

delete-event-definition-request › Responses

No data returned

get-event-definition-service-map-list

GET

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

/events/{id}/service-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<EventDefinitionServiceMapDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`ServiceId`	`Guid?`	yes
`IsActive`	`bool?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_63`	400	`EVENT_ID_IS_NOT_FOUND`	Event cannot be found.

get-event-definition-service-map-list › path Parameters

id

string · uuid · required

get-event-definition-service-map-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-event-definition-service-map-list › Responses

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

No data returned

create-event-definition-service-map

POST

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

/events/{id}/service-maps

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_63`	400	`EVENT_ID_IS_NOT_FOUND`	Event cannot be found.
`ERR_CORE_68`	400	`THERE_IS_ALREADY_RECORD_FOR_THIS_EVENT_AND_SERVICE`	There is already a record for this event and tenant.

create-event-definition-service-map › path Parameters

id

string · uuid · required

create-event-definition-service-map › Request Body

serviceId

string · uuid · required

create-event-definition-service-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-event-definition-service-map

PUT

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

/events/{id}/service-maps/{eventServiceMapId}

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_63`	400	`EVENT_ID_IS_NOT_FOUND`	Event cannot be found.
`ERR_CORE_69`	400	`EVENT_SERVICE_MAP_ID_IS_NOT_FOUND`	Event Tenant Service map cannot be found.

update-event-definition-service-map › path Parameters

id

string · uuid · required

eventServiceMapId

string · uuid · required

update-event-definition-service-map › Request Body

isActive

boolean · required

update-event-definition-service-map › Responses

No data returned

delete-event-definition-service-map

DELETE

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

/events/{id}/service-maps/{eventServiceMapId}

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_63`	400	`EVENT_ID_IS_NOT_FOUND`	Event cannot be found.
`ERR_CORE_69`	400	`EVENT_SERVICE_MAP_ID_IS_NOT_FOUND`	Event Tenant Service map cannot be found.

delete-event-definition-service-map › path Parameters

id

string · uuid · required

eventServiceMapId

string · uuid · required

delete-event-definition-service-map › Responses

No data returned

domains fields