Webassessor User Guide
Webassessor User Guide
Breadcrumbs

API Integration Specification

A collection of available web services calls for Kryterion clients, listing API requests, their request parameters, example JSON objects, return values and possible error messages.

The full collection is available here: API_EWS_20260220.json

The API collection is set to call the Sandbox environment. Please update the endpoint from “https://sb01.webassessor.com” to “https://www.webassessor.com” to call the Production environment.

Article_Divider.png

Kryterion Web Services makes use of Java features not available until Java version 6, which is the minimum

recommended version. Kryterion Web Services are accessed by passing and accepting JSON formatted strings as specified in this document.

A security token is required to use Kryterion Web Services. To obtain your security token, contact your Customer Success Manager.

Web Service Detail

Ping Web Service

Ping Web Service

The ping web service can be used to ensure that web services are available. It can be accessed via a URL:

URI Template

https://www.webassessor.com/WebAssessorWebServices/jaxrs/wawebservices/ping

End-Point URL

https://www.webassessor.com/WebAssessorWebServices/jaxrs/wawebservices/processRequest

Request Parameters

URL Parameters None

Response Parameters

Hitting the ping web service will result in text being sent back to the browser: “Ping Successful!”

Possible Error Messages

None from within the code. Possible error messages would be HTTP error codes (i.e. 404 - Page Not Found,

etc.)

User (Candidate) Web Services

Get User Web Service

Get User Web Service

The Get User web service allows you to retrieve user information from Webassessor™.

Get User Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to GET USER)

  • login

  • securityToken

  • returnFormat

Calling the Get User Web Service with JSON

Here is an example of JSON object:

JSON
{

"requestType":"GET USER",

"securityToken":"12345678-1234-1234-1234-123456789012",

"login":"JohnDoe", 

"returnFormat":"JSON"

}

Example Get User Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of a Get User web service call in JSON.

JSON
{

"addressCity": "Chicago", 

"addressCountry": "United States", 

"addressPostalCode": "60013-0001", 

"addressState": "Illinois", 

"addressStreet1": "555 Main Street",

"addressStreet2": "Suite 99", “clientRegion”:

{

“id”: “1234”,

“name”: “Acme Co. North America”

},

"email": "john@beatles.com", 

"fax": "(480) 555-1212",

"firstName": "John",

"homePhone": "911-9999",

"id": "425660",

"lastName": "Lennon", 

"login": "JohnLennon",

"customFields": [

{

"id": "181",

"intValue": "0",

"numberValue": "0", 

"stringValue": "xy2434"

},

{

"id": "182",

"intValue": "0",

"numberValue": "0", 

"stringValue": "ABCDEFG"

}

}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00002 - NULL LOGIN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00008 - INVALID LOGIN

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00024 - INVALID LOGIN FORMAT

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

Get Users by Date Range Web Service

Get User by Date Range Web Service

The Get Users by Date Range web service allows you to retrieve user info from Webassessor™ by within a specified date range. The date range is limited to a 7 day period.

Get Users by Date Range Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (set to GET USERS BY Date Range)

  • securityToken

  • startDateYYYY-MM-DD 00:00:00

  • endDateYYYY-MM-DD 00:00:00

  • ReturnFormat

Calling the Get Users by Date Range Web Service with JSON

Here is an example JSON object:

JSON
{

"requestType":" GET USERS BY DATE RANGE ", 

"securityToken":"12345678-1234-1234-1234-123456789012",

"startDate":2022-01-01, 

"endDate":2022-12-31,

"returnFormat":"JSON"

}

Example Get Users by Date Range Web Service Call JSON Return Value

The following is an example of what the return value would look like upon successful completion of a Get Users by Date Range web service call in JSON.

JSON
{ 

"addressCity": "Chandler", 

"addressCountry": "United States", 

"addressPostalCode": "85286", 

"addressState": "Arizona", 

"addressStreet1": "12345", 

"addressStreet2": [], 

"clientRegion": {

"id": "16674",

"name": "Jon_Testing"

},

"customFieldValue": { 

"customFieldId": "2099980", 

"customFieldText": "Test", 

"intValue": "0", 

"stringValue": "yes"

},

"email": "jdoe@kryteriononline.com(666666666666)", 

"firstName": "Jon",

"homePhone": [],

"id": "5866340",

"lastName": "Doe", 

"login": "jon_tester", 

"dateCreated": 

"dateModified": 

"Active/Inactive:" 

"userDefined1": []

}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00041 - INVALID DATE RANGE CODE

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

Get User by Email Web Service

Get User by Email Web Service

The Get User by Email web service allows clients to retrieve candidate account info from Webassessor™ by using the email associated with the account.

Get User by Email Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (set to GET USER BY EMAIL)

  • securityToken

  • email

  • returnFormat

Calling the Get User by Email Web Service with JSON

Here is an example JSON object:

JSON
{
    "requestType": "GET USER BY EMAIL",
    "securityToken": "{{ExampleSecurityToken}}",
    "email": "JohnChai1@kryteriontest.com",
    "returnFormat": "JSON"
}

Example Get User by Email Web Service Call JSON Return Value

The following is an example of what the return value would look like upon successful completion of a Get User by Email web service call in JSON.

JSON
{
    "addressCity": "Phoenix",
    "addressCountry": "United States",
    "addressPostalCode": "85044",
    "addressState": "Arizona",
    "addressStreet1": "7776 S. Pointe Pkwy W",
    "addressStreet2": "EDITED",
    "clientRegion": {
        "id": "16226",
        "name": "John Brand"
    },
    "customFieldValue": [
        {
            "customFieldId": "2100152",
            "customFieldText": "CandidateCustomField1",
            "intValue": "0",
            "stringValue": []
        },
        {
            "customFieldId": "2100195",
            "customFieldText": "REQ-36140",
            "intValue": "0",
            "stringValue": []
        }
    ],
    "email": "JohnChai1@kryteriontest.com",
    "firstName": "John",
    "homePhone": "6026594660",
    "id": "3994977",
    "lastName": "Chai",
    "login": "JohnChai1@kryteriontest.xom",
    "userDefined1": []
}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

  • WAWSE-00100 - INVALID INPUT

Get User by ID Web Service

Get User by ID Web Service

The Get User by ID web service allows you to retrieve user info from Webassessor™ by the user object’s numerical ID.

Get User by ID Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to GET USER BY ID)

  • userId

  • securityToken

  • ReturnFormat

Calling the Get User by ID Web Service with JSON

Here is an example of JSON object:

JSON
{

"requestType":" GET USER BY ID ", 

"securityToken":"12345678-1234-1234-1234-123456789012",

"userId":1234, 

"returnFormat":"JSON"

}

Example Get User by ID Web Service Call JSON Return Value

The following is an example of what the return value would look like upon successful completion of a Get User by ID web service call in JSON.

JSON
{

"addressCity": "Chicago", 

"addressCountry": "United States", 

"addressPostalCode": "60013-0001", 

"addressState": "Illinois", 

"addressStreet1": "555 Main Street",

"addressStreet2": "Suite 99", “clientRegion”:

{

“id”: “1234”,

“name”: “Acme Co. North America”

},

"email": "john@beatles.com", 

"fax": "(480) 555-1212",

"firstName": "John",

"homePhone": "911-9999",

"id": "425660",

"lastName": "Lennon", 

"login": "JohnLennon",

"customFields": [

{

"id": "181",

"intValue": "0",

"numberValue": "0", 

"stringValue": "xy2434"

},

{

"id": "182",

"intValue": "0",

"numberValue": "0", 

"stringValue": "ABCDEFG"

}

}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00010 - INVALID USER ID

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

Get Custom Fields Web Service

Get Custom Fields Web Service

The Get Custom Fields web service allows you to retrieve a list of all available custom fields so that you may look up the correct custom field id to be used in other web services.

For instance, in order to use the Add User web service, you must supply custom field ids for any custom fields that you associate with the user. This web service allows you to look them up.

Get Custom Fields Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be GET CUSTOM FIELDS)

  • returnFormat

  • securityToken

Calling the Get Custom Fields Web Service with JSON

Here is an example JSON object:

JSON
{

"requestType": "GET CUSTOM FIELDS",

"securityToken": "12345678-1234-1234-1234-123456789012",

"returnFormat": "JSON"

}

Example Get Custom Fields Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of a Get Custom Fields web service call in JSON.

JSON
{

"id": "123456789",

"required": "false",

"resourceKeyName": "Some custom field:", "type": "STRING"

}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

Add User Web Service

Add User Web Service

The Add User web service allows you to add a user with the role of a Test Taker to Webassessor™.

Add User Request Parameters

These are the allowable field names (* indicates optional fields):

  • requestType (ADD USER)

  • securityToken

  • login (user’s login name, must be unique)

  • firstName

  • lastName

  • email

  • password

  • sendEmail

  • returnFormat

  • customFields(Object)

  • (Please look below for request

  • fields)

  • addressStreet1

  • addressStreet2*

  • addressCity

  • addressState

  • addressPostalCod

  • addressCountry

  • userDefined1

  • notes

  • homePhone

Calling the Add User Web Service with JSON

Here is an example JSON object:

JSON
{

"requestType": "ADD USER",

"securityToken": "***********” "login": "testadd", 

"firstName": "testi",

"lastName": "xxxxx",

"email": "prashsdf@gmail.com", 

"returnFormat": "JSON",

"addressCity": "Columbia",

"addressCountry": "United States", 

"addressPostalCode": "21044", 

"addressState": "ARIZONA",

"addressStreet1": "11000 Broken Land Parkway", 

"addressStreet2": "",

"homePhone": "", 

"customFields": [

{"id":"831","stringValue":"No"},

{"id":"2089231","numberValue":"1235"},

{"id":"2089229","intValue":"1"},

{"id":"2089230","dateValue":"2018-12-23"},

{"id":"2092028","optionValue":"Chevy"},

{"id":"2099419","StringValue":"hi"}

],

"sendEmail": false

}


Example Add User Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of an Add User web service call in JSON.

JSON
{

"addressCity": "Columbia",

"addressCountry": "United States",

"addressPostalCode": "21044",

"addressState": "ARIZONA",

"addressStreet1": "11000 Broken Land Parkway",

"addressStreet2": [],

"clientRegion": {

"id": "1",

"name": "Kryterion Default Region"

},

"customFieldValue": [

{

"customFieldId": "831", 

"customFieldText": "Approved to test", 

"intValue": "0",

"stringValue": "No"

},

{

"customFieldId": "2089230", 

"customFieldText": "Date Custom Field", 

"dateValue": "2018-12-23T00:00:00-07:00",

"intValue": "0"

},

{

"customFieldId": "2089229", 

"customFieldText": "Integer Custom Field", 

"intValue": "1"

},

{

"customFieldId": "2099419", 

"customFieldText": "test", 

"intValue": "0"

},

{

"customFieldId": "2089231", 

"customFieldText": "Numeric Custom Field", 

"intValue": "0",

"numberValue": "1235.0"

},

{

"customFieldId": "2092028", 

"customFieldText": "Test View", 

"intValue": "0",

"stringValue": "Chevy"

}

],


"email": 

"prashsdf@gmail.com", 

"firstName": "testi", 

"homePhone": [],

"id": "5766445",

"lastName": "xxxxx",

"login": "testadd", 

"password": "@$ckBa6Mh9"

}
Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00002 - NULL LOGIN

  • WAWSE-00004 – NULL/INVALID FIRST NAME

  • WAWSE-00006 - NULL PASSWORD

  • WAWSE-00007 - NULL PASSWORD SECRET

  • WAWSE-00013 – NULL/INVALID LAST NAME

  • WAWSE-00014 - NULL ADDRESS STREET

  • WAWSE-00015 - NULL ADDRESS CITY

  • WAWSE-00016 - NULL ADDRESS POSTAL CODE

  • WAWSE-00017 - NULL ADDRESS COUNTRY

  • WAWSE-00018 - INVALID COUNTRY

  • WAWSE-00019 - INVALID STATE/PROVINCE

  • WAWSE-00021 - INVALID FAX

  • WAWSE-00022 - INVALID PHONE

  • WAWSE-00024 - INVALID LOGIN FORMAT

  • WAWSE-00026 - INVALID POSTAL CODE

  • WAWSE-00027 - INVALID NAME

  • WAWSE-00029 - INVALID STREET ADDRESS

  • WAWSE-00034 - INVALID PROVINCE FOR COUNTRY

  • WAWSE-00035 - INVALID ADDRESS CITY

  • WAWSE-00039 - INVALID FAX LENGTH

  • WAWSE-00040 - INVALID PHONE LENGTH

  • WAWSE-00043 - INVALID SECRET LENGTH

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

  • WAWSE-00098 - INVALID ADDRESS STATE

Edit User Web Service

Edit User Web Service

The Edit User web service allows you to edit an existing user in Webassessor™.

Edit User Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to EDIT USER)

  • login (user’s login name, must be unique)

  • firstName*

  • lastName*

  • email*

  • notes*

  • homePhone*

  • custom fields*

  • returnFormat

  • securityToken

  • addressStreet1*

  • addressStreet2*

  • addressCity*

  • addressState*

  • addressPostalCode*

  • addressCountry*

  • sendEmail

Calling the Edit User Web Service with JSON

The edit user API resides in the external-webservices project. Prior to release 18, the client sends all the fields mentioned below as part of the web service request in order to edit a single user field.

Request:

JSON
{

"requestType": "EDIT USER",

"securityToken": "0dhcg632-ld99-26nc-1lo9-chsdg9m823hh",

"login": "testadd",

"firstName": "Greg",

"lastName": "White11", 

"email": "prashsdf@gmail.com",

"returnFormat":"JSON",

"addressCity": "Columbia",

"addressCountry":"USA",

"addressPostalCode": "21044", 

"addressState": "US-MD",

"addressStreet1": "11000 Broken Land Parkway East",

"addressStreet2": "",

"homePhone": "",

"customFields":

[

{"id":"2092028","stringValue":"No"}

]

}

