notification-providers

Operations addressed under /notification-providers — 14 operations.

get-notification-provider-list

GET

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

/notification-providers

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

Field	Declared type	Nullable
`Provider`	`int`	no
`Type`	`int?`	yes
`ExternalServiceDefinitionId`	`Guid?`	yes
`IsDefault`	`bool`	no
`IsActive`	`bool`	no

Member names are the service's declaration names.

get-notification-provider-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-notification-provider-list › Responses

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

No data returned

create-notification-provider

POST

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

/notification-providers

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
`ERR_INTGRTN_42`	400	`NOTIFICATION_PROVIDER_ALSO_FOUND`

create-notification-provider › Request Body

externalServiceDefinitionId

string · uuid · required

provider

integer · int32 · required

type

integer · int32 · required

create-notification-provider › 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.

get-notification-mail-result-list

GET

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

/notification-providers/mail-results

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

Field	Declared type	Nullable
`MailNotificationDetailId`	`Guid?`	yes
`CorrelationId`	`Guid?`	yes
`IsSuccess`	`bool?`	yes
`DeliveryTime`	`DateTime?`	yes
`ErrorCode`	`string`	no
`ErrorMessage`	`string`	no

Member names are the service's declaration names.

get-notification-mail-result-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-notification-mail-result-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.

correlationId

string · uuid

deliveryTime

string · date-time

errorCode

string

errorMessage

string

id

string · uuid

isSuccess

boolean

mailNotificationDetailId

string · uuid

notificationProviderId

string · uuid

get-notification-provider-by-id

GET

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

/notification-providers/{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 NotificationProviderDto.

Field	Declared type	Nullable
`Provider`	`int`	no
`Type`	`int?`	yes
`ExternalServiceDefinitionId`	`Guid?`	yes
`IsDefault`	`bool`	no
`IsActive`	`bool`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_INTGRTN_43`	400	`NOTIFICATIONS_PROVIDER_NOT_FOUND`

get-notification-provider-by-id › path Parameters

id

string · uuid · required

get-notification-provider-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.

externalServiceDefinitionId

string · uuid

id

string · uuid

isActive

boolean

provider

integer · int32

type

integer · int32

update-notification-provider

PUT

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

/notification-providers/{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
`ERR_INTGRTN_42`	400	`NOTIFICATION_PROVIDER_ALSO_FOUND`
`ERR_INTGRTN_43`	400	`NOTIFICATIONS_PROVIDER_NOT_FOUND`

update-notification-provider › path Parameters

id

string · uuid · required

update-notification-provider › Request Body

externalServiceDefinitionId

string · uuid · required

isActive

boolean · required

provider

integer · int32 · required

type

integer · int32 · required

update-notification-provider › 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-notification-provider

DELETE

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

/notification-providers/{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
`ERR_INTGRTN_43`	400	`NOTIFICATIONS_PROVIDER_NOT_FOUND`

delete-notification-provider › path Parameters

id

string · uuid · required

delete-notification-provider › Responses

No data returned

create-notification-mail-result

POST

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

/notification-providers/{id}/mail-results

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
`ERR_INTGRTN_43`	400	`NOTIFICATIONS_PROVIDER_NOT_FOUND`

create-notification-mail-result › path Parameters

id

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

create-notification-mail-result › Request Body optional

correlationId

string · uuid

create-notification-mail-result › 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.

get-notification-mail-result-by-id

GET

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

/notification-providers/{id}/mail-results/{notificationMailResultId}

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

Field	Declared type	Nullable
`MailNotificationDetailId`	`Guid?`	yes
`CorrelationId`	`Guid?`	yes
`IsSuccess`	`bool?`	yes
`DeliveryTime`	`DateTime?`	yes
`ErrorCode`	`string`	no
`ErrorMessage`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_INTGRTN_43`	400	`NOTIFICATIONS_PROVIDER_NOT_FOUND`

get-notification-mail-result-by-id › path Parameters

id

string · uuid · required

notificationMailResultId

string · uuid · required

get-notification-mail-result-by-id › Responses

correlationId

string · uuid

deliveryTime

string · date-time

errorCode

string

errorMessage

string

id

string · uuid

isSuccess

boolean

mailNotificationDetailId

string · uuid

notificationProviderId

string · uuid

update-notification-mail-result

PUT

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

/notification-providers/{id}/mail-results/{notificationMailResultId}

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
`ERR_INTGRTN_43`	400	`NOTIFICATIONS_PROVIDER_NOT_FOUND`

update-notification-mail-result › path Parameters

id

string · uuid · required

notificationMailResultId

string · uuid · required

update-notification-mail-result › Request Body

deliveryTime

string · date-time · required

errorCode

string · required

errorMessage

string · required

isSuccess

boolean · required

mailNotificationDetailId

string · uuid · required

correlationId

string · uuid

update-notification-mail-result › Responses

No data returned

PUT/notification-providers/{id}/mail-results/{notificationMailResultId}

curl https://dg-sandbox.dgpays.com/integration-service/notification-providers/:id/mail-results/:notificationMailResultId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "correlationId": "",
  "deliveryTime": "",
  "errorCode": "",
  "errorMessage": "",
  "isSuccess": false,
  "mailNotificationDetailId": ""
}'

