DokuWiki

This is an old revision of the document!

Web Service: StoreChecksum

The StoreChecksum web service is used to store the checksum value of a Base64 string contained in a CeRTNA Standard XML PRIA_DOCUMENT node. The checksum value that is passed to the StoreChecksum web service is a SHA384 binary checksum that has been converted to a Base64 string.

The StoreChecksum web service, returns a checksum key. The checksum key is the value that should be stored in either the RequestChecksumValue (agents) or ResponseChecksumValue(counties) property of the PRIA_DOCUMENT node, depending on who made the StoreChecksum request.

The following sample shows the checksum key stored in PRIA_DOCUMENT node:

<PRIA_DOCUMENT _Code="Deed" DocumentSequenceIdentifier="1" RequestChecksumAlgorithm="SHA384" RequestChecksumValue="19AEA2BD-D793-44F0-BBA4-C7F33F0ED27A" ResponseChecksumAlgorithm="SHA384" ResponseChecksumValue="66182401-414F-4901-A212-B8AC18C3E1DE">

The checksum key is used in the ValidateChecksum web service to facilitate the process of validating a checksum value that was stored by another party.

Request Endpoint

Method	URL
POST	https://apex-prd.certna.org/storechecksum

Request Body

This endpoint accepts request body parameters using an application/json format.

Request Headers

Key	Value
Content-Type	application/json

JSON Request Parameters

Parm Name	Req/Opt	Format	Description
checksum	Required	[string]	Locally calculated binary checksum value converted to a Base64 string.

JSON Response Parameters

Parm Name	Format	Description
checksum_key	[string]	The key of the checksum record that was stored in the CeRTNA Portal.
code	[string]	Exception conditions will result in code/message being returned.
message	[string]	Longer description of exception condition.

As noted, any condition that results in an unsuccessful call to the StoreChecksum web service will produce a JSON formatted response with a code and message property populated. Successful calls will result in the checksum_key property being returned. The checksum_key is a required parameter of the ValidateChecksum web service.

Sample Request

Endpoint:

https://apex-prd.certna.org/storechecksum

Headers:

Content-Type: application/json

Body:

{
  "checksum" : "1/l1YnJ1dnWFVbjEcUfp3IkBkPb1XBWhdC34T6nJ3YB859YuAtbhUUEG8Gcwimd1"
}

Sample Response:

Status Code: 200

or

Status Code: 500 (When an error occurs.)

{
    "checksum_key": "315E7449-1A67-44A8-BCF4-7EB43666D54D"
}

or (example 1)

{
    "Exception": {
        "Code": "DatabaseError",
        "Message": "The user name or/and password are invalid."
    }
}

or (example 2)

{
    "Exception": {
        "Code": "DatabaseError",
        "Message": "Procedure or function 'spLogin_New' expects parameter '@PASSWORD', which was not supplied."
    }
}

Additional Comments

Comments and sample code are provided for reference purposes only and are not intended to show all exception handling conditions and/or completed code blocks.