PROS Performance Quoting - Quote Designer API (1.0.4)

Download OpenAPI specification:Download

PROS Support: support@pros.com URL: https://connect.pros.com/ Terms of Service

The Quote designer API provides various operations to get, import, export and activate quote models.
Warning: Clients consuming this API, or servers implementing this API, must assume that JSON objects are open for extension. Client and Server must not reject new fields that are not part of the Open API contract. This is consistent with the OpenAPI 3.0 specification that is based on the JSON schema specification: Open API object definitions are considered open for extension by default, an additionalProperties directive is not required to make an object definition extensible. OpenAPI specification: https://swagger.io/specification/

Quote models Designer File Format Object

Quote models Designer operations

Get all quote models

Get all the quote models information of the quote designer.

Authorizations:

Token

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string Deprecated Environment identifier. This parameter is deprecated and the environment will be automatically retrieved. If used the provided environment value will be checked against the the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Responses

Response samples

200
default

Content type

application/json

{"models": [{"modelId": "e3152548-1404-49d2-a1fe-46e0d1c23f06",
"familyId": "Food",
"suffix": "Draft 1",
"status": "DRAFT"
}
]
}

Export a quote model

Export single quote model by his model id

Authorizations:

Token

path Parameters

quoteModelId

required

string

The model id of the quote model

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string Deprecated Environment identifier. This parameter is deprecated and the environment will be automatically retrieved. If used the provided environment value will be checked against the the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Responses

Response samples

200
default

Content type

application/json

null

Activate a quote model

Activate a single quote model

Authorizations:

Token

path Parameters

quoteModelId required	string The model id of the quote model
label required	string The label of the quote model's publication

query Parameters

deleteDraft

boolean

If the draft must be deleted after the publication. Default value is false.

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string Deprecated Environment identifier. This parameter is deprecated and the environment will be automatically retrieved. If used the provided environment value will be checked against the the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Responses

Response samples

200
default

Content type

application/json

{"status": "COMPLETED"
}

Import a quote model

Import a quote model with the given family and the zip file to import in an asynchronous way

Authorizations:

Token

path Parameters

familyId

required

string

The family id of the quote model

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string Deprecated Environment identifier. This parameter is deprecated and the environment will be automatically retrieved. If used the provided environment value will be checked against the the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Request Body schema: multipart/form-data

importFile

required

string <binary>

File to import must be Zip file.

Responses

Response samples

200
default

Content type

application/json

{"token": "e3152548-1404-49d2-a1fe-46e0d1c23f06"
}

Get status of an import

Get the status of an import identified by a token generated during the initial call of the import

Authorizations:

Token

path Parameters

token

required

string

Token used to retrieve the status of the import

header Parameters

X-quotex-sessionId required	string Session identifier. Call initSession API to get a session Id
X-quotex-environment	string Deprecated Environment identifier. This parameter is deprecated and the environment will be automatically retrieved. If used the provided environment value will be checked against the the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Responses

Response samples

200
default

Content type

application/json

{"status": "COMPLETED"
}

Initialize session

Initialize a session

Initializes a session and returns a session identifier which is required for any further call to the Quote Designer API.

Authorizations:

Token

header Parameters

X-quotex-environment	string Deprecated Environment identifier. This parameter is deprecated and the environment will be automatically retrieved. If used the provided environment value will be checked against the the environment value automatically found. This header should NOT be used to pass AppPortal environment value.
X-quotex-userId	string The user identifier -> Optional user email. It will replace the authenticated usedId for certain roles if provided.
Request-Id	string Use this optional header to correlate many calls to the public API for the same external operation. Must be a UUID without "-" characters.

Responses

Response samples

200
default

Content type

application/json

{"sessionId": "string"
}