Scoring Engine WEB API

Overview

HTTP status codes

Scoring Engine uses following HTTP status codes.

Status code
Usage

200 OK

The request completed successfully.

201 Created

A new resource has been created successfully. The resource’s URI is available from the response’s Location header.

204 No Content

A deletion of an existing resource has been applied successfully

400 Bad Request

The request was malformed. The response body will include an error providing further information.

401 Unauthorized

The request has not been applied because it lacks valid authentication credentials for the target resource.

404 Not Found

The requested resource did not exist.

409 Conflict

Indicates that the request could not be processed because of conflict in the request, such as creation new resource with id already existing one.

422 Unprocessable Entity

The request was well-formed but was unable to be followed due to semantic errors.

Resources

Scenario

The Scenario resource is used to manage scenarios.

Importing scenarios

A POST request is used to import scenarios.

Request structure

Headers

Name
Description

Authorization

Authorization token

Parameters

Parameter
Description

overwrite

Indicates if overwrite existing scenarios with the same name

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Exporting scenarios

A GET request is used to export scenarios.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Creating scenario process

A GET request is used to create scenario process.

Request structure

The request path contains following parameters:

Parameter
Description

scenarioId

Scenario id

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Code

The Code resource is used to manage codes.

Importing codes

A POST request is used to import codes.

Request structure

Headers

Name
Description

Authorization

Authorization token

Parameters

Parameter
Description

overwrite

Indicates if overwrite existing codes with the same name

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Exporting codes

A GET request is used to export codes.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Listing codes

A GET request is used to list codes.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Counting codes

A GET request is used to count codes.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Scenario Code

The Scenario Code resource is used to manage scenario codes.

Uploading a scenario code

A POST request is used to create a new scenario code.

Request structure

Headers

Name
Description

Authorization

Authorization token

Parameters

Parameter
Description

name

Scenario code name

increaseVersion

Indicates if increase scenario code version

Body

Body should contain correct json scenario code encoded in plain text.

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Scoring a scenario code

A Post request is used to score specified scenario code.

Request structure

Headers

Name
Description

Authorization

Authorization token

Parameters

Parameter
Description

name

Scenario code name

Example request

Response structure

Response status should be 200 with following structure.

Path
Type
Description

name

String

Model name used for scoring

beginTime

String

Scoring start time

endTime

String

Scoring end time

result

Object

Result of model scored with input data

error

Null

Exception message if scoring exception occured

Example response

Scoring a scenario code error

A Post request is used to score specified scenario code.

Request structure

Headers

Name
Description

Authorization

Authorization token

Parameters

Parameter
Description

name

Scenario code name

Example request

Response structure

Suitable error will be returned.

Path
Type
Description

timestamp

String

Error time

status

Number

Error code status

path

String

Error resource

error

String

Error code message

message

String

Error message

Example response

Remote scoring a scenario code

A Post request is used to remote score specified scenario code.

Request structure

Parameters

Parameter
Description

name

Scenario code name

key

Score token

Example request

Response structure

Response status should be 200 with following structure or suitable error will be returned.

Path
Type
Description

name

String

Model name used for scoring

beginTime

String

Scoring start time

endTime

String

Scoring end time

result

Object

Result of model scored with input data

error

Null

Error message if error occured

sceuid

String

Browser cookie identifying user

Example response

Scoring async a scenario code

A Post request is used to score async specified scenario code.

Request structure

The request path contains following parameters:

Parameter
Description

name

Scenario code name

Headers

Name
Description

Authorization

Authorization token

X-SCE-RequestId

Unique id to identify scoring

X-SCE-CallbackUrl

Callback address to send scoring results

X-SCE-CallbackRetryCount

Callback retry number (if sending scoring results failed)

X-SCE-CallbackRetryDelay

Delay between consecutive callback retries (in seconds)

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Getting a scenario code attributes

A Get request is used to get specified scenario code attributes.

Request structure

The request path contains following parameters:

Parameter
Description

name

Scenario code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Exporting a scenario code

A Get request is used to export specified scenario code in json format.

Request structure

The request path contains following parameters:

Parameter
Description

name

Scenario code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Listing scenario codes

A GET request is used to list scenario codes.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Counting scenario codes

A GET request is used to count scenario codes.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Scoring Code

The Scoring Code resource is used to manage scoring codes.

Exporting a scoring code

A GET request is used to get specified scoring code in JSON format. The same format is used while importing codes.

Request structure

The request path contains following parameters:

Parameter
Description

name

Scoring code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Uploading a scoring code

A POST request is used to upload a scoring code.

Request structure

Parts

Part
Description

dateFrom

Date from

dateTo

Date to

fileName

Name of the file, from which we upload scoring code

scoringCodeName

Scoring code name

charset