```

{

"addressCity": "Columbia",

"addressCountry": "United States",

"addressPostalCode": "21044", 

"addressState": "Maryland",


"id": "1",

"name": "Kryterion Default Region"

},

"customFieldValue": [

{

"customFieldId": "831", 

"customFieldText":"Approved to test", 

"intValue": "0",

"stringValue": "No"

},

{

"customFieldId": "2089230", 

"customFieldText": "Date Custom Field",

"dateValue": "2018-12-23T00:00:00-07:00",

"intValue": "0"

},

{

"customFieldId": "2089229", 

"customFieldText": "Integer Custom Field",

"intValue": "1"

},

{

"customFieldId": "2099419", 

"customFieldText": "test", 

"intValue": "0"

},

{

"customFieldId": "2089231", 

"customFieldText": "Numeric Custom Field",

"intValue": "0",

"numberValue": "1235.0"

},

{

"customFieldId": "2092028", 

"customFieldText": "Test View",

"intValue": "0",

"stringValue": "No"

}

],

"email": "prashsdf@gmail.com",

"firstName": "Greg",

"homePhone": [],

"id": "5766445",

"lastName": "White11",

"login": "testadd"

}


Edit User Single Field Web Service

Edit User Single Field Web Service

Allow clients to update a single user or custom field without altering the remaining fields.

Update Last Name only

Request:

JSON
{

"requestType": "EDIT USER", 

"securityToken": "0d****[REDACTED]****", 

"returnFormat": "JSON",

"login": "testtaker1", 

"lastName": "Edison"

}

Request:

JSON
{

"addressCity": "Phoenix", 

"addressCountry": "United States", 

"addressPostalCode": "85048", 

"addressState": "Arizona", 

"addressStreet1": "4486 Dye Street", 

"addressStreet2": "",

"clientRegion": { 

"id": "1866",

"name": " SomeClientRegionName"

},

"customFieldValue": [

{

"intValue": "0", 

"stringValue": "Private"

},

{

"intValue": "0", 

"stringValue": "Yes"

}

],

"email": "jvwmxv3cvsc@fakemailgenerator.net",

"firstName": "Dorothy",

"homePhone": "4807594113",

"id": "981863",

"lastName": "Edison", 

"login": "testtaker1"

"id": "981863",

"lastName": "Edison", 

"login": "testtaker1"

}

Update First Name Only

Request:

JSON
{

"requestType": "EDIT USER", 

"securityToken": "0d****[REDACTED]****", 

"returnFormat": "JSON",

"login": "testtaker1", 

"firstName": "Freddie"

}

Request:

JSON
{

"addressCity": "Phoenix", 

"addressCountry": "United States", 

"addressPostalCode": "85048", 

"addressState": "Arizona", 

"addressStreet1": "4486 Dye Street", 

"addressStreet2": "",

"clientRegion": { 

"id": "1866",

"name": "SomeClientRegionName"

},

"customFieldValue": [

{

"intValue": "0", 

"stringValue": "Private"

},

{

"intValue": "0", 

"stringValue": "Yes"

}

],

"email": "jvwmxv3cvsc@fakemailgenerator.net", 

"firstName": "Freddie",

"homePhone": "4807594113",

"id": "981863",

"lastName": "Edison", 

"login": "testtaker1"

}

Note: Prior to release 18, sending only the interested field(s) as part of the request will cause the web service to throw validation errors like "You must supply a last name and should not be more than 50-character length.".

Update Custom Field Values

The edit user API allows clients to add just the custom fields to the payload without having to include all the user fields.

Request:

JSON
{

"requestType": "EDIT USER", 

"securityToken": "0d****[REDACTED]****", 

"returnFormat": "JSON",

"login": "testtaker1", 

"customFields":

[

{"id":"2085399","stringValue":"Private"},

{"id":"2085398","stringValue":"No"}

]

}

Request:

JSON
{

"addressCity": "Phoenix", 

"addressCountry": "United States", 

"addressPostalCode": "85048", 

"addressState": "Arizona", 

"addressStreet1": "4486 Dye Street", 

"addressStreet2": "",

"clientRegion": { 

"id": "1866",

"name": "SomeClientRegionName"

},

"customFieldValue": [

{

"customFieldId": "2085399",

"customFieldText": "Your role focuses primarily on which sector?", 

"intValue": "0",

"stringValue": "Private"

},

{

"customFieldId": "2085398", 

"customFieldText": "Verification Opt-In:", 

"intValue": "0",

"stringValue": "No"

}


],

"email": "jvwmxv3cvsc@fakemailgenerator.net", 

"firstName": "Freddie",

"homePhone": "4807594113",

"id": "981863",

"lastName": "Edison", 

"login": "testtaker1"

}

Update only a single custom field value

Clients can update a single custom field value without sending all the custom field values.

Request:

JSON
{

"requestType": "EDIT USER", 

"securityToken": "0d****[REDACTED]****", 

"returnFormat": "JSON",

"login": "testtaker1", 

"customFields":

[

{"id":"2085398","stringValue":"Yes"}

]

}

Request:

JSON
{

"addressCity": "Phoenix", 

"addressCountry": "United States", 

"addressPostalCode": "85048", 

"addressState": "Arizona", 

"addressStreet1": "4486 Dye Street", 

"addressStreet2": "",

"clientRegion": { 

"id": "1866",

"name": “SomeClientRegionName”

},

"customFieldValue": [

{

"customFieldId": "2085399",

"customFieldText": "Your role focuses primarily on which sector?", 

"intValue": "0",

"stringValue": "Private"

},

{

"customFieldId": "2085398",

"customFieldText": "Verification Opt-In:", 

"intValue": "0",

"stringValue": "Yes"

}

],

"email": "jvwmxv3cvsc@fakemailgenerator.net", 

"firstName": "Freddie",

"homePhone": "4807594113",

"id": "981863",

"lastName": "Edison", 

"login": "testtaker1"

}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00002 - NULL LOGIN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00018 - INVALID COUNTRY

  • WAWSE-00019 - INVALID STATE/PROVINCE

  • WAWSE-00021 - INVALID FAX

  • WAWSE-00022 - INVALID PHONE

  • WAWSE-00024 - INVALID LOGIN FORMAT

  • WAWSE-00026 - INVALID POSTAL CODE

  • WAWSE-00027 - INVALID NAME

  • WAWSE-00029 - INVALID STREET ADDRESS

  • WAWSE-00034 - INVALID PROVINCE FOR COUNTRY

  • WAWSE-00035 - INVALID ADDRESS CITY

  • WAWSE-00039 - INVALID FAX LENGTH

  • WAWSE-00040 - INVALID PHONE LENGTH

  • WAWSE-00043 - INVALID SECRET LENGTH

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

  • WAWSE-00068 - INVALID CITIZENSHIP COUNTRY

  • WAWSE-00098 - INVALID ADDRESS STATE

Delete User Web Service

Delete User Web Service

The Delete User web service allows you to delete a Test Taker in Webassessor™.

Please note that for safety reasons, the record is not actually deleted, but rather inactivated.

Delete User Request Parameters

These are the allowable field names (*indicates an optional field):

  • requestType (must be set to GET USER BY ID)

  • login

  • securityToken

  • ReturnFormat

Calling the Delete User Web Service with JSON

Here is an example JSON object:

JSON
{

"requestType": "DELETE USER",

"securityToken": "12345678-1234-1234-1234-123456789012",

"login": "JohnDoe",

"returnFormat": "JSON"

}

Example Delete User Web Service Call JSON Return Value

The following is an example of what the return value would look like upon a successful completion of a Delete User web service call in JSON.

JSON
{

"id": "0",

"login": "JohnLennon"

}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00002 - NULL LOGIN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00008 - INVALID LOGIN

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00024 - INVALID LOGIN FORMAT

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

Vouchers and Coupons Web Services

Get Active Unassigned Vouchers Web Service

Get Active Unassigned Vouchers Web Service

The Get Active Unassigned Vouchers web service enables clients to retrieve information on all active, unassigned-type voucher batches that still have any unassigned vouchers and were created within a given date/time range. The date range is limited to a 7 day period.

Clients must provide the date/time range the voucher batches were created to use the Get Active Unassigned Vouchers web service.

JSON
{

 "requestType":"GET ACTIVE UNASSIGNED VOUCHERS",

 "securityToken":"ExampleSecurityToken",

 "startDate": "2024-08-08 00:00:00",

 "endDate": "2024-08-09 23:59:59",

 "returnFormat":"JSON"

}

Example Get Unassigned Vouchers by Batch Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of a Get Custom Fields web service call in JSON.

JSON
[

 {

 "creationDate": "2024-08-09T14:00:23-07:00",

 "creator": "JohnChai",

 "description": [],

 "exams": "54961,57104,58700,68551,70696",

 "quantity": "1",

 "remainingVouchers": "1",

 "status": "ACTIVE",

 "voucherExpirationDate": "2024-08-16T23:59:00-07:00",

 "voucherLastExamDate": "2024-08-16T23:59:00-07:00",

 "voucherName": "REQ-37568test",

 "voucherUnit": "Percentage",

 "voucherValue": "100"

 }

]


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00038 - NULL DATE

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00041 - INVALID DATE RANGE CODE

  • WAWSE-AV0001 - NO ACTIVE UNASSIGNED VOUCHER BATCHES FOUND

  • WAWSE-AV0002 - TOO MANY ACTIVE VOUCHER BATCHES FOUND

Get Unassigned Vouchers by Batch Web Service

Get Unassigned Vouchers by Batch Web Service

The Get Unassigned Vouchers by Batch web service allows you to retrieve information on a voucher batch which are of type unassigned category so that you may look up the total quantity of the voucher codes and the remaining count available, voucher batch expiration date etc.

For instance, to use the Get Unassigned Vouchers by Batch web service, you must supply voucher name, security token for the specific client region and the request type must be GET UNASSIGNED VOUCHERS BY BATCH

Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (GET UNASSIGNED VOUCHERS BY BATCH)

  • securityToken

  • voucherName

  • returnFormat

Example Get Unassigned Vouchers by Batch Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of a Get Custom Fields web service call in JSON.

JSON
{

"creationDate": "2024-03-27T16:10:24-07:00",

"creator": "PraveenTumu",

"description": [],

"exams": "3,126,494,1354,1398,2174,70565",

"quantity": "8",

"remainingVouchers": "8",

"status": "ACTIVE",

"voucherExpirationDate": "2024-03-29T23:59:00-07:00",

"voucherLastExamDate": "2024-03-29T23:59:00-07:00",

"voucherName": "ptVoucher2",

"voucherUnit": "Percentage",

"voucherValue": "100"

}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-VB0002 – THE VOUCHER NAME CANNOT BE NULL

  • WAWSE-VB0013 – VOUCHER BATCH DOES NOT EXIST

  • WAWSE-VB0015 – ONLY SUPPORTS UNASSIGNED VOUCHERS

Add Voucher Batch Web Service

Add Voucher Batch Web Service

The Add Voucher Batch web service allows client to create a new voucher batch via API. The following 4 types of vouchers are able to be created through this API:

  • Assigned Vouchers

    • These voucher batches will create a voucher batch that can be assigned to any number of candidates.

    • These voucher batches can be assigned via API with our “Assign Voucher Batch to Users” API.

    • Each voucher code will only be usable by the candidate account it is assigned to.

  • Unassigned Vouchers

    • These voucher batches will create a number of voucher codes, which can be provided to candidates for use during exam registration.

  • Test Completion Vouchers

    • These voucher batches will create a voucher batch that will automatically assign vouchers to candidates based on the completion parameters of an exam or set of exams.

    • Each parameter must be specified for each exam at the exam level.

  • Client-Provided Vouchers

    • These voucher batches will create a voucher batch that clients can upload an excel spreadsheet to containing the individual voucher codes to be used by candidates.

    • The “alertNumber” will alert clients when the number of available voucher codes matches the provided number.

Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (ADD VOUCHER BATCH)

  • securityToken

  • voucherName

  • clientName

  • clientRegionName

  • expirationDate

  • lastExamDate*

  • exams

  • assignment

    • assignedVoucher - true or null

    • unassignedAmount - number or null

    • basedOnTestCompletion - true or null

    • alertAmount - number or null

  • description*

  • status

  • value

    • amount - number

    • percentage - number

  • emailDomains*

  • countryNames

  • returnFormat

Add Assigned Voucher Batch Example

Calling the Add Voucher Batch Web Service (for Assigned Vouchers) with JSON

An example request JSON object:

JSON
{
    "requestType": "ADD VOUCHER BATCH",
    "securityToken": "{{ExampleSecurityToken}}",
    "voucherName": "Ex Assigned Voucher",
    "expirationDate": "01/05/2027",
    "lastExamDate": "01/05/2027", 
    "exams": ["PR000115"],
    "assignment": {"assignedVoucher": true},
    "description": "Example Description",
    "status": "ACTIVE",
    "value": {"percentage": 100},
    "emailDomains": ["example.net"],
    "countryNames": ["United States","Denmark"],
    "returnFormat": "JSON"
}

Example Add Voucher Batch Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of the “ADD VOUCHER BATCH” web service call in JSON.

JSON
{
    "dateCreated": "2026-03-24T09:20:14.033-07:00",
    "voucherName": "Ex Assigned Voucher"
}
Add Unassigned Voucher Batch Example

Calling the Add Voucher Batch Web Service (for Unassigned Vouchers) with JSON

An example request JSON object:

JSON
{
    "requestType": "ADD VOUCHER BATCH",
    "securityToken": "{{ExampleSecurityToken}}",
    "voucherName": "Ex Unassigned Voucher",
    "expirationDate": "01/05/2027",
    "lastExamDate": "01/05/2027", 
    "exams": ["PR000115"],
    "assignment": {"unassignedAmount": 2},
    "description": "Example Description",
    "status": "ACTIVE",
    "value": {"percentage": 100},
    "emailDomains": ["example.net"],
    "countryNames": ["United States","Denmark"],
    "returnFormat": "JSON"
}

Example Add Voucher Batch Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of the “ADD VOUCHER BATCH” web service call in JSON.

JSON
{
    "dateCreated": "2026-03-24T09:21:45.769-07:00",
    "voucherCodes": [
        "Auu32u26u7ePUvhv",
        "Agg32g26s8winBMu"
    ],
    "voucherName": "Ex Unassigned Voucher"
}
Add Test Completion Assignment Voucher Batch Example

Calling the Add Voucher Batch Web Service (for Vouchers Assigned on Test Completion) with JSON

An example request JSON object:

JSON
{
    "requestType": "ADD VOUCHER BATCH",
    "securityToken": "{{ExampleSecurityToken}}",
    "voucherName": "Ex TestComp Voucher",
    "expirationDate": "01/05/2027",
    "lastExamDate": "01/05/2027", 
    "exams": ["PR000115"],
    "assignment": {"basedOnTestCompletion": true},
    "description": "Example Description",
    "status": "ACTIVE",
    "value": {"amount": 250},
    "emailDomains": ["example.net"],
    "countryNames": ["United States","Denmark"],
    "returnFormat": "JSON"
}

Example Add Voucher Batch Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of the “ADD VOUCHER BATCH” web service call in JSON.

JSON
{
    "dateCreated": "2026-03-24T09:23:00.866-07:00",
    "voucherName": "Ex TestComp Voucher"
}
Add Client-Provided Voucher Batch Example

Calling the Add Voucher Batch Web Service (for Client-Provided Vouchers) with JSON

An example request JSON object:

JSON
{
    "requestType": "ADD VOUCHER BATCH",
    "securityToken": "{{ExampleSecurityToken}}",
    "voucherName": "Ex Client Voucher",
    "expirationDate": "01/05/2027",
    "lastExamDate": "01/05/2027", 
    "exams": ["PR000115"],
    "assignment": {"alertAmount": 10},
    "description": "Example Description",
    "status": "ACTIVE",
    "value": {"amount": 50},
    "emailDomains": ["example.net"],
    "countryNames": ["United States","Denmark"],
    "returnFormat": "JSON"
}

Example Add Voucher Batch Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of the “ADD VOUCHER BATCH” web service call in JSON.

JSON
{
    "dateCreated": "2026-03-24T09:23:42.313-07:00",
    "voucherName": "Ex Client Voucher"
}

If you use assignedVoucher, basedOnTestCompletion or alertAmount as the assignment type, the response will not include the voucher codes.


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

  • WAWSE-VB0002 - THE VOUCHER NAME CANNOT BE NULL

  • WAWSE-VB0003 - THE EXAMS CANNOT BE NULL OR EMPTY

  • WAWSE-VB0004 - VOUCHER DESCRIPTION LENGTH EXCEEDED- MAX SIZE 500 CHARACTERS

  • WAWSE-VB0005 - THE DOMAIN NAME IS INVALID

  • WAWSE-VB0006 - THE CANDIDATE ASSIGNMENT IS INVALID

  • WAWSE-VB0007 - THE NUMBER OF ARGUMENTS IN CANDIDATE ASSIGNMENTS IS INVALID

  • WAWSE-VB0008- THE VOUCHER VALUE IS INVALID

  • WAWSE-VB0009 - THE NUMBER OF ARGUMENTS IN VALUE IS INVALID

  • WAWSE-VB0010 - PRODUCT CODE DOES NOT BELONG TO CLIENT REGION OR CODE IS INVALID

  • WAWSE-VB0011 - PROMOTION CODE EXISTS IN THE SYSTEM

  • WAWSE-VB0012 - THE DATE CODE SHOULD BE FUTURE DATE OR IS INVALID

  • WAWSE-VB0101 - INVALID COUNTRY NAME IN THE WHITELISTED COUNTRY LIST

  • WAWSE-VB0102 - PROBLEM OCCURRED DURING VOUCHER CREATION

Edit Voucher Batch Web Service

Edit Voucher Batch Web Service

The Edit Voucher Batch web service allows clients to edit voucher batches using an API call. Please note: All updates to voucher batches will apply to future voucher redemptions only. This includes when a candidate reuses their voucher after cancelling an exam registration.

Edit Voucher Batch Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (EDIT VOUCHER BATCH)

  • securityToken

  • voucherName

  • clientRegionName

  • expirationDate*

  • lastExamDate*

  • status*

  • exams*

  • description*

  • value* (percentage:% or amount:$)

  • allowedEmailDomains*

  • blockedEmailDomains*

  • countryNames*

  • returnFormat

Response Parameters

Here is an example JSON response:

JSON
{

 "requestType": "EDIT VOUCHER BATCH",

 "securityToken": "ExampleSecurityToken",

 "clientRegionName": "John Brand",

 "voucherName": "Example Voucher", 

 "status":"ACTIVE", 

 "exams": ["PR000001"],

 "value": {"percentage": 100},

 "expirationDate": "12/25/2025",

 "lastExamDate": "12/25/2025",

 "description": "Example Description",

 "countryNames": ["United States","Denmark"],

 "allowedEmailDomains": ["google.com"],

 "blockedEmailDomains": ["example.com"],

 "returnFormat": "JSON"

}

Example Edit Voucher Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of an Edit Voucher web service call in JSON:

JSON
{ 

 "response": "Products removed:[PR000001]and voucher is updated successfully",

 "voucherName": "Example Voucher" 

}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00058 - UNABLE TO FIND CLIENT REGION ID IN DATABASE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

  • WAWSE-VB0002 - THE VOUCHER NAME CANNOT BE NULL

  • WAWSE-VB0003 - THE EXAMS CANNOT BE NULL OR EMPTY

  • WAWSE-VB0004 - VOUCHER DESCRIPTION LENGTH EXCEEDED- MAX SIZE 500 CHARACTERS

  • WAWSE-VB0005 - THE DOMAIN NAME IS INVALID

  • WAWSE-VB0006 - THE CANDIDATE ASSIGNMENT IS INVALID

  • WAWSE-VB0008- THE VOUCHER VALUE IS INVALID

  • WAWSE-VB0009 - THE NUMBER OF ARGUMENTS IN VALUE IS INVALID

  • WAWSE-VB0010 - PRODUCT CODE DOES NOT BELONG TO CLIENT REGION OR CODE IS INVALID

  • WAWSE-VB0011 - PROMOTION CODE EXISTS IN THE SYSTEM

  • WAWSE-VB0012 - THE DATE CODE SHOULD BE FUTURE DATE OR IS INVALID

  • WAWSE-VB0013 - VOUCHER BATCH DOES NOT EXIST

  • WAWSE-VB0101 - INVALID COUNTRY NAME IN THE WHITELISTED COUNTRY LIST

  • WAWSE-VB0107 - VOUCHER NAME LENGTH EXCEEDED- MAX SIZE 25 CHARACTERS

  • WAWSE-VB0108 - INVALID_EMAIL_DOMAIN_CONFIGURATION

  • WAWSE-VB0109 - INVALID_EMAIL_DOMAIN_CODE

  • WAWSE-VB0111 - NO_UPDATABLE_FIELDS_IN_PAYLOAD_CODE

  • WAWSE-Ex0004 - NULL STATUS OR NOT A PROPER STATUS(ACTIVE/INACTIVE)

  • WAWSE-VB0016 - THE VOUCHER QUANTITY SHOULD BE GREATER THAN CURRENT VALUE

    INVALID_VOUCHER_ASSIGNMENT_MESSAGE - Please input a value greater than current value

  • WAWSE-VB0110 -INVALID_ASSIGNMENT_CODE

    INVALID_ASSIGNMENT_CODE_MESSAGE - The assignment type is not valid for updating the voucher batch

Assign Voucher Batch to Candidate Users Web Service

Assign Voucher Batch to Candidate Users Web Service

The Assign Voucher Batch web service allows you to create voucher codes and assigns to users via API.

Assign Voucher Batch to Candidate Users Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to ASSIGN VOUCHER BATCH TO USERS )

  • securityToken

  • candidateLogins

  • voucherName

  • sendEmail * (defaulted to false)

  • returnFormat

Calling the Assign Voucher Batch Web Service with JSON

Here is an example JSON object:

JSON
{

"requestType": "ASSIGN VOUCHER BATCH TO USERS",

"securityToken": "19b15bbb-d85b-47c0-8f37-f65eabff1e51", 

"voucherName": "TestVoucherBatch",

"sendEmail" : true,

candidateLogins": [

"candidate",

"sample"

],

"returnFormat": "JSON"

}

Example Assign Voucher Batch Web Service Call JSON Return Value

JSON
{

"users": [

{

"emailAddress": "dev1@kryteriononline.com(132454)", 

"login": "candidate",

"voucherCode": "AQm22Q2QmhjPN2AQ"

},

{

"emailAddress": "gvepanjeri@kryteriononline.com", 

"login": "sample",

"voucherCode": "AhA22h2hAVT8en3N"

}

],

"voucherName": "TestVoucherBatch"

}

Example not successful result

JSON
{

"candidateId": "0", 

"candidateLogins": [

"julydeploy", 

"junedeploy"

],

"certTypeId": "0",

"clientId": "0",

"clientRegionId": "0",

"errorCode": "WAWSE-VB0013 - VOUCHER BATCH DOES NOT EXIST",

"errorMessage": 

"com.kryterion.webassessor.webservices.exception.WebServicesException:

Voucher Batch does not exist",

"maxScore": "0",

"productId": "0", "randomizeResponse": "false",

"requestType": "ASSIGN VOUCHER BATCH TO USERS",

"returnFormat": "JSON",

"scaledScore": "0",

"securityToken": "19b15bbb-d85b-47c0-8f37-f65eabff1e51", 

"sendEmail": "true",

"syncLoginWithEmail": "false", 

"testingCenterId": "0",

"userId": "0",

"voucherName": "TestVoucherInvalid"

}


Possible Error Messages and codes

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-VB0002 - THE VOUCHER NAME CANNOT BE NULL

  • WAWSE-VB0013 - VOUCHER BATCH DOES NOT EXIST

  • WAWSE-VB0014 - INVALID CANDIDATE CREDENTIALS

Activate/Deactivate Voucher Batch Web Service

Activate/Deactivate Voucher Batch Web Service

It will activate/deactivate all the voucher codes under that voucher batch and makes the voucher active/inactive based on the Type of Action provided in the request parameters.

Activate Deactivate Voucher Batch Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to ACTIVATE DEACTIVATE VOUCHER BATCH )

  • securityToken

  • VoucherName

  • typeOfAction

  • returnFormat

Calling the Activate/Deactivate Voucher batch Web Service with JSON

Here is an example JSON object:

JSON
{

"voucherName": "CSME V01-10Mar08",

"securityToken": "0dhcg632-ld99-26nc-1lo9-chsdg9m823hh", 

"typeOfAction": "ACTIVATE",

"requestType": "ACTIVATE DEACTIVATE VOUCHER BATCH", 

"returnFormat": "JSON"

}

Example of a Response Object:

JSON
[
"All the Voucher codes under CSME V01-10Mar08 have been successfully activated"
]

Here is an example of another scenario where type of action is DEACTVAITE:

JSON
{

"voucherName": "CSME V01-10Mar08",

"securityToken": "0dhcg632-ld99-26nc-1lo9-chsdg9m823hh", 

"typeOfAction": "DEACTIVATE",

"requestType": "ACTIVATE DEACTIVATE VOUCHER BATCH", 

"returnFormat": "JSON"

}

Example of a Response Object:

JSON
[
"All the Voucher codes under CSME V01-10Mar08 have been successfully deactivated"
]

Example of Response Object When the voucher name is not provided in request parameters

JSON
{

"candidateId": "0",

"certTypeId": "0",

"clientId": "0",

"clientRegionId": "0",

"errorCode": "WAWSE-VB0002 - THE VOUCHER NAME CANNOT BE NULL",

"errorMessage": "com.kryterion.webassessor.webservices.exception.WebServicesException: The voucher name

is mandatory",

"inactiveProducts": "false", 

"issueNoRefund": "false", 

"keepActive": "false", 

"maxScore": "0",

"productId": "0", 

"randomizeResponse": "false",

"requestType": "ACTIVATE DEACTIVATE VOUCHER BATCH",

"returnFormat": "JSON",

"scaledScore": "0",

"securityToken": "0dhcg632-ld99-26nc-1lo9-chsdg9m823hh", 

"sendEmail": "false",

"syncLoginWithEmail": "false", 

"testingCenterId": "0", 

"typeOfAction": "DEACTIVATE",

"userId": "0",

"voucherName": []

}

Example of Response Object when Type of Action is not provided:

JSON
{

"candidateId": "0",

"certTypeId": "0",

"clientId": "0",

"clientRegionId": "0",

"errorCode": "WAWSE-VB0103 - THE TYPE OF ACTION NAME CANNOT BE NULL",

"errorMessage": "com.kryterion.webassessor.webservices.exception.WebServicesException: The TYPE OF 

ACTION name is mandatory",

"inactiveProducts": "false", 

"issueNoRefund": "false", 

"keepActive": "false", 

"maxScore": "0",

"productId": "0", 

"randomizeResponse": "false",

"requestType": "ACTIVATE DEACTIVATE VOUCHER BATCH",

"returnFormat": "JSON",

"scaledScore": "0",

"securityToken": "0dhcg632-ld99-26nc-1lo9-chsdg9m823hh", 

"sendEmail": "false",

"syncLoginWithEmail": "false", 

"testingCenterId": "0", 

"typeOfAction": [],

"userId": "0",

"voucherName": "CSME V01-10Mar08"

}

Example of Response Object when Type of Action is Invalid

JSON
{

"candidateId": "0",

"certTypeId": "0",

"clientId": "0",

"clientRegionId": "0",

"errorCode": "WAWSE-VB0104 - THE TYPE OF ACTION NAME IS INVALID",

"errorMessage": "com.kryterion.webassessor.webservices.exception.WebServicesException: The TYPE OF

ACTION CAN BE EITHER ACTIVATE OR DEACTIVATE",

"inactiveProducts": "false", 

"issueNoRefund": "false", 

"keepActive": "false", 

"maxScore": "0",

"productId": "0", 

"randomizeResponse": "false",

"requestType": "ACTIVATE DEACTIVATE VOUCHER BATCH",

"returnFormat": "JSON",

"scaledScore": "0",

"securityToken": "0dhcg632-ld99-26nc-1lo9-chsdg9m823hh", 

"sendEmail": "false",

"syncLoginWithEmail": "false", 

"testingCenterId": "0",

"typeOfAction": "3",

"userId": "0",

"voucherName": "CSME V01-10Mar08"

}

Example of Response Object when Voucher batch doesn’t Exist:

JSON
{

"candidateId": "0",

"certTypeId": "0",

"clientId": "0",

"clientRegionId": "0",

"errorCode": "WAWSE-VB0013 - VOUCHER BATCH DOES NOT EXIST",

"errorMessage": "com.kryterion.webassessor.webservices.exception.WebServicesException: Voucher Batch does

not exist",

"inactiveProducts": "false", 

"issueNoRefund": "false", 

"keepActive": "false", 

"maxScore": "0",

"productId": "0", 

"randomizeResponse": "false",

"requestType": "ACTIVATE DEACTIVATE VOUCHER BATCH",

"returnFormat": "JSON",

"scaledScore": "0",

"securityToken": "0dhcg632-ld99-26nc-1lo9-chsdg9m823hh", 

"sendEmail": "false",

"syncLoginWithEmail": "false", 

"testingCenterId": "0", 

"typeOfAction": "DEACTIVATE", 

"userId": "0",

"voucherName": "CSME V01-10Mar0"

}

Example of Response object when no voucher codes are not present for the provided voucher and when type of action is DEACTIVATE:

JSON
[
"The Voucher CSME V01-10Mar09 is deactivated"
]

Example of Response object when no voucher codes are not present for the provided voucher and when type of action is ACTIVATE:

JSON
[
"The Voucher CSME V01-10Mar09 is activated"
]


Possible Error Messages and codes

  • WAWSE-VB0103 - THE TYPE OF ACTION NAME CANNOT BE NULL

    • The TYPE OF ACTION name is mandatory

  • WAWSE-VB0104 - THE TYPE OF ACTION NAME IS INVALID

    • The TYPE OF ACTION CAN BE EITHER ACTIVATE OR DEACTIVATE

  • WAWSE-VB0013 - VOUCHER BATCH DOES NOT EXIST

    • Voucher Batch does not exist

  • WAWSE-VB0013 - VOUCHER BATCH DOES NOT EXIST

    • Voucher Batch does not exist

  • WAWSE-VB0002 - THE VOUCHER NAME CANNOT BE NULL

    • The voucher name is mandatory

Activate/Deactivate Voucher Code Web Service

Activate/Deactivate Voucher Code Web Service

The Activate/Deactivate Voucher Code web service enables clients to a specific voucher code in a voucher batch using an API call.

Activate/Deactivate Voucher Code Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (ACTIVATE DEACTIVATE VOUCHER CODE)

  • securityToken

  • voucherCodeName

  • typeOfAction (Activate or Deactivate)

  • returnFormat

Response Parameters

Here is an example JSON object:

JSON
{ 

 "requestType": "ACTIVATE DEACTIVATE VOUCHER CODE",

 "securityToken": "ExampleSecurityToken",

 "voucherCodeName": "ExampleVoucherCode",

 "typeOfAction": "ACTIVATE",

 "returnFormat": "JSON"

}

Example Activate/Deactivate Voucher Code Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of an Activate/Deactivate Voucher Code web service call in JSON:

JSON
[ 
 "The Voucher ExampleVoucherCode is activated"
]


Possible Error Messages

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-VB0015 - VOUCHER CODE DOES NOT EXIST

  • WAWSE-VB0104 - THE TYPE OF ACTION IS INVALID

Get Coupons Web Service

Get Coupons Web Service

The Get Coupons web services allows a Client to obtain details about their coupons by coupon name.

Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (GET COUPONS)

  • securityToken

  • couponCode

  • returnFormat

Example Get Unassigned Vouchers by Batch Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of an API NAME web service call in JSON.

JSON
{

 "Coupon Code":"Coupon Code/Name",

 "Coupon Value":"Value"

 "Coupon Unit": "Percentage or Dollar" 

 "Creation Date:"Coupon creation date", 

 "Total Coupon Uses": "Coupon uses" 

 "Creator": "Creator" 

 "Uses per Candidate": "Uses per candidate" 

 "Coupon Expiration Date": "Coupon Expiration Date 

 "Status": "Coupon Status" 

}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-CN001 - COUPON CODE IS NULL

Add Coupons Web Service

Add Coupons Web Service

The Add Coupons web service enables clients to create Webassessor coupons using an API call.

Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType

  • securityToken

  • couponName

  • expirationDate (MM/DD/YYYY)

  • lastExamDate (MM/DD/YYYY)

  • status

  • totalCouponUses

  • usesPerCandidate

  • couponValue (% or $ discount)

  • assignUsers

  • blockedEmailDomains*

  • returnFormat

Here is an example JSON object:

JSON
{ 

 "requestType": "ADD COUPON",

 "securityToken": "{{ExampleSecurityToken}}",

 "couponName": "ExampleCoupon1",

 "expirationDate": "12/25/2025",

 "lastExamDate" :"12/25/2026",

 "status": "ACTIVE",

 "totalCouponUses": "10",

 "usesPerCandidate": "1",

 "couponValue": {"percentage":100} OR {"amount":50}, 

 "assignUsers": "MANUAL",

 "blockedEmailDomains": ["example.com"],

 "returnFormat": "JSON"

}

Example Add Coupons Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful

completion of an Add Coupons web service call in JSON.

JSON
{ 

 "couponName": "ExampleCoupon",

 "dateCreated": "2024-11-29T09:35:50.966-07:00"

}


Possible Error Messages

  • WAWSE-00038 - NULL DATE

  • WAWSE-CN002 - THE COUPON NAME CANNOT BE NULL

  • WAWSE-CN003 - COUPON DESCRIPTION LENGTH EXCEEDED- MAX SIZE 500

  • CHARACTERS

  • WAWSE-CN004 - THE DOMAIN NAME IS INVALID

  • WAWSE-CN005- THE COUPON VALUE IS INVALID

  • WAWSE-CN006 - THE NUMBER OF ARGUMENTS IN VALUE IS INVALID

  • WAWSE-CN008 - THE DATE CODE SHOULD BE FUTURE DATE OR IS INVALID

  • WAWSE-CN0010 - INVALID_COUPON_USES_CODE

  • WAWSE-CN0011 - INVALID_USES_PER_CANDIDATE_CODE

  • WAWSE-CN0013 -MULTIPLE_COUPON_EMAIL_DOMAIN_CODE

  • WAWSE-CN0014 - INVALID_USES_PER_CANDIDATE_VALUE_CODE

  • WAWSE-CN0015- NULL_COUPON_VALUE_CODE

  • WAWSE-CN0016- MISSING_USES_PER_CANDIDATE_CODE

  • WAWSE-Ex0004 - NULL STATUS OR NOT A PROPER STATUS(ACTIVE/INACTIVE)

  • WAWSE-VB0109 -INVALID_EMAIL_DOMAIN_CODE

Edit Coupon Web Service

Edit Coupon Web Service

The Edit Coupon web service allows clients to edit unused, unassigned voucher batches using an API call.

Edit Coupon Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (EDIT COUPON)

  • securityToken

  • couponName

  • expirationDate*

  • description*

  • exams*

  • couponValue*

  • totalCouponUses*

  • usesPerCandidate*

  • allowedEmailDomains*

  • status*

  • returnFormat

Response Parameters

Here is an example JSON response:

JSON
{

 "requestType": "EDIT COUPON",

 "securityToken": "ExampleSecurityToken",

 "couponName": "Example Coupon", 

 "expirationDate": "12/25/2029",

 "description": "Example Coupon Description", 

 "exams": ["PR000001"],

 "couponValue": {"amount": 100 OR "percentage": 100},
 
 "totalCouponUses": "100",

 "usesPerCandidate": "1",

 "allowedEmailDomains": ["example.com"],
 
 "status":"ACTIVE",

 "returnFormat": "JSON"

}

Example Edit Coupon Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of an Edit Coupon web service call in JSON:

JSON
{
    "couponName": "Example Coupon",
    "response": "Coupon Updated Successfully"
}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00058 - UNABLE TO FIND CLIENT REGION ID IN DATABASE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

  • WAWSE-VB0005 - THE DOMAIN NAME IS INVALID

  • WAWSE-VB0006 - THE CANDIDATE ASSIGNMENT IS INVALID

  • WAWSE-VB0009 - THE NUMBER OF ARGUMENTS IN VALUE IS INVALID

  • WAWSE-VB0010 - PRODUCT CODE DOES NOT BELONG TO CLIENT REGION OR CODE IS INVALID

  • WAWSE-VB0012 - THE DATE CODE SHOULD BE FUTURE DATE OR IS INVALID

  • WAWSE-VB0108 - INVALID_EMAIL_DOMAIN_CONFIGURATION

  • WAWSE-VB0109 - INVALID_EMAIL_DOMAIN_CODE

  • WAWSE-VB0111 - NO_UPDATABLE_FIELDS_IN_PAYLOAD_CODE

  • WAWSE-Ex0004 - NULL STATUS OR NOT A PROPER STATUS(ACTIVE/INACTIVE)

Registration Web Services

Get Registrations by Date Range Web Service

Get Registrations by Date Range Web Service

The Get Registrations by Product Code web service allows you to retrieve all transcripts for a given product. The start date and end date are the modified date and not the created date. Now event date and location details are added in the response. Now the Date range between startDate and endDate is limited to 7 days.

If there are more than ~800 records, the API may return a 404 Error.

Possible values for the below values in the response:

  • Progress: COMPLETED, SCHEDULED, IN_PROGRESS, SCHEDULEDSUSPENDED

  • Status: NORMAL, PAUSED, SUSPENDED, CANCELLED, PENDING_SALE

Get Registrations by Date Range Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to GET REGISTRATIONS BY DATE RANGE)

  • startDate

  • endDate

  • securityToken

  • returnFormat

Calling the Get Registrations by Date Range Code Web Service with JSON

Here is an example JSON object:

JSON
{
    "requestType":"GET REGISTRATIONS BY DATE RANGE",
    "securityToken":"{{ExampleSecurityToken}}",
    "startDate":"2026-03-03 09:27:34",
    "endDate":"2026-03-03 23:59:59",
    "returnFormat":"JSON"
}

Example Get Registrations by Date Range Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of a Get Registrations by Date Range web service call in JSON.

Please note:

  • The “promotionCodes” field is only displayed when a voucher or coupon was used during registration and displays the voucher batch name or the coupon name.\

  • The “voucherCodes” field is only displayed when a voucher was used during registration and displays the specific voucher code used.

JSON
[
    {
        "candidate": {
            "addressCity": "Phoenix",
            "addressCountry": "United States",
            "addressPostalCode": "85044",
            "addressState": "Arizona",
            "addressStreet1": "7776 S. Pointe Pkwy W",
            "addressStreet2": "EDITED",
            "clientRegion": {
                "id": "16226",
                "name": "John Brand"
            },
            "email": "jchai@kryteriononline.com",
            "firstName": "John",
            "homePhone": "6026594660",
            "id": "3994977",
            "lastName": "Chai",
            "login": "JohnChai1@kryteriontest.xom",
            "userDefined1": []
        },
        "deliveryType": "WRAPPER_PROCTORED",
        "eventDate": "2026-05-20T01:00:00-07:00",
        "id": "16705881",
        "notes": [],
        "productCode": "PR000225",
        "productId": "68551",
        "progress": "SCHEDULED",
        "promotionCodes": "REQ-40082Test",
        "regTransactionId": "0",
        "registrationDate": "2026-04-07T08:16:42-07:00",
        "status": "NORMAL",
        "timeElapsedInMillis": "0",
        "timeRemainingInMillis": "0",
        "timeZone": "America/Phoenix",
        "voucherCodes": "AyyD2y25DWhzdjnU"
    }
]


Possible Error Messages

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00038 - NULL DATE

  • WAWSE-00042 - UNPARSEABLE DATE

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00048 - NULL PRODUCT CODE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

  • WAWSE-00041 - INVALID DATE RANGE CODE

Get Registrations Web Service

Get Registrations Web Service

The Get Registrations web service allows you to retrieve all transcripts for a given user.

Possible values for the below values in the response:

  • Progress: COMPLETED, SCHEDULED, IN_PROGRESS, SCHEDULEDSUSPENDED

  • Status: NORMAL, PAUSED, SUSPENDED, CANCELLED, PENDING_SALE

Get Registrations Request Parameters

These are the allowable field names (*indicates an optional field):

  • requestType (must be set to GET REGISTRATIONS BY USER

  • login

  • securityToken

  • returnFormat

Calling the Get Registrations Web Service with JSON

Here is an example JSON object:

JSON
{
    "requestType":"GET REGISTRATIONS",
    "securityToken":"{{ExampleSecurityToken}}",
    "login":"JohnChai10@kryteriontest.xom",
    "returnFormat":"JSON"
}

Example Get Registrations Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of a Get Registrations web service call in JSON.

Please note:

  • The “promotionCodes” field is only displayed when a voucher or coupon was used during registration and displays the voucher batch name or the coupon name.\

  • The “voucherCodes” field is only displayed when a voucher was used during registration and displays the specific voucher code used.

JSON
[
    {
        "candidate": {
            "addressCity": "Phoenix",
            "addressCountry": "United States",
            "addressPostalCode": "85044",
            "addressState": "Arizona",
            "addressStreet1": "7776 S. Pointe Pkwy W",
            "addressStreet2": "EDITED",
            "clientRegion": {
                "id": "16226",
                "name": "John Brand"
            },
            "email": "jchai@kryteriononline.com",
            "firstName": "John",
            "homePhone": "6026594660",
            "id": "3994977",
            "lastName": "Chai",
            "login": "JohnChai1@kryteriontest.xom",
            "userDefined1": []
        },
        "deliveryType": "WRAPPER_PROCTORED",
        "eventDate": "2026-05-20T01:00:00-07:00",
        "id": "16705881",
        "notes": [],
        "productCode": "PR000225",
        "productId": "68551",
        "progress": "SCHEDULED",
        "promotionCodes": "REQ-40082Test",
        "regTransactionId": "0",
        "registrationDate": "2026-04-07T08:16:42-07:00",
        "status": "NORMAL",
        "timeElapsedInMillis": "0",
        "timeRemainingInMillis": "0",
        "timeZone": "America/Phoenix",
        "voucherCodes": "AyyD2y25DWhzdjnU"
    }
]
Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00002 - NULL LOGIN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

Get Registrations by Product Code Web Service

Get Registrations by Product Code Web Service

The Get Registrations by Product Code web service allows you to retrieve all transcripts for a given product. The date range is limited to a 7 day period.

If there are more than ~800 records, The API returns 404 Error.

Possible values for the below values in the response:

  • Progress: COMPLETED, SCHEDULED, IN_PROGRESS, SCHEDULEDSUSPENDED

  • Status: NORMAL, PAUSED, SUSPENDED, CANCELLED, PENDING_SALE

Get Registrations by Product Code Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to GET REGISTRATIONS BY PRODUCT CODE)

  • productCode

  • SecurityToken

  • startDate

  • endDate

  • returnFormat

Calling the Get Registrations by Product Code Web Service with JSON

Here is an example JSON object:

JSON
{

"requestType": "GET REGISTRATIONS BY PRODUCT CODE",

"securityToken": "12345678-1234-1234-1234-123456789012",

"productCode": "PR000001", 

“startDate”: “2008-06-15 00:00:00”,

“endDate”: “2008-06-15 00:00:00”,

"returnFormat":"JSON"

}

Example Get Registrations by Product Code Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of a Get Registrations by Product Code web service call in JSON.

Please note:

  • The “promotionCodes” field is only displayed when a voucher or coupon was used during registration and displays the voucher batch name or the coupon name.\

  • The “voucherCodes” field is only displayed when a voucher was used during registration and displays the specific voucher code used.

JSON
[
    {
        "candidate": {
            "addressCity": "Phoenix",
            "addressCountry": "United States",
            "addressPostalCode": "85044",
            "addressState": "Arizona",
            "addressStreet1": "7776 S. Pointe Pkwy W",
            "addressStreet2": "EDITED",
            "clientRegion": {
                "id": "16226",
                "name": "John Brand"
            },
            "email": "jchai@kryteriononline.com",
            "firstName": "John",
            "homePhone": "6026594660",
            "id": "3994977",
            "lastName": "Chai",
            "login": "JohnChai1@kryteriontest.xom",
            "userDefined1": []
        },
        "deliveryType": "WRAPPER_PROCTORED",
        "eventDate": "2026-05-20T01:00:00-07:00",
        "id": "16705881",
        "notes": [],
        "productCode": "PR000225",
        "productId": "68551",
        "progress": "SCHEDULED",
        "promotionCodes": "REQ-40082Test",
        "regTransactionId": "0",
        "registrationDate": "2026-04-07T08:16:42-07:00",
        "status": "NORMAL",
        "timeElapsedInMillis": "0",
        "timeRemainingInMillis": "0",
        "timeZone": "America/Phoenix",
        "voucherCodes": "AyyD2y25DWhzdjnU"
    }
]
Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00038 - NULL DATE

  • WAWSE-00041 - INVALID DATE RANGE CODE

  • WAWSE-00042 - UNPARSEABLE DATE

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00048 - NULL PRODUCT CODE

  • WAWSE-00049 - DATE RANGE TOO LONG

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

Get Available Time Slots

Get Available Time Slots Web Service

The Get Available Time Slots web service allows clients to retrieve a list of available time slots to register for Online and Onsite Proctored exams.

The fromDate must be the current day or later and the toDate must be equal to or after the fromDate. The Date range between fromDate and toDate is limited to 7 days.

If there are more than ~800 records, the API will return a 404 Error.

Get Available OLP Time Slots by Date Range Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to “GET AVAILABLE TIME SLOTS”)

  • securityToken

  • login

  • examCode

  • deliveryType (“PROCTORED” (Onsite) or “WRAPPER_PROCTORED” (Online))

  • facilityCode* (required when deliveryType is set to “PROCTORED”)

  • timeZone

  • fromDate

  • toDate

  • dayPart*

    • EARLY_MORNING: 12:00 AM – 5:59 AM

    • MORNING: 6:00 AM – 11:59 AM

    • AFTERNOON: 12:00 PM – 5:59 PM

    • EVENING: 6:00 PM – 11:59 PM

    • ALL: Default; returns all time ranges

  • returnFormat

Please refer to https://timeapi.io/documentation/iana-timezones for a list of accepted time zones.

Calling the Get Available Time Slots Web Service with JSON

Here is an example JSON object:

JSON
{
    "requestType": "GET AVAILABLE TIME SLOTS",
    "securityToken": "{{ExampleSecurityToken}}",
    "login": "JohnChai10@kryteriontest.xom",
    "examCode": "PR000115",
    "deliveryType": "PROCTORED",
    "facilityCode": "HOST1187",
    "timeZone": "America/Phoenix",
    "fromDate": "2026-01-14",
    "toDate": "2026-01-20",
    "dayPart": "EARLY_MORNING",
    "returnFormat": "JSON"
}

Example Get Available Time Slots Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of a Get Available Time Slots web service call in JSON.

JSON
{
    "dayPart": "EARLY_MORNING",
    "deliveryType": "PROCTORED",
    "examCode": "PR000115",
    "examName": "Test Exam 15.0",
    "facilityCode": "HOST1187",
    "login": "JohnChai10@kryteriontest.xom",
    "success": "true",
    "timeSlotsByDate": [
        {
            "date": "2026-01-14",
            "timeSlots": [
                {
                    "value": "05:00:00"
                },
                {
                    "value": "05:15:00"
                },
                {
                    "value": "05:30:00"
                },
                {
                    "value": "05:45:00"
                }
            ]
        }
    ]
}

Example of an unsuccessful result:

JSON
{
    "dayPart": "ALL",
    "deliveryType": "PROCTORED",
    "examCode": "PR000115",
    "examName": "Test Exam 15.0",
    "facilityCode": "HOST0001",
    "login": "JohnChai10@kryteriontest.xom",
    "message": "Unable to retrieve available time slots for Exam PR000115 - Test Exam 15.0 from 2025-12-20 to 2025-12-26. No slots found or a system error occurred.",
    "success": "false"
}


Possible Error Messages

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-TS0001 - INCOMPLETE_PARAMS

  • WAWSE-TS0002 - DATE_FORMAT

  • WAWSE-TS0003 - DATE_PAST

  • WAWSE-TS0004 - DATE_INVALID_RANGE

  • WAWSE-TS0005 - DATE_RANGE_EXCEEDED

  • WAWSE-TS0006- INVALID_TIMEZONE

  • WAWSE-RE0009 - THE DELIVERY TYPE SHOULD BE PROCTORED or NOT_PROCTORED or PAPER_BASED or WRAPPER_PROCTORED

Get Testing Center List

Get Testing Center List Web Service

The Get Testing Center List web service allows clients to retrieve a list of public testing centers in a given Zip Code/Postal Code.

Get Testing Center List by Zipcode Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to GET TESTING CENTER LIST)

  • securityToken

  • zipCode*

  • city*

  • province*

  • country*

  • returnFormat

Please note: One of the optional fields must be filled in. Please reference the Webassessor ISO Country and Provinces List for a list of the states and provinces format.

Calling the Get Testing Center List Web Service with JSON

Here is an example JSON object:

JSON
{
    "requestType": "GET TESTING CENTER LIST",
    "securityToken": "{{ExampleSecurityToken}}",
    "zipCode": "85044",
    "city": "Phoenix",
    "province": "AZ",
    "country": "United States",
    "returnFormat": "JSON"
}

Example Get Testing Center List Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of a Get Testing Center List web service call in JSON.

JSON
[
    {
        "city": "Phoenix",
        "contactEmail": "donotreply@webassessor.com",
        "contactName": "Jennifer McGlashon",
        "contactPhone": "602-659-4673",
        "country": "United States",
        "facilityCode": "HOST0004",
        "id": "4",
        "name": "DKI ",
        "postalCode": "85044",
        "province": "Arizona",
        "street1": "7776 South Pointe Pkwy W",
        "street2": "Suite 250"
    }
]

Example of an unsuccessful result:

JSON
[
    "No testing centers found for the given zip code"
]


Possible Error Messages

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-RE00017 - TESTING_CENTER_FILTER_REQUIRED

Add Registration Web Service

Add Registration Web Service

The ADD REGISTRATION web service allows you to register the exams for test takers.

It supports:

  • PROCTORED (Onsite Exam Registrations)

  • WRAPPER_PROCTORED (Online Exam Registrations)

  • NOT_PROCTORED

  • PAPER_BASED

ADD REGISTRATION ELIGIBILITY by User Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to ADD REGISTRATION)

  • securityToken

  • login

  • examCode

  • deliveryType

  • facilityCode* (mandatory for PROCTORED exam types)

  • scheduledDateTime

  • sendEmail

  • returnFormat

Add Registration Web Service with JSON Examples:

Proctored (Onsite) Exams

Here is an example JSON object: Proctored Exam

JSON
{
    "requestType": "ADD REGISTRATION",
    "securityToken": "{{ExampleSecurityToken}}",
    "login": "JohnChai10@kryteriontest.xom",
    "deliveryType": "PROCTORED",
    "facilityCode": "HOST1187",
    "examCode": "PR000225",
    "scheduledDateTime": "2025-11-21 12:45:00",
    "sendEmail": true,
    "returnFormat": "JSON"
}

The following is an example of what the return value would look like upon the successful completion of an ADD REGISTRATION web service call in JSON for Proctored Exams.

JSON
{
    "authCode": "e6nkkm3y",
    "candidate": {
        "addressCity": "Phoenix",
        "addressCountry": "United States",
        "addressPostalCode": "85235",
        "addressState": "Arizona",
        "addressStreet1": "7785 S. Pointe Pkwy W.",
        "addressStreet2": "Suite 209",
        "clientRegion": {
            "id": "16226",
            "name": "John Brand"
        },
        "email": "sb01@kryteriononline.com",
        "firstName": "John",
        "homePhone": [],
        "id": "3994995",
        "lastName": "Chai10",
        "login": "JohnChai10@kryteriontest.xom"
    },
    "deliveryType": "PROCTORED",
    "event": {
        "id": "10759620",
        "created": "2025-11-07T12:06:46.962-07:00",
        "creatorId": "1",
        "modified": "2025-11-07T12:06:46.962-07:00",
        "modifierId": "1",
        "blockedOut": "false",
        "center": {
            "id": "11481",
            "created": "2012-04-02T13:44:41-07:00",
            "creatorId": "324679",
            "modified": "2025-11-07T11:09:32-07:00",
            "modifierId": "2473799",
            "address": {
                "id": "472327",
                "city": "Avondale",
                "country": "United States",
                "modified": "2016-12-08T01:00:10-07:00",
                "postalCode": "85323",
                "province": "Arizona",
                "street1": "420 N. Central Avenue",
                "street2": []
            },
            "availability": "ASSIGNED",
            "code": "HOST1187",
            "confirmationForm": "2012-04-25T00:00:00-07:00",
            "contactEmail": "donotreply@webassessor.com",
            "contactFax": "877-377-4715",
            "contactName": " Inna Severe",
            "contactPhone": "480-517-8552",
            "contractExecuted": "2012-04-02T00:00:00-07:00",
            "delayedScheduleHours": "0",
            "futureScheduleDays": "90",
            "kcpWhoSentTheConfirmationForm": "Linda Lukey",
            "latitude": "33.439432",
            "longitude": "-112.350109",
            "name": "Rio Salado College_Avondale",
            "notes": [],
            "parkingInfo": [],
            "timezone": "America/Phoenix",
            "type": "public",
            "welcomePackage": "2012-04-03T00:00:00-07:00"
        },
        "dateEnd": [],
        "dateStart": [],
        "emailSentFlag": "false",
        "status": "SCHEDULED",
        "timeEnd": [],
        "timeStart": [],
        "timezone": "America/Phoenix",
        "utcDateEnd": [],
        "utcDateStart": [],
        "utcTimeEnd": [],
        "utcTimeStart": []
    },
    "id": "16439363",
    "notes": [],
    "productCode": "PR000225",
    "productId": "68551",
    "progress": "SCHEDULED",
    "regTransactionId": "0",
    "registrationDate": "2025-11-07T12:06:46.938-07:00",
    "status": "NORMAL",
    "testingCenterCity": "Avondale",
    "testingCenterCountry": "United States",
    "testingCenterId": "11481",
    "testingCenterName": "Rio Salado College_Avondale",
    "testingCenterState": "Arizona",
    "timeElapsedInMillis": "0",
    "timeRemainingInMillis": "0",
    "timeZone": "America/Phoenix",
    "transaction": {
        "id": "16497976",
        "billingAddress": {
            "id": "4798233",
            "city": "Phoenix",
            "country": "United States",
            "modified": "2018-06-13T16:20:08-07:00",
            "postalCode": "85235",
            "province": "Arizona",
            "street1": "7785 S. Pointe Pkwy W.",
            "street2": "Suite 209"
        },
        "candidateFirstName": "John",
        "candidateLastName": "Chai10",
        "candidatePhone": [],
        "code": "REGISTRATION WS",
        "creatorId": "1",
        "currency": "USD",
        "modifierId": "1",
        "paymentType": "OTHER",
        "status": "ACTIVE",
        "total": "0.0",
        "transDate": "2025-11-07T12:06:46.960-07:00",
        "vendorCode": "FREE"
    }
}


Wrapper Proctored (Online) Exams

Here is an example JSON object: Proctored Exam

JSON
{
    "requestType": "ADD REGISTRATION",
    "securityToken": "{{ExampleSecurityToken}}",
    "login": "JohnChai10@kryteriontest.xom",
    "deliveryType": "WRAPPER_PROCTORED",
    "examCode": "PR000225",
    "scheduledDateTime": "2025-11-21 12:45:00",
    "timezone": "America/Phoenix",
    "sendEmail": true,
    "returnFormat": "JSON"
}

The following is an example of what the return value would look like upon the successful completion of an ADD REGISTRATION web service call in JSON for Proctored Exams.

{
    "candidate": {
        "addressCity": "Phoenix",
        "addressCountry": "United States",
        "addressPostalCode": "85235",
        "addressState": "Arizona",
        "addressStreet1": "7785 S. Pointe Pkwy W.",
        "addressStreet2": "Suite 209",
        "clientRegion": {
            "id": "16226",
            "name": "John Brand"
        },
        "email": "sb01@kryteriononline.com",
        "firstName": "John",
        "homePhone": [],
        "id": "3994995",
        "lastName": "Chai10",
        "login": "JohnChai10@kryteriontest.xom"
    },
    "deliveryType": "WRAPPER_PROCTORED",
    "id": "16439364",
    "notes": [],
    "productCode": "PR000225",
    "productId": "68551",
    "progress": "SCHEDULED",
    "regTransactionId": "0",
    "registrationDate": "2025-11-07T12:15:52.681-07:00",
    "status": "NORMAL",
    "timeElapsedInMillis": "0",
    "timeRemainingInMillis": "0",
    "transaction": {
        "id": "16497977",
        "billingAddress": {
            "id": "4798233",
            "city": "Phoenix",
            "country": "United States",
            "modified": "2018-06-13T16:20:08-07:00",
            "postalCode": "85235",
            "province": "Arizona",
            "street1": "7785 S. Pointe Pkwy W.",
            "street2": "Suite 209"
        },
        "candidateFirstName": "John",
        "candidateLastName": "Chai10",
        "candidatePhone": [],
        "code": "REGISTRATION WS",
        "creatorId": "1",
        "currency": "USD",
        "modifierId": "1",
        "paymentType": "OTHER",
        "status": "ACTIVE",
        "total": "0.0",
        "transDate": "2025-11-07T12:15:52.683-07:00",
        "vendorCode": "FREE"
    }
}
Paper-Based Exams

Here is an example JSON object: Paper-Based Exam

JSON
{
    "requestType": "ADD REGISTRATION",
    "securityToken": "{{ExampleSecurityToken}}",
    "login": "JohnChai10@kryteriontest.xom",
    "deliveryType": "PAPER_BASED",
    "examCode": "PR000225",
    "sendEmail": true,
    "returnFormat": "JSON"
}

The following is an example of what the return value would look like upon the successful completion of an ADD REGISTRATION web service call in JSON for Paper-Based Exams.

JSON
{
    "candidate": {
        "addressCity": "Phoenix",
        "addressCountry": "United States",
        "addressPostalCode": "85235",
        "addressState": "Arizona",
        "addressStreet1": "7785 S. Pointe Pkwy W.",
        "addressStreet2": "Suite 209",
        "clientRegion": {
            "id": "16226",
            "name": "John Brand"
        },
        "email": "sb01@kryteriononline.com",
        "firstName": "John",
        "homePhone": [],
        "id": "3994995",
        "lastName": "Chai10",
        "login": "JohnChai10@kryteriontest.xom"
    },
    "deliveryType": "PAPER_BASED",
    "id": "16439361",
    "notes": [],
    "productCode": "PR000225",
    "productId": "68551",
    "progress": "SCHEDULED",
    "regTransactionId": "0",
    "registrationDate": "2025-11-07T11:25:46.518-07:00",
    "status": "NORMAL",
    "timeElapsedInMillis": "0",
    "timeRemainingInMillis": "0",
    "transaction": {
        "id": "16497974",
        "billingAddress": {
            "id": "4798233",
            "city": "Phoenix",
            "country": "United States",
            "modified": "2018-06-13T16:20:08-07:00",
            "postalCode": "85235",
            "province": "Arizona",
            "street1": "7785 S. Pointe Pkwy W.",
            "street2": "Suite 209"
        },
        "candidateFirstName": "John",
        "candidateLastName": "Chai10",
        "candidatePhone": [],
        "code": "REGISTRATION WS",
        "creatorId": "1",
        "currency": "USD",
        "modifierId": "1",
        "paymentType": "OTHER",
        "status": "ACTIVE",
        "total": "0.0",
        "transDate": "2025-11-07T11:25:46.519-07:00",
        "vendorCode": "FREE"
    }
}


Unproctored Exams

Here is an example JSON object: Unproctored Exam

JSON
{
    "requestType": "ADD REGISTRATION",
    "securityToken": "{{ExampleSecurityToken}}",
    "login": "JohnChai10@kryteriontest.xom",
    "deliveryType": "NOT_PROCTORED",
    "examCode": "PR000225",
    "sendEmail": true,
    "returnFormat": "JSON"
}

The following is an example of what the return value would look like upon the successful completion of an ADD REGISTRATION web service call in JSON for Unproctored Exams.

JSON
{
    "candidate": {
        "addressCity": "Phoenix",
        "addressCountry": "United States",
        "addressPostalCode": "85235",
        "addressState": "Arizona",
        "addressStreet1": "7785 S. Pointe Pkwy W.",
        "addressStreet2": "Suite 209",
        "clientRegion": {
            "id": "16226",
            "name": "John Brand"
        },
        "email": "sb01@kryteriononline.com",
        "firstName": "John",
        "homePhone": [],
        "id": "3994995",
        "lastName": "Chai10",
        "login": "JohnChai10@kryteriontest.xom"
    },
    "deliveryType": "NOT_PROCTORED",
    "id": "16439360",
    "notes": [],
    "productCode": "PR000225",
    "productId": "68551",
    "progress": "SCHEDULED",
    "regTransactionId": "0",
    "registrationDate": "2025-11-07T11:24:13.603-07:00",
    "status": "NORMAL",
    "timeElapsedInMillis": "0",
    "timeRemainingInMillis": "0",
    "transaction": {
        "id": "16497973",
        "billingAddress": {
            "id": "4798233",
            "city": "Phoenix",
            "country": "United States",
            "modified": "2018-06-13T16:20:08-07:00",
            "postalCode": "85235",
            "province": "Arizona",
            "street1": "7785 S. Pointe Pkwy W.",
            "street2": "Suite 209"
        },
        "candidateFirstName": "John",
        "candidateLastName": "Chai10",
        "candidatePhone": [],
        "code": "REGISTRATION WS",
        "creatorId": "1",
        "currency": "USD",
        "modifierId": "1",
        "paymentType": "OTHER",
        "status": "ACTIVE",
        "total": "0.0",
        "transDate": "2025-11-07T11:24:13.604-07:00",
        "vendorCode": "FREE"
    }
}
Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00002 - NULL LOGIN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00038 - NULL DATE

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00048 - NULL PRODUCT CODE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

  • WAWSE-RE0001 - FACILITY CODE IS NOT AVAILABLE

  • WAWSE-RE0002 - PRODUCT CODE IS INCORRECT

  • WAWSE-RE0003 - THE LOGIN IS NOT VALID

  • WAWSE-RE0004 - DELIVERY TYPE SHOULD NOT BE NULL

  • WAWSE-RE0005 -REGISTRATION ALREADY EXISTS

  • WAWSE-RE0006 - THE DELIVERY TYPE DOES NOT EXIST FOR THE PRODUCT

  • WAWSE-RE0007 - THE DATE CODE SHOULD BE FUTURE DATE OR IS INVALID

  • WAWSE-RE0008 - THE FACILITY CODE CANNOT BE NULL (Facility code is mandatory)

  • WAWSE-RE0009 - THE DELIVERY TYPE SHOULD BE PROCTORED or NOT_PROCTORED or PAPER_BASED or WRAPPER_PROCTORED

  • WAWSE-RE0010 - PRODUCT CODE DOES NOT BELONG TO CLIENT REGION OR CODE IS INVALID

  • WAWSE-RE0011 - SEND EMAIL SHOULD BE EITHER TRUE OR FALSE

  • WAWSE-Ex0001 - PRODUCT ID NULL

  • WAWSE-Ex0002 - CANDIDATE ID NULL

  • WAWSE-Ex0003 - AUTH CODE NULL

  • WAWSE-Ex0004 - STATUS NULL

  • WAWSE-Ex0005 - INVALID AUTH CODE

    • The authorization code provided must contain only letters, numbers, or these special characters ( . @ _

  • WAWSE-Ex0006 - The candidate ID provided doesn't exist or belongs to a different region

  • WAWSE-Ex0007 - The candidate ID provided is not a test taker

  • WAWSE-Ex0008 - The product ID provided does not exist or belongs to a different region.

  • WAWSE-Ex0009 - The certification type provided does not exist.

  • WAWSE-TS0007 - INVALID_SELECTED_SCHEDULED_DATE

Add Registration with Validation Web Service

Add Registration with Validation Web Service

The Add Registration with Validation web service allows you to register the exams for test takers.

It supports only:

  • NOT_PROCTORED

  • PAPER_BASED

The difference between Add Registration and Add Registration with Validation is that this request will work like the UI where all prerequisites and retake rules are taken into consideration.

ADD REGISTRATION WITH VALIDATION by User Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to ADD REGISTRATION)

  • securityToken

  • deliveryType

  • login

  • examCode

  • returnFormat

Calling the Add Registration Web Service with JSON

Here is an example JSON object: Proctored Exam

JSON
{

"requestType": "ADD REGISTRATION WITH VALIDATION", 

"securityToken": "12345678-1234-1234-1234-1234567890126",

"login": "Noel.Kendall@roche.com", 

"examCode":"PR001049", 

"deliveryType": "PROCTORED", 

"returnFormat": "JSON"

}

Example Add REGISTRATION Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of an ADD REGISTRATION WITH VALIDATION for NOT_Proctored Exam web service call in JSON.

JSON
{

"candidate": { 

"addressCity": "abc",

"addressCountry": "United States", 

"addressPostalCode": "12345", 

"addressState": "New Mexico", 

"addressStreet1": "abc street", 

"addressStreet2": "Canada", 

"citizenship": "abc",

"email": "abc@yahoo.com", 

"fax": [],

"firstName": "abc", 

"homePhone": "12345",

"id": "7",

"lastName": "def",

"login": "abcdef", 

"userDefined1": []

},

"deliveryType": "NOT_PROCTORED", 

"id": "2660501",

"notes": [],

"productCode": "PR000014", 

"productId": "14614", 

"progress": "SCHEDULED", 

"regTransactionId": "0",

"registrationDate": "2021-03-19T10:20:03-07:00", 

"status": "NORMAL",

"timeElapsedInMillis": "0",

"timeRemainingInMillis": "0"

}

Example not successful result:

JSON
{

"candidateId": "0",

"certNumber": "0",

"certTypeId": "0",

"clientId": "0",

"clientRegionId": "0", 

"deliveryType": "PROCTORED",

"errorCode": "WAWSE-RE0003 - THE LOGIN IS NOT VALID",

"errorMessage": 

"com.kryterion.webassessor.webservices.exception.WebServicesException: The

candidate login is not a test taker or does not belong to the client region 

provided",

"examCode": "PR001049", 

"facilityCode": "CTC0026",

"login": "Noel.Kendall@roche.com", 

"maxScore": "0",

"productId": "0", 

"randomizeResponse": "false", 

"registrationId": "0",

"requestType": "ADD REGISTRATION WITH VALIDATION",

"returnFormat": "JSON",

"scaledScore": "0",

"scheduledDate": "2019-10-02 06:25:00",

"securityToken": "orwfjhb6-x6b0-wz3p-f4e5-3o36ceaiv926", 

"sendEmail": "true",

"syncLoginWithEmail": "false", 

"testingCenterId": "0",

"userId": "0"

}

Here is an example JSON object: NOT_Proctored Exam:

JSON
{

"requestType": "ADD REGISTRATION",

"securityToken": "csp_QA_candidate10", 

"login": "candidate", 

"examCode":"PR000028", 

"facilityCode": "",

"scheduledDateTime": "2020-10-2 23:45:00", 

"sendEmail": true,

"deliveryType": "NOT_PROCTORED", 

"returnFormat": "JSON"

}

The following is an example of what the return value would look like upon the successful completion of an ADD REGISTRATION for Non-Proctored Exam web service call in JSON.

JSON
{

"candidate": { 

"addressCity": "Phoenix",

"addressCountry": "United States", 

"addressPostalCode": "85221", 

"addressState": "Arizona", 

"addressStreet1": "123 Test St.bbbbbb", 

"addressStreet2": "Suite 200", 

"clientRegion": {

"id": "1",

"name": "Kryterion Default Region"

},

"email": 

"candidate.123455555555555555555555555555555555@kryterion.com",

"firstName": "Default", 

"homePhone": [],

"id": "7",

"lastName": "Candidate", 

"login": "candidate", 

"userDefined1": []

},

"deliveryType": "NOT_PROCTORED", 

"id": "2660501",

"notes": [],

"productCode": "PR000014", 

"productId": "14614", 

"progress": "SCHEDULED", 

"regTransactionId": "0",

"registrationDate": "2021-03-19T10:20:03-07:00",

"status": "NORMAL", 

"timeElapsedInMillis": "0",

"timeRemainingInMillis": "0"

}


Possible Error Messages

  • WAWSE-RE0001 - FACILITY CODE SHOULD BE PRIVATE

    • The facility code is either unavailable or it may not belong to the client testing network

  • WAWSE-RE0002 - PRODUCT CODE IS INCORRECT

    • The Delivery type for the product should be either PROCTORED or NOT_PROCTORED or PAPER_BASED

  • WAWSE-RE0003 - THE LOGIN IS NOT VALID

    • The candidate login is not a test taker or does not belong to the client region provided

  • WAWSE-RE0004 - DELIVERY TYPE SHOULD NOT BE NULL

    • Delivery type for the product should be provided

  • WAWSE-RE0005 -REGISTRATION ALREADY EXISTS

    • Registration already exists for the same user for the same product and testing center

  • WAWSE-RE0006 - THE DELIVERY TYPE DOES NOT EXIST FOR THE PRODUCT

    • The product with the delivery type provided is not present in our system

  • WAWSE-RE0007 - THE DATE CODE SHOULD BE FUTURE DATE OR IS INVALID

    • The date should be greater than current date

  • WAWSE-RE0008 - THE FACILITY CODE CANNOT BE NULL

    • Facility code is mandatory

  • WAWSE-RE0009 - THE DELIVERY TYPE SHOULD BE PROCTORED, NOT_PROCTORED and PAPER_BASED

    • Delivery type should be correct

  • WAWSE-RE0010 - PRODUCT CODE DOES NOT BELONG TO CLIENT REGION OR CODE IS INVALID

    • Either product code not available or Inactive or it may belong to a different client region

  • WAWSE-RE0011 - SEND EMAIL SHOULD BE EITHER TRUE OR FALSE

    • Send email flag should be either true or false

  • WAWSE-00048 - NULL PRODUCT CODE

    • The product code cannot be null

  • WAWSE-00002 - NULL LOGIN

    • You must supply a login name for the user

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

  • WAWSE-Ex0001 - PRODUCT ID NULL

  • WAWSE-Ex0002 - CANDIDATE ID NULL

  • WAWSE-Ex0003 - AUTH CODE NULL

  • WAWSE-Ex0004 - STATUS NULL

    • ACTIVE/INACTIVE

  • WAWSE-Ex0005 - INVALID AUTH CODE

    • The authorization code provided must contain only letters, numbers, or these special characters ( . @ _

  • WAWSE-Ex0006 - The candidate ID provided doesn't exist or belongs to a different region

  • WAWSE-Ex0007 - The candidate ID provided is not a test taker

  • WAWSE-Ex0008 - The product ID provided does not exist or belongs to a different region.

  • WAWSE-Ex0009 - The certification type provided does not exist.

  • WAWSE-00087 - PRODUCT PRE-REQUISITES NOT MET

  • WAWSE-TS0006 - INVALID_TIMEZONE

  • WAWSE-TS0008 - INVALID_SELECTED_SCHEDULED_DATE

  • WAWSE-TS0009 - INVALID_DATE_OR_DATE_PAST

Edit Registration Web Service

Edit Registration Web Service

The Edit Registration web service allows clients to update the scheduled date/time of existing exam registrations, and Testing Center for Proctored Exams.

It supports:

  • WRAPPER_PROCTORED (Online Exam Registrations)

  • PROCTORED (Onsite Exam Registrations)

Edit Registration Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to ADD REGISTRATION)

  • securityToken

  • login

  • registrationId

  • deliveryType (must be the same as previous)

  • facilityCode*

  • scheduledDateTime

  • timeZone

  • sendEmail

  • returnFormat

Please refer to https://timeapi.io/documentation/iana-timezones for a list of accepted time zones. Please note that the delivery type can’t be changed.

Calling the Edit Registration Web Service with JSON

Here is an example JSON object: (Online Exams)

JSON
{
    "requestType": "EDIT REGISTRATION",
    "securityToken": "{{ExampleSecurityToken}}",
    "login": "JohnChaiAPIDEMO",
    "registrationId": "16634880",
    "deliveryType": "WRAPPER_PROCTORED",
    "scheduledDateTime": "2026-03-25 10:00:00",
    "timeZone": "America/Phoenix",
    "returnFormat":"JSON"
}

Here is an example JSON object: (Onsite Exams)

JSON
{
    "dateEnd": "2026-02-25",
    "dateStart": "2026-02-25",
    "deliveryType": "WRAPPER_PROCTORED",
    "examCode": "PR000122",
    "examName": "Test Exam 15.0",
    "productId": "58700",
    "progress": "SCHEDULED",
    "registrationId": "16635201",
    "status": "NORMAL",
    "success": "true",
    "timeEnd": "12:30",
    "timeStart": "11:00",
    "timeZone": "America/Phoenix"
}

Example JSON Response:

The following is an example of what the return value would look like upon the successful completion of an Edit Registration web service call in JSON.

Wrapper Proctored (Online) Exams:

JSON
{
    "dateEnd": "2026-02-25",
    "dateStart": "2026-02-25",
    "deliveryType": "WRAPPER_PROCTORED",
    "examCode": "PR000122",
    "examName": "Test Exam 15.0",
    "productId": "58700",
    "progress": "SCHEDULED",
    "registrationId": "16635201",
    "status": "NORMAL",
    "success": "true",
    "timeEnd": "12:30",
    "timeStart": "11:00",
    "timeZone": "America/Phoenix"
}

Proctored (Onsite) Exams:

JSON
{
    "dateEnd": "2026-02-25",
    "dateStart": "2026-02-25",
    "deliveryType": "PROCTORED",
    "examCode": "PR000225",
    "examName": "ISProductTrainingDemo",
    "facilityCode": "HOST1249",
    "productId": "68551",
    "progress": "SCHEDULED",
    "registrationId": "16635164",
    "status": "NORMAL",
    "success": "true",
    "timeEnd": "12:30",
    "timeStart": "11:00",
    "timeZone": "America/Phoenix"
}
Possible Error Messages

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-RE0001 - FACILITY CODE IS NOT AVAILABLE

  • WAWSE-RE0003 - THE LOGIN IS NOT VALID

  • WAWSE-RE00018 - EDIT_REGISTRATION_INVALID_TIMEZONE

  • WAWSE-RE00019 - EDIT_REGISTRATION_NO_SCHEDULED_EVENT_FOR_REGISTRATION

  • WAWSE-RE00022 - THE DELIVERY TYPE SHOULD BE PROCTORED, WRAPPER_PROCTORED or ONLINE_PROCTORED

  • WAWSE-RE00023 - Scheduled date time is missing

  • WAWSE-TS0008 - INVALID_SELECTED_SCHEDULED_DATE

  • WAWSE-TS0009 - INVALID_DATE_OR_DATE_PAST

Cancel Registration Web Service

Cancel Registration Web Service

The Cancel Registration web service allows you to cancel a registration by registration ID.

Admin can offer full or no refund based on the flag "issueNoRefund".

  • If that is set to false, Full refund amount is calculated and refunded to test taker and the registration will be cancelled.

  • If it is set to true, Registration will be cancelled but test taker will not get any refund.

Cancel Registration Request Parameters

These are the allowed field names (* indicates an optional field):

  • requestType

  • securityToken

  • returnFormat

  • login : “johnsmith1” (A valid user login)

  • registrationId : “99999999” (A valid registration ID)

  • issueNoRefund: false (Admin can offer full or no refund based on the flag)

  • registrationCancelReason : (Reason for registration cancellation. The field value cannot have more than 60 characters)

Calling the Cancel Registration Web Service with JSON

Here is an example JSON object:

JSON
{

"requestType":"CANCEL REGISTRATION",

"securityToken":"******[REDACTED]******", 

"returnFormat":"JSON", 

"login":"johnsmith1", 

"registrationId":"99999999", 

"issueNoRefund":false,

"registrationCancelReason": "The test taker is out of town"

}

Example Cancel Registration Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of the “Cancel Registration” web service call in JSON.

JSON
{

"candidate": { 

"addressCity": "Honolulu",

"addressCountry": "United States", 

"addressPostalCode": "96818", 

"addressState": "Hawaii", 

"addressStreet1": "4334 Arron Smith Drive", 

"addressStreet2": [],

"clientRegion": { 

"id": "1",

"name": "Kryterion Default Region"

},

"email": "johnsmith1@localhost.com", 

"firstName": "John111111111", 

"homePhone": [],

"id": "27896",

"lastName": "Smith2789699999999", 

"login": " johnsmith1", 

"userDefined1": []

},

"id": "99999999",

"notes": [],

"productCode": "PR000017", 

"productId": "2974", 

"progress": "SCHEDULED", 

"regTransactionId": "0",

"registrationDate": "2020-09-17T09:48:05-07:00", 

"status": "NORMAL", 

"timeElapsedInMillis": "0",

"timeRemainingInMillis": "0"

}

The payment calls made during cancellation are asynchronous, and it usually takes from 4 to 5 seconds to complete. Since you get the response immediately in an API call, most likely, you will not see the updated status. The API user can get the updated status by making a "GET REGISTRATIONS" API call within a few seconds after the first "CANCEL REGISTRATION" call.


Possible Error Messages

  • WAWSE-00008 - INVALID LOGIN

  • WAWSE-00012 - INVALID REGISTRATION ID

  • WAWSE-RE0014 - INVALID REG CANCEL REASON LENGTH

  • WAWSE-RE0015 - CANNOT CANCEL REGISTRATION

Transcript Web Services

Get Transcripts by Date Range Web Service

Get Transcripts by Date Range Web Service

The Get Transcripts by Date Range web service allows you to retrieve all transcripts for a given date range. The date range is limited to a 7 day period.

If there are more than ~800 records, The API returns 404 Error.

Possible values for the below values in the response for registration object:

  • Progress: COMPLETED, SCHEDULED, IN_PROGRESS, SCHEDULEDSUSPENDED

  • Status: NORMAL, PAUSED, SUSPENDED, CANCELLED, PENDING_SALE

Get Transcripts by Date Range Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to TRANSCRIPTS BY DATE RANGE)

  • startDate

  • endDate

Calling the Get Transcripts by Date Range Web Service with JSON

Here is an example of JSON object:

JSON
{

"requestType": "GET TRANSCRIPTS BY DATE RANGE",

"securityToken": "12345678-1234-1234-1234-123456789012",

"returnFormat": "JSON",

"startDate":"2010-06-01 00:00:00",

"endDate":"2010-06-08 00:00:00"

}

Example Get Transcripts by Date Range Web Service Call JSON Return Value

The following is an example of what the return value will look like upon the successful completion of a Get Transcripts by Date Range web service call in JSON.

JSON
{

"certNumber": "0",

"date": "2008-06-24T08:49:42-07:00", 

"id": "46381",

"maxScore": "148",

"passFail": "NA",

"scaledScore": "0",

"score": "115.0", 

"simpleRegistration": {

"candidate": "12345",

"id": "99999",

"productId": "9876", 

"progress": "COMPLETED",

"registrationDate": "2008-06-24T06:43:42-07:00",

"status": "NORMAL", 

"testName": "Example Test", 

"testingCenterId": "0",

"timeElapsedInMillis": "0",

"timeRemainingInMillis": "0"

},

"status": "ACTIVE", 

“topicScores”:[

{

“code”:”ABCD00001”,

“maxScore”:”15.0”

“name”:”1. Basic Knowledge”, 

“score”:”13.0”

}],

"testRescoreId": "0"

},

{


"certNumber": "0",

"date": "2008-06-25T08:49:42-07:00", 

"id": "46382",

"maxScore": "184",

"passFail": "Pass",

"scaledScore": "0",

"score": "151.0", 

"simpleRegistration": {

"candidate": "12345",

"id": "88888",

"productId": "5432", 

"progress": "COMPLETED",

"registrationDate": "2008-06-25T06:43:42-07:00", 

"status": "NORMAL",

"testName": "Example Test Part II", 

"testingCenterId": "0",

"timeElapsedInMillis": "0",

"timeRemainingInMillis": "0"

},

"status": "ACTIVE", 

"testRescoreId": "0"

}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00038 - NULL DATE

  • WAWSE-00042 - UNPARSEABLE DATE

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

  • WAWSE-00049 - DATE RANGE TOO LONG

Get Transcripts by User Web Service

Get Transcripts by User Web Service

The Get Transcripts by User web service allows you to retrieve all transcripts for a given user.

Possible values for the below values in the response for registration object:

  • Progress: COMPLETED, SCHEDULED, IN_PROGRESS, SCHEDULEDSUSPENDED

  • Status: NORMAL, PAUSED, SUSPENDED, CANCELLED, PENDING_SALE

Get Transcripts by User Request Parameters

  • requestType must be set to GET TRANSCRIPTS BY USER

  • login or candidateId

  • SecurityToken

  • returnFormat

Calling the Get Transcripts by User Web Service with JSON

Here is an example JSON object using “login”:

JSON
{

"requestType": "GET TRANSCRIPTS BY USER",

"securityToken": "12345678-1234-1234-1234-123456789012",

"returnFormat": "JSON", 

“login”: “johnDoe”

}

Here is an example JSON object using “candidateId”:

JSON
{

"requestType": "GET TRANSCRIPTS BY USER",

"securityToken": "12345678-1234-1234-1234-123456789012",

"returnFormat": "JSON", 

“candidateId”: “12345”

}

Example Get Transcripts by User Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of a Get Transcripts by User web service call in JSON.

JSON
{

"certNumber": "0",

"date": "2008-06-24T08:49:42-07:00", 

"id": "46381",

"maxScore": "148",

"passFail": "NA",

"scaledScore": "0",

"score": "115.0", 

"simpleRegistration": {

"candidate": "12345",

"id": "99999",

"productId": "9876", 

"progress": "COMPLETED",

"registrationDate": "2008-06-24T06:43:42-07:00",

"status": "NORMAL", 

"testName": "Example Test", 

"testingCenterId": "0",

"timeElapsedInMillis": "0",

"timeRemainingInMillis": "0"


},

"status": "ACTIVE", 

“topicScores”: [

{

“code”:”ABCD00001”,

“maxScore”:”15.0”

“name”:”1. Basic Knowledge”, 

“score”:”13.0”

}],

"testRescoreId": "0"

},

{

"certNumber": "0",

"date": "2008-06-25T08:49:42-07:00", 

"id": "46382",

"maxScore": "184",

"passFail": "Pass",

"scaledScore": "0",

"score": "151.0", 

"simpleRegistration": {

"candidate": "12345",

"id": "88888",

"productId": "5432", 

"progress": "COMPLETED",

"registrationDate": "2008-06-25T06:43:42-07:00", 

"status": "NORMAL",

"testName": "Example Test Part II", 

"testingCenterId": "0",

"timeElapsedInMillis": "0",

"timeRemainingInMillis": "0"

},

"status": "ACTIVE", 

"testRescoreId": "0"

}

{

“code”:”ABCD00001”,

“maxScore”:”15.0”

“name”:”1. Basic Knowledge”, 

“score”:”13.0”

}],

"testRescoreId": "0"

},

{

"certNumber": "0",

"date": "2008-06-25T08:49:42-07:00", 

"id": "46382",

"maxScore": "184",

"passFail": "Pass",

"scaledScore": "0",


"score": "151.0", 

"simpleRegistration": {

"candidate": "12345",

"id": "88888",

"productId": "5432", 

"progress": "COMPLETED",

"registrationDate": "2008-06-25T06:43:42-07:00", 

"status": "NORMAL",

"testName": "Example Test Part II", 

"testingCenterId": "0",

"timeElapsedInMillis": "0",

"timeRemainingInMillis": "0"

},

"status": "ACTIVE", 

"testRescoreId": "0"

}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00002 - NULL LOGIN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

  • WAWSE-00088 - TOO MANY FIELDS PROVIDED

Get Transcripts by Promotion Web Service

Get Transcripts by Promotion Web Service

The Get Transcripts by Promotion web service allows you to retrieve a transcript that was associated with a coupon, a voucher, or a specific voucher code.

Get Transcripts by Promotion Request Parameters

  • requestType (must be set to GET TRANSCRIPTS BY PROMOTION)

  • SecurityToken

  • couponName, voucherName, or voucherCodeName

  • returnFormat

Calling the Get Transcripts by Promotion Web Service with JSON

Here is an example JSON object:

JSON
{
    "requestType": "GET TRANSCRIPTS BY PROMOTION",
    "securityToken": "{{ExampleSecurityToken}}",
    "voucherName": "Example Voucher Batch",
    "returnFormat": "JSON"
}

Example Get Transcripts by Promotion Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of a Get Transcripts by Promotion web service call in JSON.

JSON
{
    "transcripts": {
        "certNumber": "0",
        "date": "2025-04-30T16:26:14-07:00",
        "examName": "Test Exam 15.0",
        "id": "26990830",
        "maxScore": "1",
        "passFail": "NA",
        "scaledScore": "0",
        "score": "1.0",
        "simpleRegistration": {
            "candidate": [
                "3994995"
            ],
            "id": "15818023",
            "notes": [],
            "productCode": "PR000122",
            "productId": "58700",
            "progress": "COMPLETED",
            "regTransactionId": "0",
            "registrationDate": "2025-04-30T16:25:12-07:00",
            "status": "NORMAL",
            "testName": "Test Import 15.1",
            "timeElapsedInMillis": "0",
            "timeRemainingInMillis": "0"
        },
        "status": "ACTIVE",
        "testFormCode": "TF000050",
        "topicScores": {
            "code": "TP000056",
            "description": [],
            "maxScore": "1.0",
            "name": "Test Topic 15.1",
            "score": "1.0"
        }
    },
    "voucherName": "Example Voucher Name",
    "voucherValue": {
        "amount": "0.0",
        "percentage": "100"
    }
}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

  • WAWSE-00088 - TOO MANY FIELDS PROVIDED

  • WAWSE-VB0103 - INVALID_PROMOTION_REQUEST_ERROR_CODE

  • WAWSE-VB0104 - TOO MANY FIELDS PROVIDED

Add Transcript (single topic) Web Service

Add Transcript (single topic) Web Service

The Add Transcript web service allows you to add a transcript with a single topic for a given user and registration.

Add Transcript Request Parameters

These are the allowable fields (*indicates an optional field):

  • requestType (must be set to ADD TRANSCRIPT)

  • score

  • securityToken

  • transcriptDate

  • maxScore

  • passFail

  • transcriptStatus

  • registrationId

  • returnFormat

  • certNumber

Calling the Add Transcript Web Service with single topic with JSON

Here is an example JSON object:

JSON
{

"requestType":"ADD TRANSCRIPT", 

"securityToken":"12345678-1234-1234-1234-123456789012",

"transcriptDate":"2013-06-17 07:35:52", 

"maxScore":"2",

"passFail":"PASS",

"score":"2", 

"transcriptStatus":"ACTIVE", 

"registrationId":"123456", 

"returnFormat":"JSON",

“sendEmail”: true

}

Example Add Transcript with (Single Topic) Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of an Add Transcript web service call in JSON.

JSON
{

"certNumber": "0",

"date": "2014-04-17T07:35:52-07:00", 

"id": "1234567",

"maxScore": "100",

"passFail": "PASS",

"scaledScore": "0",

"score": "95", 

“emailSent”: true, 

"simpleRegistration": {

"candidate": { 

"addressCity": "Phoenix",

"addressCountry": "United States", 

"addressPostalCode": "85044", 

"addressState": "Arizona", 

"addressStreet1": "555 Main Street",

"addressStreet2": "Suite 1b", 

“clientRegion”:

{

“id”: “1234”,

“name”: “Acme Co. North America”

},

"email": "jroe@randomemail.com", "fax": [], 

"firstName": "Jane",

"homePhone": [],

"id": "7777",

"lastName": "Roe",

"login": " jroe@randomemail.com ", "userDefined1": [], 


"userDefined2": [],

"userDefined3": [],

"userDefined4": [], 

"userDefined5": []

},

"id": "987654",

"productCode": "PR000001", 

"productId": "7777", 

"progress": "COMPLETED",

"registrationDate": "2014-03-12T18:09:01-07:00", 

"status": "NORMAL",

"testName": "Test", 

"testingCenterId": "0",

"timeElapsedInMillis": "0",

"timeRemainingInMillis": "0"

},

"status": "ACTIVE"

}

Add Transcript (multitopic) Web Service

Add Transcript (multitopic) Web Service

The Add Transcript web service allows you to add a transcript with multiple topics for a given user and registration.

Calling the Add Transcript Web Service with Multi topic with JSON

JSON
{

"registrationId": "24234324", 

"transcriptStatus": "ACTIVE", 

"score": 48,

"sendEmail": false,

"requestType": "ADD TRANSCRIPT", 

"maxScore": 50,

"returnFormat": "JSON",

"transcriptDate": "2014-11-25 16:31:47", 

"passFail": "PASS",

"securityToken": "3123123123123123", 

"topicScore":

[

{ "code": "TP000332", "score": 3, "maxScore": 3},

{ "code": "TP000333", "score": 3, "maxScore": 3},

{ "code": "TP000334", "score": 10, "maxScore": 10},

{ "code": "TP000335", "score": 3, "maxScore": 3},

{ "code": "TP000336", "score": 2, "maxScore": 2},

{ "code": "TP000337", "score": 8, "maxScore": 8},

{ "code": "TP000338", "score": 8, "maxScore": 8},

{ "code": "TP000339", "score": 6, "maxScore": 8},

{ "code": "TP000340", "score": 3, "maxScore": 3},

{ "code": "TP000341", "score": 2, "maxScore": 2}

]

}


Possible Error Messages

  • WAWSE-00012 - INVALID REGISTRATION ID

    • The registration id was not found

  • WAWSE-00052 - TRANSCRIPT STATUS IS UNKNOWN

    • The transcript status message is invalid

  • WAWSE-00051 - PASS FAIL VALUE IS UNKNOWN

    • The pass fail value is unknown

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00050 - PASS FAIL INDICATION IS NULL

  • WAWSE-00051 - TRANSCRIPT STATUS IS NULL

  • WAWSE-00053 - TRANSCRIPT DATE IS NULL

  • WAWSE- 00060 - AN UNEXPECTED ERROR OCCURRED

Certification Web Services

Get Cert Info by Date Range Web Service

Get Cert Info by Date Range Web Service

Get certification status for multiple candidates using this API. Date range is based on the update/change of the certification status and is limited to a 7 day period.

Calling the GET CERT INFO BY DATE RANGE Web Service with JSON

Here is an example JSON object:

JSON
{

" requestType":"GET CERT INFO BY DATE RANGE",

"securityToken":"2k2v0lmh-9xtv-4adn-qozi-vthhgwp22ts1",

"startDate":"2017-10-24 00:00:00",

"endDate":"2017-10-27 17:00:00",

"returnFormat":"JSON"

}

Sample JSON response for GET CERT INFO BY DATE RANGE Web Service with JSON

JSON
[

{

"certs": [

{

"certificationStatus": "CURRENT", 

"certificationType": "Certified Administrator",

"description": "Salesforce Certified Administrator track", 

"trackName": "Certified Administrator"

},

{

"certificationStatus": "CURRENT", 

"certificationType": "Certified Programmer I"


Get Certification Status by User Request Parameters

},

{

"certificationStatus": "CURRENT", 

"certificationType": "Certified Technical Architect"

}

],

"user": {

"id": "xxxx",

"login": "xxxxxx"

}

},

{

"certs": {

"certificationStatus": "CURRENT", 

"certificationType": "Certified Technical Architect"

},

"user": {

"id": "aaaa",

"login": "sf_aaaa_taker"

}

}

]

Get Cert Status by User Web Service

Get Cert Status by User Web Service

The Get Cert Status by User web service allows you to retrieve the certification status for a given user.

Get Cert Status by User Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to GET CERT INFO)

  • securityToken

  • login

  • returnFormat

Calling the Get Certification Status by User Web Service with JSON

Here is an example JSON object:

JSON
{

"requestType": "GET CERT INFO",

"securityToken": "12345678-1234-1234-1234-123456789012",

"returnFormat": "JSON",

"login":"johndoe"

}

Example Get User by I Get Certification Status by User D Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of a Get Certification by User web service call in JSON.

JSON
{

"certs": [

{

"certificationStatus": "AT_RISK", 

"certificationType": "Certified Admin",

"description": "Acme Certified Admin track", 

"trackName": "Certified Admin"

},

{

"certificationStatus": "AT_RISK", 

"certificationType": "Certified Manager", 

"description": "Acme Certified Manager track", 

"trackName": "Certified Manager"

}],

"user": {

"id": "123456",

"login": "johndoe"

} }

The following is an example of what the return value would look like when Users have 

no certifications

{


"note": "No cert status found for user", 

"user": {

"id": "289962",

"login": "gwhite_admin"

}

}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00002 - NULL LOGIN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

Assessment Web Services

Get Products Web Service

Get Products Web Service

The Get Products web service allows you to retrieve a list of all of the products which are active.

Get Products Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to GET PRODUCTS)

  • SecurityToken

  • ReturnFormat

Calling the Get Products Web Service with JSON

Here is an example JSON object:

JSON
{

"requestType": "GET PRODUCTS",

"securityToken": "12345678-1234-1234-1234-123456789012",

"returnFormat": "JSON"

}

Example Get Products Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of a Get Products web service call in JSON.

{

"code": "PR000001",

"currency": "USD",

"deliveryType": "NOT_PROCTORED", 

"id": "3839",

"longDesc": [],

"name": "Salesforce.com Certified Administrator", 

"price": "0.00",

"registrationEndDate": "9999-12-31T00:00:00-07:00", 

"registrationStartDate": "2008-06-18T00:00:00-07:00", 

"status": "ACTIVE",

"testAids": [],

"testWindowEndDate": "9999-12-31T00:00:00-07:00",

"testWindowStartDate": "2008-06-18T00:00:00-07:00"

}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

Add Item Web Service

Add Item Web Service

The Add Item web service allows you to add items into the mentioned items folders for each client. The allowed Item Type are MC, MS and TF. The allowed number of responses for TF is Response A,B and for MC and MS it is Response A,B,C,D,E,F,G,H,I,J with A and B being mandatory.

The Item folders will be created under the parent folder with today's date. The client ID must be unique across the region. The required question custom fields must be added in the request.

ADD ITEM Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to ADD ITEM)

  • itemBank (each folder should be separated by “^”)

  • clientDefinedID

  • itemType

  • itemText

  • responseA

  • responseB

  • ResponseC*

  • ResponseD*

  • ResponseE*

  • responseF*

  • responseG*

  • responseH*

  • correctResponse

  • itemPoints

  • randomizeResponse

  • itemObjective*

  • itemNotes*

  • itemFeedback*

  • customFields*

  • returnFormat

Calling the Add Registration Web Service with JSON

Here is an example JSON object:

JSON
{

"requestType": "ADD ITEM", 

"securityToken": "123-456-7891",

"itemBank": "kryterion", 

"clientDefinedID": "12345", 

"itemType": "MS",

"itemText": "This is the question", 

"responseA": "Response A", 

"responseB": "Response B", 

"responseC": "Response C", 

"responseD": "Response D", 

"responseE": "Response E", 

"responseF": "Response F", 

"responseG": "Response G", 

"responseH": "Response H", 

"responseI": "Response I", 

"responseJ": "Response J",

"correctResponse": "A,C", 

"itemPoints": "1", 

"randomizeResponse": "true",

"itemObjective": "objective text", 

"itemNotes": "notes text",

"itemFeedback": "feedback text", 

"returnFormat" : "JSON",

"customFields":

[

{"id":"2089229","intValue":"12345"},

{"id":"2089231","numberValue":"12345.34"},

{"id":"2099445","stringValue":"Hello"},

{"id":"2089230","dateValue":"YYYY-MM-DD"},

{"id":"2089230","optionValue":"stringValue"}

]

}

Example Add ITEM Web Service Call JSON Return Value

JSON
{

"clientDefinedID": "12345", 

"clientRegion": {

"id": "123",

"name": "abc "

},

"correctResponse": "AB", 

“customFieldValue": [

{

"customFieldId": "2089230", 

"customFieldText": "Date Custom Field", 

"dateValue": "2019-10-02T00:00:00-07:00",

"intValue": "0"


},

{

"customFieldId": "2089229", 

"customFieldText": "Integer Custom Field", 

"intValue": "12345"

},

{

"customFieldId": "2089231", 

"customFieldText": "Numeric Custom Field", 

"intValue": "0",

"numberValue": "12345.34"

},

{

"customFieldId": "2099445", 

"customFieldText": "test2", 

"intValue": "0", 

"stringValue": "Hello"

}

],

"feedback": "feedback text", 

"id": "706057",

"itemBank": " kryterion^1.1", 

"itemPoints": "1",

"itemText": "This is the question", 

"itemType": "MS",

"notes": "notes text", 

"objective": "objective text", 

"randomizeResponse": "true", 

"responseA": "Response A", 

"responseB": "Response B", 

"responseC": "Response C", 

"responseD": "Response D", 

"responseE": "Response E", 

"responseF": "Response F", 

"responseG": "Response G", 

"responseH": "Response H", 

"responseI": "Response I", 

"responseJ": "Response J"

}

Example not successful result:

JSON
{

"candidateId": "0",

"certTypeId": "0", 

"clientDefinedID": "IA2a-3A_1", 

"clientId": "0",

"clientRegionId": "0",

"correctResponse": "A", 

"customFields": [

{

"id": "466",

"intValue": "0",

"stringValue": "1. Recall"

},

{

"id": "467",

"intValue": "0", 

"stringValue": "Yes"

}

],

"errorCode": "WAWSE-00067 - ITEM CLIENT ID EXISTS",

"errorMessage": 

"com.kryterion.webassessor.webservices.exception.WebServicesException

: WAWSE00067 - ITEM CLIENT ID EXISTS",

"itemBank": "custom_field^options^1.1", 

"itemFeedback": [],

"itemNotes": "notes", 

"itemObjective": "objective", 

"itemPoints": "4",

"itemText": "Item Text?",

"itemType": "MC",

"maxScore": "0",

"productId": "0", 

"randomizeResponse": "false", 

"registrationId": "0", 

"requestType": "ADD ITEM", 

"responseA": "Response A", 

"responseB": "Response B", 

"responseC": "Response C", 

"responseD": "Response D", 

"responseE": "E",

"responseF": "F",

"responseG": "G",

"responseH": "H",

"responseI": "I",

"responseJ": "J",

"returnFormat": "JSON",

"scaledScore": "0",

"securityToken": "csp_QA_candidate10", 

"sendEmail": "false", 

"syncLoginWithEmail": "false", 

"testingCenterId": "0",

"userId": "0"

}


Possible Error Messages

  • WAWSE-00067 - ITEM CLIENT ID EXISTS

    • The Client ID must be unique

  • WAWSE-00062 - INVALID ITEM TYPE

    • The possible Item Type are MC,MS,TF

  • WAWSE-00031 - MISSING REQUIRED CUSTOM FIELDS

    • The required custom fields must be added in the request

  • WAWSE-00030 - INVALID CUSTOM FIELD ID

    • The Custom Field ID is invalid/incorrect

  • WAWSE-00063 - RESPONSE IS NULL

    • The Response are missing

  • WAWSE-00073 - NULL ITEM TEXT

    • The Item Text is NULL

  • WAWSE-00064 - CORRECT OPTION IS NULL

    • The Correct Option is Required

  • WAWSE-00065 - INVALID CORRECT OPTION

    • The Correct Option is INVALID. It can have values for options A,B,C,D,E,F,G,H,I,J provided those responses already exist

  • WAWSE-00066 - INVALID ITEM OBJECTIVE LENGTH

    • The Objective length cannot exceed 150 characters

  • WAWSE-00074 - NULL ITEM POINTS

    • The Item points must have a value

  • WAWSE-00071 - INVALID RESPONSES FOR TF ITEM TYPE

    • The TF items must have true and false responses

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

Edit Item Web Service

Edit Item Web Service

The Edit Item web service allows clients to edit items through an API call instead of through the UI. The supported Item Types are Multiple Choice (MC), Multiple Select (MS) and True/False (TF). The number of responses for an Item cannot change.

The Item ID is the Item’s clientDefinedID. The clientDefinedID field is used to update the clientDefinedID. The required question custom fields must be added to the request.

Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType

  • securityToken

  • itemId

  • clientDefinedID *

  • itemText *

  • responseA - J *

  • correctResponse *

  • itemPoints *

  • updateRandomizeResponse *

  • itemNotes *

  • itemFeedback *

  • itemObjective *

  • gradientScoring *

  • pointsGradientResponseA - J *

  • customFields *

Calling the Edit Item Web Service with JSON

Here is a complete example JSON object:

JSON
{

 "requestType":"EDIT ITEM",

 "securityToken":"ExampleSecurityToken",

 "itemId": "IIT000061",

 "clientDefinedID": "UpdatedID",

 "itemText": "edited",

 "responseA": "A response update",

 "responseB": "B response update",

 "responseC": "C response update",

 "responseD": "D response update",

 "responseE": "E response update",

 "responseF": "F response update",

 "responseG": "G response update",

 "responseH": "H response update",

 "responseI": "I response update",

 "responseJ": "J response update",

 "correctResponse": "C",

 "itemPoints": 2,

 "updateRandomizeResponse": true,

 "itemNotes": "Updated notes",

 "itemFeedback": "Updated feedback",

 "itemObjective": "Updated objective",

 "gradientScoring": true,

 "pointsGradientResponseA": 0.0,

 "pointsGradientResponseB": 1.0,

 "pointsGradientResponseC": 2.0,

 "pointsGradientResponseD": 1.5,

 "pointsGradientResponseE": 1.0,

 "pointsGradientResponseF": 0.5,

 "pointsGradientResponseG": 0.0,

 "pointsGradientResponseH": 1.1,

 "pointsGradientResponseI": 1.0,

 "pointsGradientResponseJ": 1.1,

 "customFields": [

 {"id": 1, "stringValue": "Updated"},

 {"id": 2, "numberValue": 126.9},

 {"id": 3, "dateValue": "2023-12-20"},

 {"id": 4, "intValue": 2},

 {"id": 5, "optionValue": "Option 3"}

 ]

}

Here is a sample JSON object for just one update:

JSON
{

 "requestType":"EDIT ITEM",

 "securityToken":"ExampleSecurityToken",

 "itemId": "SampleItem",

 "responseA": "A response update"

}

Example Edit Item Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of an Edit Item web service call in JSON.

JSON
<simpleQuestion>
    <clientDefinedID>SampleItem</clientDefinedID>
    <clientRegion>
        <id>16226</id>
        <name>John Brand</name>
    </clientRegion>
    <correctResponse>A</correctResponse>
    <feedback></feedback>
    <id>1367692</id>
    <itemBank>IBF000099</itemBank>
    <itemPoints>1</itemPoints>
    <itemText>edited</itemText>
    <itemType>MC</itemType>
    <notes>notes</notes>
    <objective>objective</objective>
    <randomizeResponse>false</randomizeResponse>
    <responseA>Response A</responseA>
    <responseB>Response B</responseB>
    <responseC>Response C</responseC>
    <responseD>Response D</responseD>
</simpleQuestion>


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00030 - INVALID CUSTOM FIELD ID

    • A custom field could not be found for the provided custom field ID

  • WAWSE-00031 - MISSING REQUIRED CUSTOM FIELDS

    • At least one of the required custom fields is missing or empty

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00062 - INVALID ITEM TYPE

    • The item to be edited is not one of the accepted types (MC, MS, TF), or the item type does not support the request update (boundSelection, and partialScoring are only used for MS, and gradientScoring is only used for MC)

  • WAWSE-00064 - CORRECT OPTION IS NULL

    • The correct option must have a value provided when it is being changed

  • WAWSE-00065 - INVALID CORRECT OPTION

    • MC and TF question can only have 1 correct option, and the correct option may only be A, B, C, D, E, F, G, H, I, J, if those responses exist

  • WAWSE-00066 - ITEM CLIENT ID LENGTH EXCEEDED- MAX SIZE 50 CHARACTERS

  • WAWSE-00067 - ITEM CLIENT ID EXISTS

    • The provided clientDefinedID, which must be unique, already exists

  • WAWSE-00068 - ITEM OBJECTIVE LENGTH EXCEEDED- MAX SIZE 150 CHARACTERS

  • WAWSE-00073 - NULL ITEM TEXT

    • The item text must not be empty when included in the request body

  • WAWSE-00076 - INVALID ITEM POINTS

    • The item points provided are invalid, and must be 0 or a positive number

  • WAWSE-00084 - CUSTOM FIELD MAX SIZE EXCEEDED

    • One of the custom field values provided exceeds the max character count of the custom field

  • WAWSE-00089 - UNABLE TO EDIT ITEM

    • The item cannot be edited as it is included on an in-progress test

  • WAWSE-00090 - INVALID RESPONSE POINTS PERCENTAGE PROVIDED

    • One of the pointsPercentageResponse is for a response that does not exist for the item, or the value provided is invalid*

  • WAWSE-00091 - INVALID RESPONSE POINTS GRADIENT PROVIDED

    • One of the pointsGradientResponse is for a response that does not exist for the item, or the value provided is invalid**

  • WAWSE-00093 - UNABLE TO EDIT ITEM POINTS

    • Points are not able to be updated for the item, due to the test being published

  • WAWSE-00094 - UNABLE TO FIND ITEM ID

    • An item could not be found with the provided itemId

  • WAWSE-00095 - UNABLE TO EDIT ITEM SCORING

    • Unable to edit the items scoring (gradientScoring or partialScoring) due to the item being in a test that is in progress or has been completed

  • WAWSE-00096 - INVALID RESPONSE FOR ITEM

    • One of the responses to be updated does not exist for the item

Miscellaneous Web Services

Get Client Regions Web Service

Get Client Regions Web Service

The Get Client Regions web service allows you to retrieve a list of all the client regions related to the given security token.

Get Client Regions Request Parameters

These are the allowable field names (* indicates an optional field):

  • requestType (must be set to GET CLIENT REGIONS)

  • securityToken

  • returnFormat

Calling the Get Client Regions Web Service with JSON

Here is an example JSON object:

JSON
{

"requestType": "GET CLIENT REGIONS",

"securityToken": "12345678-1234-1234-1234-123456789012",

"returnFormat": "JSON",

}

Example Get Client Regions Web Service Call JSON Return Value

The following is an example of what the return value would look like upon the successful completion of a Get Client Region web service call in JSON.

JSON
{

"clientRegions": [

{

"id": "1234",

"name": "Acme Co. North America",

},

{

"id": "5678",

"name": "Acme Co. Europe",

},

{

"id": "9876",

"name": "Acme Co. Asia",

}]

}


Possible Error Messages

  • WAWSE-00000 - NULL SECURITY TOKEN

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00003 - NULL REQUEST TYPE

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00044 - INVALID REQUEST TYPE

  • WAWSE-00060 - AN UNEXPECTED ERROR OCCURRED

Update Lab Progress Web Service

Update Lab Progress Web Service

Now that we have only one exam/registration/transcript for the (MC + lab) exam, there is a need to create a new “UPDATE LAB PROGRESS” API that clients can call to update the same transcript with the lab exam result.

Since we are using the new values in the registration “progress” and transcript “pass_fail“ enums, based on the result of the lab, the transcript and registration records are updated.

Scenario

Registration "progress" enum

Transcript "pass_fail" enum

Client Sends (labprogress)

Candidate completes MC and passes (lab not started)

MC_Completed

MC_Pass


Candidate completes MC and fails (lab not started)

Completed

Fail


Candidate completes MC and passes (lab in progress)

Lab_inprogress

MC_pass

LAB_START

Candidate completes MC and passes and completes lab (lab results delayed)

Completed

MC_pass

LAB_COMPLETE

Candidate completes MC and completes lab (lab result pass)

Completed

Pass

LAB_PASS

Candidate completes MC and completes lab (lab result fail)

Completed

MC_Pass_Lab_fail

LAB_FAIL

Request Parameters

These are the allowable field names (* indicates an optional field):


Example of Request JSON:

JSON
{

"registrationId": "10715771",

 "securityToken": "0dhcg632-ld99-26nc-1lo9-chsdg9m823hh",

 "requestType": "UPDATE LAB PROGRESS",

 "labProgress": "LAB_COMPLETE",

 "sendEmail": false,

 "returnFormat": "JSON"

}

Example Response:

JSON
{

 "certNumber": "0",

 "date": "2022-11-10T11:49:10.637-07:00",

 "id": "11052221",

 "maxScore": "8",

 "passFail": "PASS",

 "scaledScore": "0",

 "score": "1.0",

 "simpleRegistration": {

 "id": "2660656",

 "productCode": "PR000035",

 "productId": "14843",

 "progress": "COMPLETED",

 "regTransactionId": "0",

 "registrationDate": "2022-10-14T10:53:35-07:00",

 "status": "NORMAL",

 "testingCenterCity": "phoenix",

 "testingCenterCountry": "United States",

 "testingCenterId": "13",

 "testingCenterName": "new private event",

 "testingCenterState": "Arizona",

 "timeElapsedInMillis": "0",

 "timeRemainingInMillis": "0",

 "timeZone": "America/Phoenix"

 },

 "status": "ACTIVE"

}


Possible Error Messages and codes

  • WAWSE-00001 - INVALID SECURITY TOKEN

  • WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

  • WAWSE-00086 - HASH KEY VALUE IS UNKNOWN

Valid Country and Province Codes

Please click on the link below to download Kryterion’s Country and Province List:

Webassessor ISO Country and Provinces List .

Opening this CSV file in Excel and other non-UTF-8 compliant programs may cause corrupted characters to appear.


Error Codes and Validation Rules

When a web service request encounters an error during execution, the return value will contain two fields: errorCode and errorMessage. The error message can change depending on the context, but the error code field will remain stable, allowing the calling application to test for particular errors.

For example:

If an invalid security token is passed into a web service call, the error message might be, “You must provide a valid security token,” or “This security token is invalid for this request”. Although the error messages were different, in both instances, the error code will be “WAWSE00001 – INVALID SECURITY TOKEN” as noted in the following table.

Code

Explanation

Validation Rule

WAWSE-#####

WAWSE-00000 - NULL SECURITY TOKEN

The security token provided in the request is missing or zero length.

Must be non-null and have a length greater than zero.

WAWSE-00001 - INVALID SECURITY TOKEN

The security token provided in the request is invalid.

Must match the security token value stored in the database.

WAWSE-00002 - NULL LOGIN

The login field in the request is missing or zero length.

Must be non-null and have a length greater than zero.

WAWSE-00003 - NULL REQUEST TYPE

The request type field is missing or zero length.

Must be non-null and have a length greater than zero.

WAWSE-00004 - NULL/INVALID FIRST NAME

The first name field is missing or zero length or more than 35- character length

Must be non-null and have a length greater than zero and less than 35 characters.

WAWSE-00005 - NULL EMAIL ADDRESS

The email field is missing or zero length.

Must be non-null and have a length greater than zero.

WAWSE-00006 - NULL PASSWORD

The password field is missing or zero length.

Must be non-null and have a length greater than zero.

WAWSE-00007 - NULL PASSWORD SECRET

The secret field is missing or zero length.

Must be non-null and have a length greater than zero.

WAWSE-00008 - INVALID LOGIN

The login field is invalid.

The user does not exist in the database.

WAWSE-00009 - UNEXPECTED PERSISTENCE ERROR

An unexpected error occurred while accessing the database.


WAWSE-00010 - INVALID USER ID

The user id field is invalid.

Must be a value greater than zero and be associated with a user belonging to the client region associated with the given security token.

WAWSE-00012 - INVALID REGISTRATION ID

The registration id field is invalid.

Must be a value greater than zero and associated with a registration belonging to a user in the client region associated with the given Integration security token.

WAWSE-00013 – NULL/INVALID LAST NAME

The last name field is missing or zero length or more than 45 character in length

Must be non-null and have a length greater than zero and less than 45 characters

WAWSE-00014 - NULL ADDRESS STREET

The street address field is missing or zero length.

Must be non-null and have a length greater than zero.

WAWSE-00015 - NULL ADDRESS CITY

The city field is missing or zero length.

Must be non-null and have a length greater than zero.

WAWSE-00016 - NULL ADDRESS POSTAL CODE

The postal code field is missing or zero length.

Must be non-null and have a length greater than zero.

WAWSE-00017 - NULL ADDRESS COUNTRY

The country is missing or zero length.

Must be non-null and have a length greater than zero.

WAWSE-00018 - INVALID COUNTRY

The country or country code provided in the request is invalid.

The country must exist and be in the approved ISO Name format, or the ISO-3 3- character abbreviation.

WAWSE-00019 - INVALID STATE/PROVINCE

The state or state code provided is invalid.

The state must be existing and be in the approved ISO Name format or the ISO abbreviation format.

WAWSE-00020 - INVALID PASSWORD

The password provided is invalid.

The password must be at least 8 characters and less than 100 characters and contain at least one uppercase character, one lowercase character, one number, and one special character.

WAWSE-00021 - INVALID FAX

The fax number provided is invalid.


WAWSE-00022 - INVALID PHONE

The phone number provided is invalid.

The phone number must only contain numbers, dashes, and parentheses.

WAWSE-00023 - EMAIL IN USE

The email address provided is already in use for the client region associated with the security token.

The email address must be unique for all users in the client region associated with the security token.

WAWSE-00024 - INVALID LOGIN FORMAT

The login provided is in an invalid format.

The login must be at least 6 characters long and less than 50 characters and contain only letters, numbers, the @ symbol, underscores and periods.

WAWSE-00025 - INVALID EMAIL

The email provided is invalid.

The email address must be in proper email address format.

WAWSE-00026 - INVALID POSTAL CODE

The postal code provided is invalid.

Must be between 1 and 13 characters and contain only numbers, letters, spaces, and hyphens.

WAWSE-00027 - INVALID NAME

The first name and/or last name provided is invalid.

User names must not contain special characters other than spaces, single apostrophes, hyphens, periods, carets, and underscores.

WAWSE-00028 - LOGIN ALREADY EXISTS

The login provided already exists.

Logins must be unique for each user.

WAWSE-00029 - INVALID STREET ADDRESS

The street address provided is invalid.

Must not contain asterisks or percent signs.

WAWSE-00030 - INVALID CUSTOM FIELD ID

The custom field id provided is invalid.

The custom field id must be greater than zero and associated with a custom field assigned to the client region for the given security token.

WAWSE-00031 - MISSING REQUIRED CUSTOM FIELDS

One or more required custom fields are missing from the request.


WAWSE-00034 - INVALID PROVINCE FOR COUNTRY

The state or state code provided is valid, but not for the country provided.


WAWSE-00035 - INVALID ADDRESS CITY

The city provided is invalid.

The city must not contain any of the following characters: ‘!’, ‘@’, ‘#’, ‘$’, ‘%’, ‘^’, ‘*’.

WAWSE-00037 - MISMATCH EMAIL AND LOGIN

The email address and login provided belong to different users.


WAWSE-00038 - NULL DATE

The date provided is either missing or zero length.

Must be non-null and have a length greater than zero.

WAWSE-00039 - INVALID FAX LENGTH

The fax number provided is too long.


WAWSE-00040 - INVALID PHONE LENGTH

The phone number provided is too long.

Must be 1 to 20 characters.

WAWSE-00041 - INVALID DATE RANGE CODE

The date range provided is invalid.

The start date must be before the end date.

WAWSE-00042 - UNPARSEABLE DATE

The date provided is in an incorrect format.

Date format should be YYYY-MM-DD HH:MM:SS

WAWSE-00043 - INVALID SECRET LENGTH

The length of the password secret provided is invalid.

Must be 12 characters or less.

WAWSE-00044 - INVALID REQUEST TYPE

The request type provided is unknown.

The request type must be a valid request type as set forth in this document.

WAWSE-00045 - ZERO REGISTRATION ID

The registration id provided is either missing or zero.

Must be a number greater than zero and associated with a user for the client region associated with the given security token.

WAWSE-00048 - NULL PRODUCT CODE

The product code field is either missing or zero length.

Must be non-null and have a length greater than zero.

WAWSE-00049 - DATE RANGE TOO LONG

The date range provided is too long.

Start and end dates must not be more than 7 days apart.

WAWSE-00050 - PASS FAIL INDICATION IS NULL

The pass/fail field is either missing or zero length.

Must be non-null and have a length greater than zero.

WAWSE-00051 - PASS FAIL VALUE IS UNKNOWN

The value of the pass/fail field provided is unknown.

Must be one of the following values: NA, PASS, FAIL, NOT SCORED.

WAWSE-00051 - TRANSCRIPT STATUS IS NULL

The transcript status field is either missing or zero length.

Must be non-null and have a length greater than zero.

WAWSE-00052 - TRANSCRIPT STATUS IS UNKNOWN

The transcript status field value is unknown.

Must be one of the following values: ACTIVE, INACTIVE.

WAWSE-00053 - TRANSCRIPT DATE IS NULL

The transcript date field is either missing or zero length.

Must be non-null and have a length greater than zero.

WAWSE-00056 - UNABLE TO FIND TEST ID

The test id provided is not found in the database.

An incorrect state of data in the database has made saving a new transcript impossible.

WAWSE-00057 - TRANSCRIPT ALREADY EXISTS

A transcript for the given registration already exists.


WAWSE-00058 - UNABLE TO FIND CLIENT REGION ID IN DATABASE

Can't find client region with the given id


WAWSE-00060 – AN UNEXPECTED ERROR OCCURRED

An unexpected error occurred.


WAWSE-00061 - UNABLE TO FIND ITEM CLIENT DEFINED ID

The Item Id is not found in database


WAWSE-00062 - INVALID ITEM TYPE

The Item Type is invalid

The permitted Item Type is “MC” or “MS” or “TF”

WAWSE-00063 - RESPONSE IS NULL

The response A, B is required field

Must be string fields

WAWSE-00064 - CORRECT OPTION IS NULL

The correct response is blank

Must be at least one among the responses.

WAWSE-00065 - INVALID CORRECT OPTION

The correct response is incorrect

Must be at least one among the responses and should not contain any numeric and special characters except”,”.

WAWSE-00066 - INVALID ITEM OBJECTIVE LENGTH

The length of the objective is exceeding

Must be less than 50 characters

WAWSE-00067 - ITEM CLIENT ID EXISTS

The Item client id already exists in Database

The Item client ID must be unique.

WAWSE-00068 - INVALID CITIZENSHIP COUNTRY

The country provided is invalid. Please see documentation for valid country list.

The country provided is invalid. Please see documentation for valid country list.

WAWSE-00069 - INVALID TOPIC SCORES FOR THIS REGISTRATION

Please provide valid topic scores for this registration

Please provide valid topic scores for this registration

WAWSE-00071 - INVALID RESPONSES FOR TF ITEM TYPE

The TF item can have only 2 responses

The valid Responses are only A and B

WAWSE-00073 - NULL ITEM TEXT

The item text is blank

Must be string of any length

WAWSE-00074 - NULL ITEM POINTS

The item points is null

Must be Integer field

WAWSE-C####

WAWSE-C0001 - INVALID CSME REGISTRATION CODE

Format invalid. Enter either 5 digits followed by a hyphen and 6 digits, or " + "5 digits followed by a hyphen, the letter V (in caps) and 5 digits, or " + "2 digits, followed by a capital letter (A-Z) followed by 3 digits, a hyphen " + "and 6 digits or 2 digits, a capital letter followed by 3 digits, a hyphen, " + "a capital letter (A-Z) followed by 5 digits (xxxxx-xxxxxx or xxxxx- Vxxxxx, " + "xxAxxx-xxxxxx, xxAxxx-Axxxxx). All registration codes must be 30 characters or less.


WAWSE-C0002 - NULL CSME REGISTRATION CODE

You must supply a registration code


WAWSE-C0003 - INVALID NAME ON CERTIFICATE

The name on the certificate must be greater than 0 characters and not longer than 50 characters


WAWSE-C0004 - INVALID EMPLOYERS NAME

The employers name must not be longer than 40 characters


WAWSE-C0005 - INVALID CURRENT IT CERTS

The current IT certs field may not be longer than 40 characters


WAWSE-C0006 - INVALID PREREQ CODE

The Pre-Requisite code must not be longer than 30 characters


WAWSE-C0007 - INVALID INSTRUCTOR

The instructor name must not be longer than 30 characters


WAWSE-C0008 - INVALID EXTERNAL CERT

The external certificate must not be longer than 40 characters


WAWSE-A0001 - INVALID MIDDLE NAME

The middle name must not be longer than 30 characters


WAWSE-A0002 - INVALID MEMBER NUMBER

The member number may not be longer than 30 characters


WAWSE-A0003 - INVALID ORG NAME

The organization name may not be longer than 30 characters


WAWSE-A0004 - INVALID SALESFORCE CONTACT ID

The Salesforce contact id may not be longer than 30 characters


WAWSE-Ex####

WAWSE-Ex0001

EITHER NULL PRODUCT ID OR NULL CERTTYPE ID

Either only product id or certification type id should be provided.

WAWSE-Ex0002

NULL CANDIDATEID

A candidate ID must be provided

WAWSE-Ex0003

NULL AUTH CODE

An Auth code must be provided.

WAWSE-Ex0004

NULL STATUS OR NOT A PROPER STATUS(ACTIVE/INACTIVE)

Status cannot be null and can be only either ACTIVE or INACTIVE

WAWSE-Ex0005- INVALID AUTH CODE FORMAT


The authorization code provided must contain only letters, numbers, or these special characters ( . @ _

WAWSE-Ex0006

The candidate ID provided doesn't exist or belongs to a different region.

Candidate Id should be present in the system or it should belong the client region provided.

WAWSE-Ex0007

The candidate ID provided is not a test taker.

Candidate Id should be a test taker

WAWSE-Ex0008

The product ID provided doesn't exist or belongs to a different region

The product Id should belong to the client region provided.

WAWSE-Ex0009

The certification type provided doesn't exist.

The certification Type should be present in the system

WAWSE-RE####

WAWSE-RE0001 - FACILITY CODE SHOULD BE PRIVATE

The facility code is either unavailable or it may not belong to the client testing network.


WAWSE-RE0002 - PRODUCT CODE IS INCORRECT

The Delivery type for the product should be either PROCTORED or NOT_PROCTORED or PAPER_BASED


WAWSE-RE0003 - THE LOGIN IS NOT VALID

The candidate login is not a test taker or does not belong to the client region provided


WAWSE-RE0004 - DELIVERY TYPE SHOULD NOT BE NULL

The delivery_type for the product should be provided


WAWSE-RE0005 REGISTRATION ALREADY EXISTS

Registration already exists for the same user for the same product and testing center


WAWSE-RE0006 - THE DELIVERY TYPE DOES NOT EXIST FOR THE PRODUCT

The product with the delivery type provided is not present in our system


WAWSE-RE0007 - THE DATE CODE SHOULD BE FUTURE DATE OR IS INVALID

The date should be greater than current date


WAWSE-RE0008 – THE FACILITY CODE CANNOT BE NULL

Facility code is mandatory


WAWSE-RE0009 - THE DELIVERY TYPE SHOULD BE PROCTORED or NOT_PROCTORED or PAPER_BASED

Delivery type should be correct


WAWSE-RE0010 - PRODUCT CODE DOES NOT BELONG TO CLIENT REGION OR CODE IS INVALID

The product code is either inactive or unavailable or may belong to a different client region


WAWSE-RE0011 - SEND EMAIL SHOULD BE EITHER TRUE OR FALSE



WAWSE-RE0012 - Channel must be assigned to the product

The channel with the testing center is not available


WAWSE-VB####

WAWSE-VB0104 - THE TYPE OF ACTION NAME IS INVALID

The TYPE OF ACTION CAN BE EITHER ACTIVATE OR DEACTIVATE


WAWSE-VB0103 - THE TYPE OF ACTION NAME CANNOT BE NULL

The TYPE OF ACTION name is mandatory


WAWSE-VB0013 - VOUCHER BATCH DOES NOT EXIST

Voucher Batch does not exist


WAWSE-VB0002 - THE VOUCHER NAME CANNOT BE NULL

The voucher name is mandatory.



Access to certain features is restricted based on role type in an effort to reduce item exposure and promote process integrity. Please see the member role description page for information on permissions.


We’d Appreciate Your Feedback!