key-formats

Operations addressed under /key-formats — 10 operations.

account-get-key-format-list

GET

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

/key-formats

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Description`	`string`	no
`MaxLength`	`int`	no
`IsActive`	`bool`	no

Member names are the service's declaration names.

account-get-key-format-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

account-get-key-format-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

description

id

string · uuid

isActive

boolean

maxLength

integer · int32

account-create-key-format

POST

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

/key-formats

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

Invokes the account-create-key-format service definition through POST /key-formats.

Turkish display name: tr

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
`ERR_KYGNR_7`	400	`KEY_FORMAT_CODE_DUPLICATED`

account-create-key-format › Request Body

code

string · required

maxLength

integer · int32 · required

object[] · required

account-create-key-format › 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

account-get-key-format-id-by-code

GET

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

/key-formats/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 returns Guid, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON string holding a UUID. This is a complete answer read from the declaration, not a gap.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_KYGNR_1`	400	`KEY_FORMAT_NOT_FOUND_BY_CODE`

account-get-key-format-id-by-code › path Parameters

code

string · required

account-get-key-format-id-by-code › 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

account-generate-key

POST

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

/key-formats/by-code/{code}/generate

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

account-generate-key › path Parameters

code

string · required

account-generate-key › Request Body optional

object

account-generate-key › Responses

No data returned

account-get-key-format-by-id

GET

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

/key-formats/{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 KeyFormatDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Description`	`string`	no
`MaxLength`	`int`	no
`IsActive`	`bool`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_KYGNR_16`	400	`KEY_FORMAT_NOT_FOUND_BY_ID`

account-get-key-format-by-id › path Parameters

id

string · uuid · required

account-get-key-format-by-id › Responses

code

string

description

id

string · uuid

isActive

boolean

maxLength

integer · int32

account-update-key-format

PUT

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

/key-formats/{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_KYGNR_16`	400	`KEY_FORMAT_NOT_FOUND_BY_ID`

account-update-key-format › path Parameters

id

string · uuid · required

account-update-key-format › Request Body

maxLength

integer · int32 · required

object[] · required

account-update-key-format › Responses

No data returned

account-get-key-format-item-id-by-key-format-id

GET

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

/key-formats/{id}/item-summaries

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

Field	Declared type	Nullable
`ItemList`	`IEnumerable<KeyFormatItemSummaryDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_KYGNR_16`	400	`KEY_FORMAT_NOT_FOUND_BY_ID`

account-get-key-format-item-id-by-key-format-id › path Parameters

id

string · uuid · required

account-get-key-format-item-id-by-key-format-id › Responses

object[]

account-get-key-format-item-by-key-format-id

GET

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

/key-formats/{id}/items

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

Field	Declared type	Nullable
`ItemList`	`IEnumerable<KeyFormatItemDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_KYGNR_16`	400	`KEY_FORMAT_NOT_FOUND_BY_ID`

account-get-key-format-item-by-key-format-id › path Parameters

id

string · uuid · required

account-get-key-format-item-by-key-format-id › Responses

object[]

account-create-key-format-item

POST

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

/key-formats/{id}/items

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

Field	Declared type	Nullable
`ItemList`	`IEnumerable<CreateKeyFormatItemDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_KYGNR_16`	400	`KEY_FORMAT_NOT_FOUND_BY_ID`

account-create-key-format-item › path Parameters

id

string · uuid · required

account-create-key-format-item › Request Body

object[] · required

account-create-key-format-item › Responses

object[]

POST/key-formats/{id}/items

curl https://dg-sandbox.dgpays.com/account-service/key-formats/:id/items \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "itemList": [
    {
      "defaultValue": "",
      "hasPadding": false,
      "itemLenght": 0,
      "itemSequence": 0,
      "itemValue": "",
      "paddingDirection": 0,
      "seperator": "",
      "translations": [
        {
          "languageCode": "",
          "name": ""
        }
      ],
      "type": 0
    }
  ]
}'

Example Request Body

{
  "itemList": [
    {
      "defaultValue": "",
      "hasPadding": false,
      "itemLenght": 0,
      "itemSequence": 0,
      "itemValue": "",
      "paddingDirection": 0,
      "seperator": "",
      "translations": [
        {
          "languageCode": "",
          "name": ""
        }
      ],
      "type": 0
    }
  ]
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "itemList": [
    {
      "itemId": "00000000-0000-0000-0000-000000000000",
      "name": "name"
    }
  ]
}

json

application/json

account-delete-key-format-item

DELETE

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

/key-formats/{id}/items/{itemId}

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_KYGNR_16`	400	`KEY_FORMAT_NOT_FOUND_BY_ID`
`ERR_KYGNR_3`	400	`KEY_FORMAT_NOT_EXIST_ITEMS`

account-delete-key-format-item › path Parameters

id

string · uuid · required

itemId

string · uuid · required

account-delete-key-format-item › Responses

No data returned

incoming-distraint-files localizations