swift-mts

Operations addressed under /swift-mts — 3 operations.

get-swift-mTSchema-list

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-mts

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

Field	Declared type	Nullable
`MessageType`	`string`	no
`MessageName`	`string`	no
`Description`	`string`	no
`Status`	`string`	no
`SchemaProperties`	`string`	no
`Fields`	`List<SwiftMTFieldDto>` (collection)	no

Member names are the service's declaration names.

get-swift-mTSchema-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-swift-mTSchema-list › Responses

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

No data returned

create-swift-mTSchema

POST

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-mts

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.

create-swift-mTSchema › Request Body

description

required

object[] · required

messageType

string · required

schemaProperties

string · required

status

integer · int32 · required

create-swift-mTSchema › 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.

POST/swift-mts

curl https://dg-sandbox.dgpays.com/foreign-trade-service/swift-mts \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "",
  "fields": [
    {
      "active": false,
      "description": "",
      "editable": false,
      "fieldDefs": [
        {
          "dataType": "",
          "dataValue": "",
          "dataValueOptions": "",
          "defaultValue": "",
          "description": "",
          "editable": false,
          "fieldName": "",
          "format": "",
          "maxLength": 0,
          "maxRow": 0,
          "minLength": 0,
          "order": 0,
          "regExFormat": "",
          "required": false,
          "rowNumber": 0,
          "rule": "",
          "tag": "",
          "visible": false
        }
      ],
      "fieldName": "",
      "groupNo": 0,
      "messageType": "",
      "order": 0,
      "required": false,
      "rule": "",
      "tag": "",
      "visible": false
    }
  ],
  "messageType": "",
  "schemaProperties": "",
  "status": 0
}'

Example Request Body

{
  "description": "",
  "fields": [
    {
      "active": false,
      "description": "",
      "editable": false,
      "fieldDefs": [
        {
          "dataType": "",
          "dataValue": "",
          "dataValueOptions": "",
          "defaultValue": "",
          "description": "",
          "editable": false,
          "fieldName": "",
          "format": "",
          "maxLength": 0,
          "maxRow": 0,
          "minLength": 0,
          "order": 0,
          "regExFormat": "",
          "required": false,
          "rowNumber": 0,
          "rule": "",
          "tag": "",
          "visible": false
        }
      ],
      "fieldName": "",
      "groupNo": 0,
      "messageType": "",
      "order": 0,
      "required": false,
      "rule": "",
      "tag": "",
      "visible": false
    }
  ],
  "messageType": "",
  "schemaProperties": "",
  "status": 0
}

json

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

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

application/json

get-swift-mTSchema-by-message-type

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-mts/by-message-type/{messageType}

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

Field	Declared type	Nullable
`MessageType`	`string`	no
`MessageName`	`string`	no
`Description`	`string`	no
`Status`	`string`	no
`SchemaProperties`	`string`	no
`Fields`	`List<SwiftMTFieldDto>` (collection)	no

Member names are the service's declaration names.

get-swift-mTSchema-by-message-type › path Parameters

messageType

string · required

get-swift-mTSchema-by-message-type › Responses

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

No data returned

swift-incomings swift-mx-schemas

Foreign Trade

swift-mts

Operations addressed under /swift-mts — 3 operations.

get-swift-mTSchema-list

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-mts

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

Field	Declared type	Nullable
`MessageType`	`string`	no
`MessageName`	`string`	no
`Description`	`string`	no
`Status`	`string`	no
`SchemaProperties`	`string`	no
`Fields`	`List<SwiftMTFieldDto>` (collection)	no

Member names are the service's declaration names.

get-swift-mTSchema-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-swift-mTSchema-list › Responses

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

No data returned

create-swift-mTSchema

POST

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-mts

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.

create-swift-mTSchema › Request Body

description

required

object[] · required

messageType

string · required

schemaProperties

string · required

status

integer · int32 · required

create-swift-mTSchema › 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.

POST/swift-mts

curl https://dg-sandbox.dgpays.com/foreign-trade-service/swift-mts \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "",
  "fields": [
    {
      "active": false,
      "description": "",
      "editable": false,
      "fieldDefs": [
        {
          "dataType": "",
          "dataValue": "",
          "dataValueOptions": "",
          "defaultValue": "",
          "description": "",
          "editable": false,
          "fieldName": "",
          "format": "",
          "maxLength": 0,
          "maxRow": 0,
          "minLength": 0,
          "order": 0,
          "regExFormat": "",
          "required": false,
          "rowNumber": 0,
          "rule": "",
          "tag": "",
          "visible": false
        }
      ],
      "fieldName": "",
      "groupNo": 0,
      "messageType": "",
      "order": 0,
      "required": false,
      "rule": "",
      "tag": "",
      "visible": false
    }
  ],
  "messageType": "",
  "schemaProperties": "",
  "status": 0
}'

Example Request Body

{
  "description": "",
  "fields": [
    {
      "active": false,
      "description": "",
      "editable": false,
      "fieldDefs": [
        {
          "dataType": "",
          "dataValue": "",
          "dataValueOptions": "",
          "defaultValue": "",
          "description": "",
          "editable": false,
          "fieldName": "",
          "format": "",
          "maxLength": 0,
          "maxRow": 0,
          "minLength": 0,
          "order": 0,
          "regExFormat": "",
          "required": false,
          "rowNumber": 0,
          "rule": "",
          "tag": "",
          "visible": false
        }
      ],
      "fieldName": "",
      "groupNo": 0,
      "messageType": "",
      "order": 0,
      "required": false,
      "rule": "",
      "tag": "",
      "visible": false
    }
  ],
  "messageType": "",
  "schemaProperties": "",
  "status": 0
}

json

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

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

application/json

get-swift-mTSchema-by-message-type

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-mts/by-message-type/{messageType}

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

Field	Declared type	Nullable
`MessageType`	`string`	no
`MessageName`	`string`	no
`Description`	`string`	no
`Status`	`string`	no
`SchemaProperties`	`string`	no
`Fields`	`List<SwiftMTFieldDto>` (collection)	no

Member names are the service's declaration names.

get-swift-mTSchema-by-message-type › path Parameters

messageType

string · required

get-swift-mTSchema-by-message-type › Responses

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

No data returned

swift-incomings swift-mx-schemas