rm-segments

Operations addressed under /rm-segments — 2 operations.

get-rm-segment-list

GET

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

/rm-segments

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`SegmentName`	`string`	no
`SegmentVersion`	`string`	no
`Description`	`string`	no
`SegmentType`	`int`	no
`RmType`	`int`	no
`SegmentLength`	`int`	no
`AdditionalIndex`	`int?`	yes
`IsLatestVersion`	`bool`	no
`SegmentQueryOrder`	`int`	no
`RmSegmentFields`	`List<RmSegmentFieldDto>` (collection)	no

Member names are the service's declaration names.

get-rm-segment-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-rm-segment-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.

additionalIndex

integer · int32

description

string

id

string · uuid

isLatestVersion

boolean

object[]

segmentLength

integer · int32

segmentName

string

segmentQueryOrder

integer · int32

segmentType

integer · int32

segmentVersion

string

GET/rm-segments

curl https://dg-sandbox.dgpays.com/integration-service/rm-segments

Example Responses

[
  {
    "additionalIndex": 0,
    "description": "description",
    "id": "00000000-0000-0000-0000-000000000000",
    "isLatestVersion": true,
    "rmSegmentFields": [
      {
        "defaultValue": "defaultValue",
        "fieldCode": "fieldCode",
        "fieldDescription": "fieldDescription",
        "fieldGroupType": 0,
        "fieldLength": 0,
        "fieldOrder": 0,
        "id": "00000000-0000-0000-0000-000000000000",
        "isMandatory": true,
        "rmSegmentId": "00000000-0000-0000-0000-000000000000",
        "segmentDataType": 0
      }
    ],
    "segmentLength": 0,
    "segmentName": "segmentName",
    "segmentQueryOrder": 0,
    "segmentType": 0,
    "segmentVersion": "segmentVersion"
  }
]

json

application/json

get-rm-segment-field-list

GET

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

/rm-segments/{id}/fields

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`RmSegmentId`	`Guid`	no
`FieldCode`	`string`	no
`FieldOrder`	`int`	no
`FieldLength`	`int`	no
`SegmentDataType`	`int`	no
`IsMandatory`	`bool`	no
`FieldGroupType`	`int`	no
`DefaultValue`	`string`	no
`FieldDescription`	`string`	no

Member names are the service's declaration names.

get-rm-segment-field-list › path Parameters

id

string · uuid · required

get-rm-segment-field-list › query Parameters

orderBy

string

orderSort

string

get-rm-segment-field-list › Responses

object[]

Array of catalog-declared response records.

defaultValue

string

fieldCode

string

fieldDescription

string

fieldGroupType

integer · int32

fieldLength

integer · int32

fieldOrder

integer · int32

id

string · uuid

isMandatory

boolean

rmSegmentId

string · uuid

segmentDataType

integer · int32

pwf-transactions sms-notifications

Integration Service

rm-segments

Operations addressed under /rm-segments — 2 operations.

get-rm-segment-list

GET

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

/rm-segments

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`SegmentName`	`string`	no
`SegmentVersion`	`string`	no
`Description`	`string`	no
`SegmentType`	`int`	no
`RmType`	`int`	no
`SegmentLength`	`int`	no
`AdditionalIndex`	`int?`	yes
`IsLatestVersion`	`bool`	no
`SegmentQueryOrder`	`int`	no
`RmSegmentFields`	`List<RmSegmentFieldDto>` (collection)	no

Member names are the service's declaration names.

get-rm-segment-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-rm-segment-list › Responses

object[]

Array of catalog-declared response records.

additionalIndex

integer · int32

description

string

id

string · uuid

isLatestVersion

boolean

object[]

segmentLength

integer · int32

segmentName

string

segmentQueryOrder

integer · int32

segmentType

integer · int32

segmentVersion

string

GET/rm-segments

curl https://dg-sandbox.dgpays.com/integration-service/rm-segments

Example Responses

[
  {
    "additionalIndex": 0,
    "description": "description",
    "id": "00000000-0000-0000-0000-000000000000",
    "isLatestVersion": true,
    "rmSegmentFields": [
      {
        "defaultValue": "defaultValue",
        "fieldCode": "fieldCode",
        "fieldDescription": "fieldDescription",
        "fieldGroupType": 0,
        "fieldLength": 0,
        "fieldOrder": 0,
        "id": "00000000-0000-0000-0000-000000000000",
        "isMandatory": true,
        "rmSegmentId": "00000000-0000-0000-0000-000000000000",
        "segmentDataType": 0
      }
    ],
    "segmentLength": 0,
    "segmentName": "segmentName",
    "segmentQueryOrder": 0,
    "segmentType": 0,
    "segmentVersion": "segmentVersion"
  }
]

json

application/json

get-rm-segment-field-list

GET

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

/rm-segments/{id}/fields

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`RmSegmentId`	`Guid`	no
`FieldCode`	`string`	no
`FieldOrder`	`int`	no
`FieldLength`	`int`	no
`SegmentDataType`	`int`	no
`IsMandatory`	`bool`	no
`FieldGroupType`	`int`	no
`DefaultValue`	`string`	no
`FieldDescription`	`string`	no

Member names are the service's declaration names.

get-rm-segment-field-list › path Parameters

id

string · uuid · required

get-rm-segment-field-list › query Parameters

orderBy

string

orderSort

string

get-rm-segment-field-list › Responses

object[]

Array of catalog-declared response records.

defaultValue

string

fieldCode

string

fieldDescription

string

fieldGroupType

integer · int32

fieldLength

integer · int32

fieldOrder

integer · int32

id

string · uuid

isMandatory

boolean

rmSegmentId

string · uuid

segmentDataType

integer · int32

pwf-transactions sms-notifications