channels

Operations addressed under /channels — 7 operations.

get-channel-definition-list

GET

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

/channels

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`ChannelName`	`string`	no
`ChannelType`	`int`	no
`ChannelDescription`	`string`	no
`ChannelDate`	`DateOnly`	no
`ClientId`	`string`	no
`IsShared`	`bool`	no
`HasPartner`	`bool`	no
`IsCustomDateEnabled`	`bool`	no

Member names are the service's declaration names.

get-channel-definition-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

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

channelDate

string · date

channelDescription

string

channelName

string

channelType

integer · int32

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

Value	Token	Labels
`1`	`Mobile`	en: Mobile Application · ar: تطبيق الجوال
`2`	`Web`	en: Web Browser · ar: متصفح الويب
`3`	`Integration`	en: Integration Service · ar: خدمة التكامل
`4`	`API`	en: API · ar: واجهة برمجة التطبيقات

clientId

string

hasPartner

boolean

id

string · uuid

isCustomDateEnabled

boolean

isShared

boolean

create-channel

POST

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

/channels

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_124`	400	`THERE_IS_ALREADY_A_CHANNEL_WITH_THIS_NAME`	There is already a channel with this name
`ERR_CORE_131`	400	`THERE_IS_ALREADY_A_CHANNEL_WITH_THIS_ID`	There is already a channel with this definition.

create-channel › Request Body

channelDate

string · date · required

channelName

string · required

channelType

integer · int32 · required

Permitted values — validated against the channel_type parameter.

Value	Meaning
`1`	Mobile Application
`2`	Web Browser
`3`	Integration Service
`4`	API

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

Value	Token	Labels
`1`	`Mobile`	en: Mobile Application · ar: تطبيق الجوال
`2`	`Web`	en: Web Browser · ar: متصفح الويب
`3`	`Integration`	en: Integration Service · ar: خدمة التكامل
`4`	`API`	en: API · ar: واجهة برمجة التطبيقات

clientId

string · required

hasPartner

boolean · required

id

string · uuid · required

isCustomDateEnabled

boolean · required

isShared

boolean · required

channelDescription

string

tenantId

string · uuid

create-channel › 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

POST/channels

curl https://dg-sandbox.dgpays.com/core-service/channels \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channelDate": "",
  "channelDescription": "",
  "channelName": "",
  "channelType": 0,
  "clientId": "",
  "hasPartner": false,
  "id": "",
  "isCustomDateEnabled": false,
  "isShared": false,
  "tenantId": ""
}'

Example Request Body

{
  "channelDate": "",
  "channelDescription": "",
  "channelName": "",
  "channelType": 0,
  "clientId": "",
  "hasPartner": false,
  "id": "",
  "isCustomDateEnabled": false,
  "isShared": false,
  "tenantId": ""
}

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

get-tenant-channel-by-client-id

GET

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

/channels/by-client-id/{clientId}

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`ChannelName`	`string`	no
`ChannelType`	`int`	no
`ChannelDescription`	`string`	no
`ChannelDate`	`DateOnly`	no
`ClientId`	`string`	no
`IsShared`	`bool`	no
`HasPartner`	`bool`	no
`IsCustomDateEnabled`	`bool`	no

Member names are the service's declaration names.

get-tenant-channel-by-client-id › path Parameters

clientId

string · required

get-tenant-channel-by-client-id › Responses

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

No data returned

set-tenant-channels-new-date

POST

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

/channels/set-new-date

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_150`	400	`CHANNELS_CANNOT_BE_EMPTY`	Channel cannot be left blank.

set-tenant-channels-new-date › Request Body optional

hasPartner

boolean

set-tenant-channels-new-date › Responses

No data returned

get-channel-definition-by-id

GET

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

