1. Overview

Financial Web Services Documentation

1.1. Version information

Version : 1.0

1.2. URI scheme

Host : localhost:9001
BasePath : /financialwebservices

1.3. Tags

  • FSClaims : FS Claims Controller

  • FSInsurancePolicies : FS Insurance Policies Controller

  • Sample : Sample Methods

2. Security

2.1. oauth2_password

Type : oauth2
Flow : password
Token URL : /authorizationserver/oauth/token

Name

basic

2.2. oauth2_client_credentials

Type : oauth2
Flow : application
Token URL : /authorizationserver/oauth/token

Name

basic

3. Resources

3.1. FSClaims

FS Claims Controller

3.1.1. Checks the claim relevance

POST /v1/sites/{baseSiteId}/catalogs/{catalogId}/versions/{versionId}/claims/relevance
Description

Checks whether a claim originated in other back-end system is relevant for Hybris.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

catalogId
required

Represents unique identifier of the catalog that will be queried.

string

Path

versionId
required

Represents version of the catalog which will be queried: usually Online or Staged.

string

Body

claimsListForCheck
optional

List of claims sent for checking their relevance.

ClaimsWsDTO
Responses
HTTP Code Description Schema

200

OK

ClaimsWsDTO

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

3.2. FSInsurancePolicies

FS Insurance Policies Controller

3.2.1. Checks the policy relevance

POST /v1/sites/{baseSiteId}/catalogs/{catalogId}/versions/{versionId}/policies/relevance
Description

Checks whether a policy or contract originated in other back-end system is relevant for Hybris.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

catalogId
required

Represents unique identifier of the catalog that will be queried.

string

Path

versionId
required

Represents version of the catalog which will be queried: usually Online or Staged.

string

Body

contractsList
optional

List of contracts sent for checking their relevance.

ContractsWsDTO
Responses
HTTP Code Description Schema

200

OK

ContractsWsDTO

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

3.3. Sample

Sample Methods

4. Definitions

4.1. ClaimsWsDTO

Name Schema

claim
optional

< FSClaimRelevanceWsDTO > array

4.2. ContractWsDTO

Name Schema

contractId
optional

string

mainPolicyHolderId
optional

string

productId
optional

string

relevant
optional

boolean

4.3. ContractsWsDTO

Name Schema

contract
optional

< ContractWsDTO > array

4.4. FSClaimRelevanceWsDTO

Name Schema

claimId
optional

string

contractId
optional

string

policyHolderId
optional

string

policyId
optional

string

productId
optional

string

relevant
optional

boolean

requestId
optional

string