File encoding

file

File from which we upload scoring code

Headers

Name
Description

Authorization

Authorization token

Content-Type

Media type of the resource

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Getting a scoring code attributes

A Get request is used to get specified scoring code attributes.

Request structure

The request path contains following parameters:

Parameter
Description

name

Scenario code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Getting a scoring code list

A Get request is used to get a list of scoring codes.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Downloading a scoring code

A Get request is used to download specified scoring code source.

Request structure

The request path contains following parameters:

Parameter
Description

name

Scenario code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Scoring a scoring code

A POST request is used to score specified scoring code.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 with following structure.

Example response

Scoring a scoring code error

A POST request is used to score specified scoring code.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Suitable error will be returned.

Example response

Deleting a scoring code

A POST request is used to delete a scoring code.

Request structure

Parameter
Description

name

Scoring code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

R Code

The R Code resource is used to manage R codes.

Uploading an r code

A POST request is used to upload an r code.

Request structure

Parts

Part
Description

dateFrom

Date from

dateTo

Date to

fileName

Name of the file, from which we upload scoring code

scoringCodeName

r code name

file

File from which we upload scoring code

Headers

Name
Description

Authorization

Authorization token

Content-Type

Media type of the resource

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Scoring an r code

A POST request is used to score specified r code.

Request structure

Parameter
Description

name

R code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 with following structure.

Example response

Scoring an r code error

A POST request is used to score specified r code.

Request structure

Parameter
Description

name

R code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Suitable error will be returned.

Example response

Exporting an r code

A GET request is used to get specified r code in JSON format. The same format is used while importing codes.

Request structure

The request path contains following parameters:

Parameter
Description

name

R code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Getting an r code attributes

A GET request is used to get specified r code attributes.

Request structure

The request path contains following parameters:

Parameter
Description

name

Scenario code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Getting an r code list

A Get request is used to get a list of R codes.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Downloading an r code

A GET request is used to download specified r code source.

Request structure

The request path contains following parameters:

Parameter
Description

name

R code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Deleting an r code

A POST request is used to delete r code.

Request structure

Parameter
Description

name

Scoring code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Pmml Code

The Pmml Code resource is used to manage Pmml codes.

Uploading a pmml code

A POST request is used to upload an pmml code.

Request structure

Parts

Part
Description

dateFrom

Date from

dateTo

Date to

fileName

Name of the file, from which we upload pmml code

scoringCodeName

Pmml code name

charset

File encoding

file

File from which we upload pmml code

Headers

Name
Description

Authorization

Authorization token

Content-Type

Media type of the resource

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Scoring a pmml code

A POST request is used to score specified pmml code.

Request structure

Parameter
Description

name

Pmml code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 with following structure.

Example response

Scoring a pmml code

A POST request is used to score specified pmml code.

Request structure

Parameter
Description

name

Pmml code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Suitable error will be returned.

Example response

Exporting a pmml code

A GET request is used to get specified pmml code in JSON format. The same format is used while importing codes.

Request structure

The request path contains following parameters:

Parameter
Description

name

Pmml code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Getting a pmml code attributes

A GET request is used to get specified pmml code attributes.

Request structure

The request path contains following parameters:

Parameter
Description

name

Scenario code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Getting pmml codes list

A GET request is used to get a list of PMML codes.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Downloading a pmml code

A GET request is used to download specified pmml code source.

Request structure

The request path contains following parameters:

Parameter
Description

name

Pmml code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Deleting a pmml code

A POST request is used to delete pmml code.

Request structure

Parameter
Description

name

Scoring code name

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

User methods

The User resource is used to manage users.

Listing user tokens

A GET request is used to list user tokens.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Path
Type
Description

authorizationToken

String

Authorization token

scoreToken

String

Scoring token

Example response

Getting user data

A GET request is used to get full user information.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Path
Type
Description

username

String

Username

firstName

String

User’s first name

lastName

String

User’s last name

email

String

User’s email

phoneNumber

String

User’s phone number

scoreToken

String

User’s score token

companyName

String

User’s company name

isRegistered

Boolean

Is user registered

isAdmin

Boolean

Is user admin

agreePolicy

Boolean

Has user agreed policy

agreeProcessing

Boolean

Has user agreed processing

Example response

Updating user data

A POST request is used to update user data.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Changing user’s password

A POST request is used to change user’s password.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Admin methods

Getting users list

A POST request is used to get a list of users.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Creating new user

A POST request is used to create new user account.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Changing user password

A POST request is used to create new user account.

Request structure

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Deleting new user

A POST request is used to delete user account.

Request structure

Parameter
Description

username

Username

Headers

Name
Description

Authorization

Authorization token

Example request

Response structure

Response status should be 200 or suitable error will be returned.

Example response

Last updated