occupation-types

Operations addressed under /occupation-types — 13 operations.

create-occupation-type

POST

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

/occupation-types

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

create-occupation-type › Request Body

code

string · required

isMandatory

boolean · required

name

string · required

dataType

integer · int32

isMultiple

boolean

isTextable

boolean

parentOccupationTypeId

string · uuid

sortOrder

number

create-occupation-type › 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

update-occupation-type

PUT

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

/occupation-types/{id}

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

update-occupation-type › path Parameters

id

string · uuid · required

update-occupation-type › Request Body

isActive

boolean · required

isMandatory

boolean · required

name

string · required

dataType

integer · int32

isMultiple

boolean

isTextable

boolean

parentOccupationTypeId

string · uuid

sortOrder

number

update-occupation-type › Responses

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

No data returned

delete-occupation-type

DELETE

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

/occupation-types/{id}

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

delete-occupation-type › path Parameters

id

string · uuid · required

delete-occupation-type › Responses

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

No data returned

create-occupation-type-field

POST

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

/occupation-types/{id}/fields

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

create-occupation-type-field › path Parameters

id

string · uuid · required

create-occupation-type-field › Request Body

fieldKey

string · required

sequenceNumber

integer · int32

create-occupation-type-field › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

id

string · uuid

get-occupation-type-field-by-id

GET

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

/occupation-types/{id}/fields/{fieldId}

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

get-occupation-type-field-by-id › path Parameters

id

string · uuid · required

fieldId

string · uuid · required

get-occupation-type-field-by-id › Responses

fieldKey

string

id

string · uuid

isActive

boolean

sequenceNumber

integer · int32

object[]

typeId

string · uuid

update-occupation-type-field

PUT

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

/occupation-types/{id}/fields/{fieldId}

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

update-occupation-type-field › path Parameters

id

string · uuid · required

fieldId

string · uuid · required

update-occupation-type-field › Request Body

fieldKey

string · required

isActive

boolean · required

sequenceNumber

integer · int32

update-occupation-type-field › Responses

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

No data returned

delete-occupation-type-field

DELETE

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

/occupation-types/{id}/fields/{fieldId}

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

delete-occupation-type-field › path Parameters

id

string · uuid · required

fieldId

string · uuid · required

delete-occupation-type-field › Responses

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

No data returned

create-occupation-type-field-map

POST

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

/occupation-types/{id}/fields/{fieldId}/maps

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

create-occupation-type-field-map › path Parameters

id

string · uuid · required

fieldId

string · uuid · required

create-occupation-type-field-map › Request Body

targetOccupationTypeFieldId

string · uuid · required

create-occupation-type-field-map › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

id

string · uuid

get-occupation-type-field-map-by-id

GET

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

/occupation-types/{id}/fields/{fieldId}/maps/{MapId}

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

Declared as Route-bound but absent from the route template, so not sendable: mapId.

get-occupation-type-field-map-by-id › path Parameters

id

string · uuid · required

fieldId

string · uuid · required

MapId

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

get-occupation-type-field-map-by-id › Responses

id

string · uuid

sourceOccupationTypeFieldId

string · uuid

targetOccupationTypeFieldId

string · uuid

update-occupation-type-field-map

PUT

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

/occupation-types/{id}/fields/{fieldId}/maps/{MapId}

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

Declared as Route-bound but absent from the route template, so not sendable: mapId.

update-occupation-type-field-map › path Parameters

id

string · uuid · required

fieldId

string · uuid · required

MapId

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

update-occupation-type-field-map › Request Body

targetOccupationTypeFieldId

string · uuid · required

update-occupation-type-field-map › Responses

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

No data returned

delete-occupation-type-field-map

DELETE

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

/occupation-types/{id}/fields/{fieldId}/maps/{MapId}

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

Declared as Route-bound but absent from the route template, so not sendable: mapId.

delete-occupation-type-field-map › path Parameters

id

string · uuid · required

fieldId

string · uuid · required

MapId

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

delete-occupation-type-field-map › Responses

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

No data returned

has-occupation-field-usage

GET

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

/occupation-types/{id}/fields/{fieldId}/usage

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

has-occupation-field-usage › path Parameters

id

string · uuid · required

fieldId

string · uuid · required

has-occupation-field-usage › Responses

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

No data returned

has-occupation-type-usage

GET

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

/occupation-types/{id}/usage

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

has-occupation-type-usage › path Parameters

id

string · uuid · required

has-occupation-type-usage › Responses

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

No data returned

naces parameters