DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

==== 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:** <color #22b14c>Get supported repository names with payload counts.</color>

<color #7092be>Request Endpoint</color>

{{tablelayout?colwidth="75px,575px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Method ^ URL ^
| GET | <nowiki>https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads</nowiki> |

<color #7092be>Request Body</color>

N/A

<color #7092be>Request Headers</color>

{{tablelayout?colwidth="150px,450px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Key ^ Value ^
| access_token | {soft-token} |

<color #7092be>JSON Request Parameters</color>

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.

<color #7092be>Sample Request</color>

**Endpoint:**

<nowiki>https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/payloads</nowiki>

<color #7092be>Sample Response</color>

Status Code: 200

<code json>
[
    {
        "Count": 0,
        "RepositoryName": "Responses"
    },
    {
        "Count": 0,
        "RepositoryName": "Requests"
    },
    {
        "Count": 96,
        "RepositoryName": "Processed"
    },
    {
        "Count": 0,
        "RepositoryName": "Invalid"
    }
]
</code>

**OR**

Status Code: 500  (When an error occurs.)

<code json>
{
    "Exception": {
        "Code": "InvalidUserCredentials",
        "Message": "Invalid Session Id"
    }
}
</code>

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International