address-types

Operations addressed under /address-types — 5 operations.

aurax-bff-dynamic-get-address-type-list

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/address-types

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

Request and response fields are declared on the routing target get-address-type-list; this entry declares none of its own.

aurax-bff-dynamic-get-address-type-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

aurax-bff-dynamic-get-address-type-list › Responses

Success. Returns a page of records: the collection under data, with total carrying the unpaged count.

Paged response envelope observed on the BFF response path.

object[] · required

Response records carried by this page.

total

integer · int64

Total matching records, ignoring paging.

GET/address-types

curl https://dg-sandbox.dgpays.com/aurax-bff-service/address-types

Example Responses

{
  "data": [
    {
      "addressTypeFields": [
        {
          "fieldKey": "fieldKey",
          "id": "00000000-0000-0000-0000-000000000000",
          "isActive": true,
          "isMandatory": true,
          "separatorMark": "separatorMark",
          "sequenceNumber": 0,
          "translations": [
            {
              "languageCode": "languageCode",
              "name": "name"
            }
          ],
          "typeId": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "code": "code",
      "country": 0,
      "id": "00000000-0000-0000-0000-000000000000",
      "isActive": true,
      "name": "name",
      "translations": [
        {
          "languageCode": "languageCode",
          "name": "name"
        }
      ]
    }
  ],
  "total": 0
}

json

application/json

create-address-template-bpm

POST

https://dg-sandbox.dgpays.com/aurax-bff-service

/address-types

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

Invokes the aurax-bff-dynamic-create-address-template-bpm service definition through POST /address-types.

Request and response fields are declared on the routing target create-address-template-bpm; this entry declares none of its own.

create-address-template-bpm › Request Body

code

string · required

name

string · required

object[]

country

integer · int32

create-address-template-bpm › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

POST/address-types

curl https://dg-sandbox.dgpays.com/aurax-bff-service/address-types \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "addressTypeFields": [
    {
      "fieldKey": "",
      "isMandatory": false,
      "isVisible": false,
      "separatorMark": "",
      "sequenceNumber": 0
    }
  ],
  "code": "",
  "country": 0,
  "name": ""
}'

Example Request Body

{
  "addressTypeFields": [
    {
      "fieldKey": "",
      "isMandatory": false,
      "isVisible": false,
      "separatorMark": "",
      "sequenceNumber": 0
    }
  ],
  "code": "",
  "country": 0,
  "name": ""
}

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

aurax-bff-dynamic-get-address-type-by-id

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/address-types/{id}

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

Request and response fields are declared on the routing target get-address-type-by-id; this entry declares none of its own.

aurax-bff-dynamic-get-address-type-by-id › path Parameters

id

string · uuid · required

aurax-bff-dynamic-get-address-type-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.

object[]

code

string

country

integer · int32

id

string · uuid

isActive

boolean

name

string

object[]

update-address-template-bpm

PUT

https://dg-sandbox.dgpays.com/aurax-bff-service

/address-types/{id}

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

Invokes the aurax-bff-dynamic-update-address-template-bpm service definition through PUT /address-types/{id}.

Request and response fields are declared on the routing target update-address-template-bpm; this entry declares none of its own.

update-address-template-bpm › path Parameters

id

string · required

Present in this route template but not among the Route-bound fields of the routing target update-address-template-bpm, whose own path is decoupled from this one.

update-address-template-bpm › Request Body

code

string · required

id

string · uuid · required

isActive

boolean · required

name

string · required

object[]

country

integer · int32

update-address-template-bpm › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

PUT/address-types/{id}

curl https://dg-sandbox.dgpays.com/aurax-bff-service/address-types/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "addressTypeFields": [
    {
      "fieldId": "",
      "fieldKey": "",
      "isActive": false,
      "isMandatory": false,
      "isVisible": false,
      "rowStatus": 0,
      "separatorMark": "",
      "sequenceNumber": 0,
      "typeId": ""
    }
  ],
  "code": "",
  "country": 0,
  "id": "",
  "isActive": false,
  "name": ""
}'

Example Request Body

{
  "addressTypeFields": [
    {
      "fieldId": "",
      "fieldKey": "",
      "isActive": false,
      "isMandatory": false,
      "isVisible": false,
      "rowStatus": 0,
      "separatorMark": "",
      "sequenceNumber": 0,
      "typeId": ""
    }
  ],
  "code": "",
  "country": 0,
  "id": "",
  "isActive": false,
  "name": ""
}

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-address-type-definition

DELETE

https://dg-sandbox.dgpays.com/aurax-bff-service

/address-types/{id}

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

Invokes the aurax-bff-dynamic-delete-address-type-definition service definition through DELETE /address-types/{id}.

Request and response fields are declared on the routing target delete-address-type-definition; this entry declares none of its own.

delete-address-type-definition › path Parameters

id

string · uuid · required

delete-address-type-definition › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

address admin