/channels/{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 ChannelDefinitionDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`ChannelName`	`string`	no
`ChannelType`	`int`	no
`ChannelDescription`	`string`	no
`ChannelDate`	`DateOnly`	no
`ClientId`	`string`	no
`IsShared`	`bool`	no
`HasPartner`	`bool`	no
`IsCustomDateEnabled`	`bool`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_125`	400	`CHANNEL_ID_IS_NOT_FOUND`	Channel cannot be found.

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

id

string · uuid · required

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

channelDate

string · date

channelDescription

string

channelName

string

channelType

integer · int32

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

Value	Token	Labels
`1`	`Mobile`	en: Mobile Application · ar: تطبيق الجوال
`2`	`Web`	en: Web Browser · ar: متصفح الويب
`3`	`Integration`	en: Integration Service · ar: خدمة التكامل
`4`	`API`	en: API · ar: واجهة برمجة التطبيقات

clientId

string

hasPartner

boolean

id

string · uuid

isCustomDateEnabled

boolean

isShared

boolean

tenantId

string · uuid

update-channel

PUT

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

/channels/{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_125`	400	`CHANNEL_ID_IS_NOT_FOUND`	Channel cannot be found.

update-channel › path Parameters

id

string · uuid · required

update-channel › Request Body

channelDate

string · date · required

channelType

integer · int32 · required

Permitted values — validated against the channel_type parameter.

Value	Meaning
`1`	Mobile Application
`2`	Web Browser
`3`	Integration Service
`4`	API

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

Value	Token	Labels
`1`	`Mobile`	en: Mobile Application · ar: تطبيق الجوال
`2`	`Web`	en: Web Browser · ar: متصفح الويب
`3`	`Integration`	en: Integration Service · ar: خدمة التكامل
`4`	`API`	en: API · ar: واجهة برمجة التطبيقات

hasPartner

boolean · required

isCustomDateEnabled

boolean · required

isShared

boolean · required

channelDescription

string

update-channel › Responses

No data returned

delete-channel

DELETE

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

/channels/{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_125`	400	`CHANNEL_ID_IS_NOT_FOUND`	Channel cannot be found.

delete-channel › path Parameters

id

string · uuid · required

delete-channel › Responses

No data returned

caches clients

Core Service

channels

Operations addressed under /channels — 7 operations.

get-channel-definition-list

GET

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

/channels

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`ChannelName`	`string`	no
`ChannelType`	`int`	no
`ChannelDescription`	`string`	no
`ChannelDate`	`DateOnly`	no
`ClientId`	`string`	no
`IsShared`	`bool`	no
`HasPartner`	`bool`	no
`IsCustomDateEnabled`	`bool`	no

Member names are the service's declaration names.

get-channel-definition-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-channel-definition-list › Responses

object[]

Array of catalog-declared response records.

channelDate

string · date

channelDescription

string

channelName

string

channelType

integer · int32

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

Value	Token	Labels
`1`	`Mobile`	en: Mobile Application · ar: تطبيق الجوال
`2`	`Web`	en: Web Browser · ar: متصفح الويب
`3`	`Integration`	en: Integration Service · ar: خدمة التكامل
`4`	`API`	en: API · ar: واجهة برمجة التطبيقات

clientId

string

hasPartner

boolean

id

string · uuid

isCustomDateEnabled

boolean

isShared

boolean

create-channel

POST

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

/channels

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_124`	400	`THERE_IS_ALREADY_A_CHANNEL_WITH_THIS_NAME`	There is already a channel with this name
`ERR_CORE_131`	400	`THERE_IS_ALREADY_A_CHANNEL_WITH_THIS_ID`	There is already a channel with this definition.

create-channel › Request Body

channelDate

string · date · required

channelName

string · required

channelType

integer · int32 · required

Permitted values — validated against the channel_type parameter.

Value	Meaning
`1`	Mobile Application
`2`	Web Browser
`3`	Integration Service
`4`	API

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

Value	Token	Labels
`1`	`Mobile`	en: Mobile Application · ar: تطبيق الجوال
`2`	`Web`	en: Web Browser · ar: متصفح الويب
`3`	`Integration`	en: Integration Service · ar: خدمة التكامل
`4`	`API`	en: API · ar: واجهة برمجة التطبيقات

clientId

string · required

hasPartner

boolean · required

id

string · uuid · required

isCustomDateEnabled

boolean · required

isShared

boolean · required

channelDescription

string

tenantId

string · uuid

create-channel › Responses

No data returned

POST/channels

curl https://dg-sandbox.dgpays.com/core-service/channels \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channelDate": "",
  "channelDescription": "",
  "channelName": "",
  "channelType": 0,
  "clientId": "",
  "hasPartner": false,
  "id": "",
  "isCustomDateEnabled": false,
  "isShared": false,
  "tenantId": ""
}'

Example Request Body

{
  "channelDate": "",
  "channelDescription": "",
  "channelName": "",
  "channelType": 0,
  "clientId": "",
  "hasPartner": false,
  "id": "",
  "isCustomDateEnabled": false,
  "isShared": false,
  "tenantId": ""
}

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

get-tenant-channel-by-client-id

GET

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

/channels/by-client-id/{clientId}

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`ChannelName`	`string`	no
`ChannelType`	`int`	no
`ChannelDescription`	`string`	no
`ChannelDate`	`DateOnly`	no
`ClientId`	`string`	no
`IsShared`	`bool`	no
`HasPartner`	`bool`	no
`IsCustomDateEnabled`	`bool`	no

Member names are the service's declaration names.

get-tenant-channel-by-client-id › path Parameters

clientId

string · required

get-tenant-channel-by-client-id › Responses

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

No data returned

set-tenant-channels-new-date

POST

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

/channels/set-new-date

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_150`	400	`CHANNELS_CANNOT_BE_EMPTY`	Channel cannot be left blank.

set-tenant-channels-new-date › Request Body optional

hasPartner

boolean

set-tenant-channels-new-date › Responses

No data returned

get-channel-definition-by-id

GET

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

/channels/{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 ChannelDefinitionDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`ChannelName`	`string`	no
`ChannelType`	`int`	no
`ChannelDescription`	`string`	no
`ChannelDate`	`DateOnly`	no
`ClientId`	`string`	no
`IsShared`	`bool`	no
`HasPartner`	`bool`	no
`IsCustomDateEnabled`	`bool`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_CORE_125`	400	`CHANNEL_ID_IS_NOT_FOUND`	Channel cannot be found.

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

id

string · uuid · required

get-channel-definition-by-id › Responses

channelDate

string · date

channelDescription

string

channelName

string

channelType

integer · int32

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

Value	Token	Labels
`1`	`Mobile`	en: Mobile Application · ar: تطبيق الجوال
`2`	`Web`	en: Web Browser · ar: متصفح الويب
`3`	`Integration`	en: Integration Service · ar: خدمة التكامل
`4`	`API`	en: API · ar: واجهة برمجة التطبيقات

clientId

string

hasPartner

boolean

id

string · uuid

isCustomDateEnabled

boolean

isShared

boolean

tenantId

string · uuid

update-channel

PUT

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

/channels/{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_125`	400	`CHANNEL_ID_IS_NOT_FOUND`	Channel cannot be found.

update-channel › path Parameters

id

string · uuid · required

update-channel › Request Body

channelDate

string · date · required

channelType

integer · int32 · required

Permitted values — validated against the channel_type parameter.

Value	Meaning
`1`	Mobile Application
`2`	Web Browser
`3`	Integration Service
`4`	API

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

Value	Token	Labels
`1`	`Mobile`	en: Mobile Application · ar: تطبيق الجوال
`2`	`Web`	en: Web Browser · ar: متصفح الويب
`3`	`Integration`	en: Integration Service · ar: خدمة التكامل
`4`	`API`	en: API · ar: واجهة برمجة التطبيقات

hasPartner

boolean · required

isCustomDateEnabled

boolean · required

isShared

boolean · required

channelDescription

string

update-channel › Responses

No data returned

delete-channel

DELETE

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

/channels/{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_125`	400	`CHANNEL_ID_IS_NOT_FOUND`	Channel cannot be found.

delete-channel › path Parameters

id

string · uuid · required

delete-channel › Responses

No data returned

caches clients