DokuWiki

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
access_token	{soft-token}

JSON Request Parameters

N/A

Notes:

Any condition that results in an unsuccessful call to the payloads 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/payloads

Sample Response

Status Code: 200

[
    {
        "Count": 0,
        "RepositoryName": "Responses"
    },
    {
        "Count": 0,
        "RepositoryName": "Requests"
    },
    {
        "Count": 96,
        "RepositoryName": "Processed"
    },
    {
        "Count": 0,
        "RepositoryName": "Invalid"
    }
]

OR

Status Code: 500 (When an error occurs.)

{
    "Exception": {
        "Code": "InvalidUserCredentials",
        "Message": "Invalid Session Id"
    }
}