DokuWiki

This is an old revision of the document!

payloads:get_repository_names

The payloads web service is a REST structured service that derives its functionality based on syntax used when calling the web service. In it's simplest form, with no parameters supplied, the payload service returns a list of supported repository names and a count of the number of payloads in each repository.

Purpose: 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"
    }
}