Example Request Body

{
  "correlationId": "",
  "deliveryTime": "",
  "errorCode": "",
  "errorMessage": "",
  "isSuccess": false,
  "mailNotificationDetailId": ""
}

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-notification-mail-result

DELETE

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

/notification-providers/{id}/mail-results/{notificationMailResultId}

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
`ERR_INTGRTN_43`	400	`NOTIFICATIONS_PROVIDER_NOT_FOUND`

delete-notification-mail-result › path Parameters

id

string · uuid · required

notificationMailResultId

string · uuid · required

delete-notification-mail-result › Responses

No data returned

create-notification-sms-result

POST

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

/notification-providers/{id}/sms-results

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
`ERR_INTGRTN_43`	400	`NOTIFICATIONS_PROVIDER_NOT_FOUND`

create-notification-sms-result › path Parameters

id

string · uuid · required

create-notification-sms-result › Request Body

deliveryTime

string · date-time · required

errorCode

string · required

errorMessage

string · required

isSuccess

boolean · required

smsNotificationDetailId

string · uuid · required

correlationId

string · uuid

create-notification-sms-result › 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.

get-notification-sms-result-by-id

GET

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

/notification-providers/{id}/sms-results/{notificationSmsResultId}

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

Field	Declared type	Nullable
`NotificationProviderId`	`Guid?`	yes
`SmsNotificationDetailId`	`Guid?`	yes
`CorrelationId`	`Guid?`	yes
`IsSuccess`	`bool?`	yes
`DeliveryTime`	`DateTime?`	yes
`ErrorCode`	`string`	no
`ErrorMessage`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_INTGRTN_43`	400	`NOTIFICATIONS_PROVIDER_NOT_FOUND`
`ERR_INTGRTN_44`	400	`SMS_NOTIFICATION_RESULT_NOT_FOUND`

get-notification-sms-result-by-id › path Parameters

id

string · uuid · required

notificationSmsResultId

string · uuid · required

get-notification-sms-result-by-id › Responses

correlationId

string · uuid

deliveryTime

string · date-time

errorCode

string

errorMessage

string

id

string · uuid

isSuccess

boolean

notificationProviderId

string · uuid

smsNotificationDetailId

string · uuid

update-notification-sms-result

PUT

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

/notification-providers/{id}/sms-results/{notificationSmsResultId}

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
`ERR_INTGRTN_43`	400	`NOTIFICATIONS_PROVIDER_NOT_FOUND`
`ERR_INTGRTN_44`	400	`SMS_NOTIFICATION_RESULT_NOT_FOUND`

update-notification-sms-result › path Parameters

id

string · uuid · required

notificationSmsResultId

string · uuid · required

update-notification-sms-result › Request Body

deliveryTime

string · date-time · required

errorCode

string · required

errorMessage

string · required

isSuccess

boolean · required

smsNotificationDetailId

string · uuid · required

correlationId

string · uuid

update-notification-sms-result › Responses

No data returned

PUT/notification-providers/{id}/sms-results/{notificationSmsResultId}

curl https://dg-sandbox.dgpays.com/integration-service/notification-providers/:id/sms-results/:notificationSmsResultId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "correlationId": "",
  "deliveryTime": "",
  "errorCode": "",
  "errorMessage": "",
  "isSuccess": false,
  "smsNotificationDetailId": ""
}'

Example Request Body

{
  "correlationId": "",
  "deliveryTime": "",
  "errorCode": "",
  "errorMessage": "",
  "isSuccess": false,
  "smsNotificationDetailId": ""
}

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-notification-sms-result

DELETE

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

/notification-providers/{id}/sms-results/{notificationSmsResultId}

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
`ERR_INTGRTN_43`	400	`NOTIFICATIONS_PROVIDER_NOT_FOUND`
`ERR_INTGRTN_44`	400	`SMS_NOTIFICATION_RESULT_NOT_FOUND`

delete-notification-sms-result › path Parameters

id

string · uuid · required

notificationSmsResultId

string · uuid · required

delete-notification-sms-result › Responses

No data returned

localizations parameters