DFS Target Market Services API (latest)

Download OpenAPI specification:Download

Contains functionality around target market.

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

DefinitionManagement

Retrieve allowed attributes and values for a given definition.

Retrieves allowed attributes and values for a given definition.

Authorizations:

Bearer

path Parameters

definitionKey

required

string

Definition Key

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/target-market/definitions/{definitionKey}

https://example-host/v1.0/target-market/definitions/{definitionKey}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"nameResourceKey": "string",
"definition": 
[
{"attribute": 
{"id": 0,
"name": "string",
"nameResourceKey": "string",
"key": "string",
"isMandatory": true
},
"values": 
[
{"id": 0,
"name": "string",
"nameResourceKey": "string",
"key": "string"
}
]
}
]
}

InstanceManagement

Retrieve attribute and value pairs saved for a specific entity.

Retrieves attribute and value pairs saved for a specific entity.

Authorizations:

Bearer

path Parameters

entityUid

required

string <uuid>

The entity UID

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/target-market/instances/{entityUid}

https://example-host/v1.0/target-market/instances/{entityUid}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"definitionKey": "string",
"instance": 
[
{"attributeId": 0,
"valueIds": 
[0
]
}
]
}

Set a list of attribute and value pairs for a specific entity.

Sets a list of attribute and value pairs for a specific entity. More than one value may be saved for a specific attribute. Only attributes which are in the specified target market may be passed. Only values associated with the attribute may be passed for a specific attribute.

Authorizations:

Bearer

path Parameters

entityUid

required

string <uuid>

Entity id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

The parameter DTO

definitionKey	string Nullable
instance	Array of objects (TargetMarketInstanceRequest) Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

put/v1.0/target-market/instances/{entityUid}

https://example-host/v1.0/target-market/instances/{entityUid}

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"definitionKey": "DefinitionKey",
"instance": 
[
{"attributeId": 1,
"valueIds": 
[1,
2
]
},
{"attributeId": 2,
"valueIds": 
[2,
3
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Search instances based on a common definition

Searches instances based on a common definition. Only attributes which are in the specified target market may be passed. Only values associated with the attribute may be passed for a specific attribute.

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

The parameter DTO

definitionKey	string Nullable
searchParameters	Array of objects (TargetMarketInstanceSearchParametersRequest) Nullable

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/target-market/instances/search

https://example-host/v1.0/target-market/instances/search

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"definitionKey": "DefinitionKey",
"searchParameters": 
[
{"attributeId": 1,
"valueId": 1
},
{"attributeId": 2,
"valueId": 2
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
["16dc999f-42e2-4dbd-8fdc-6c8555d87b43",
"dbace18d-78c2-4b07-9149-ae128a2cb008",
"bb96e3ba-ef5b-4a75-8904-5b0efc81e33c"
]
}

Validate target market instance

Validates a passed target market instance against the target market of a passed list of references.

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

definitionKey required	string non-empty
referenceUids required	Array of strings <uuid>
instanceToValidate required	Array of objects (TargetMarketInstanceAttributeKeyToValueKeysRequest)

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/target-market/validate

https://example-host/v1.0/target-market/validate

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"definitionKey": "Security",
"referenceUids": 
["a6744d38-189f-4ce3-8436-0843937c9a5b"
],
"instanceToValidate": 
[
{"attributeKey": "ProfessionalInvestor",
"valueKeys": 
["Yes"
]
},
{"attributeKey": "Knowledge-B1660734-D49C-4C32-B481-EBB6631A8275",
"valueKeys": 
["No"
]
},
{"attributeKey": "Experience-B1660734-D49C-4C32-B481-EBB6631A8275",
"valueKeys": 
["Basic",
"Informed"
]
},
{"attributeKey": "DistributionStrategy",
"valueKeys": 
["Advisory",
"Discretionary"
]
}
]
}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"isSuitable": true,
"validations": 
[
{"isSuitable": true,
"referenceUid": "a6744d38-189f-4ce3-8436-0843937c9a5b",
"suitable": 
[
{"attributeKey": "ProfessionalInvestor",
"passedValueKeys": 
["Yes"
],
"validValueKeys": 
["Yes"
]
},
{"attributeKey": "Knowledge-B1660734-D49C-4C32-B481-EBB6631A8275",
"passedValueKeys": 
["No"
],
"validValueKeys": 
["No"
]
},
{"attributeKey": "Experience-B1660734-D49C-4C32-B481-EBB6631A8275",
"passedValueKeys": 
["Basic",
"Informed"
],
"validValueKeys": 
["Basic",
"Informed"
]
},
{"attributeKey": "DistributionStrategy",
"passedValueKeys": 
["ExecutionOnly",
"Discretionary"
],
"validValueKeys": 
["ExecutionOnly",
"Discretionary"
]
}
],
"notSuitable": [ ]
}
]
}

DFS Target Market Services API (latest)

DefinitionManagement

Retrieve allowed attributes and values for a given definition.

Authorizations:

path Parameters

header Parameters

Responses

Response samples

InstanceManagement

Retrieve attribute and value pairs saved for a specific entity.

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Set a list of attribute and value pairs for a specific entity.

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Search instances based on a common definition

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Validate target market instance

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json