This is an old revision of the document!
Web Service: Payloads
The Payloads web service is a general purpose web service that derives its functionality based on syntax used when calling the web service. The following paragraphs outline the various functions and syntax supported by the Payloads web service.
Function: Get supported repository names with payload counts.
Request Endpoint
| Method | URL |
|---|---|
| GET | https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads |
Request Body
N/A
Request Headers
| Key | Value |
|---|---|
| Content-Type | application/json |
| access_token | {soft-token} |
JSON Request Parameters
| Parm Name | Req/Opt | Format | Description |
|---|---|---|---|
| checksum_key | Required | [string] | The checksum key of a checksum record stored in the CeRTNA Portal. |
| checksum | Required | [string] | Locally calculated binary checksum value converted to a Base64 string. |
JSON Response Parameters
| Parm Name | Format | Description |
|---|---|---|
| is_valid | [string] | True if checksum values match, otherwise false. |
| 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 ValidateChecksum web service will produce a JSON formatted response with a code and message property populated.
Sample Request
Endpoint:
https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/validatechecksum
Headers:
Content-Type: application/json
Body:
{
"checksum_key" : "D6D5895C-60BF-4D21-AE5B-945C8E255665",
"checksum" : "1/l1YnJ1dnWFVbjEcUfp3IkBkPb1XBWhdC34T6nJ3YB859YuAtbhUUEG8Gcwimd1"
}
Sample Response
Status Code: 200
{
"is_valid": "true"
}
OR
Status Code: 500 (When an error occurs.)
(example 1)
{
"Exception": {
"Code": "DatabaseError",
"Message": "Conversion failed when converting from a character string to uniqueidentifier."
}
}