Versions Compared

Old Version 9

changes.mady.by.user jtel Support

Saved on

compared with

New Version Current

changes.mady.by.user jtel Support

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Content imported from a Scroll Translations translation file.
Sv translation
languageen

Retrieve WADL

This retrieves the WADL for the REST endpoint.

URL

Translations Ignore


Code Block
{{BaseURL}}/application.wadl

OR

{{BaseURL}}/application.wadl=detail=true



Authorization

None. This is the only function which requires no authorization.

Parameters

None

Responses

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

Returned Data (200 OK)

The WADL for the REST API.


Example


Translations Ignore


Code Block
languagexml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<application xmlns="http://wadl.dev.java.net/2009/02">
    <doc xmlns:jersey="http://jersey.java.net/" jersey:generatedBy="Jersey: 2.30.1 2020-02-21 08:10:47"/>
    <doc xmlns:jersey="http://jersey.java.net/" jersey:hint="This is simplified WADL with user and core resources only. To get full WADL with extended resources use the query parameter detail. Link: http://localhost:8091/rest/v1.0/application.wadl?detail=true"/>
    <grammars/>
    <resources base="http://localhost:8091/rest/v1.0/">
        <resource path="{clientsID}/dialler/campaigns">
            <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/>
            <method id="diallerCampaignsGetList" name="GET">
                <response>
                    <representation mediaType="application/json"/>
                </response>
            </method>
            <resource path="campaign/{id}/resultCodes">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/>
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="id" style="template" type="xs:int"/>
                <method id="diallerCampaignsGetResultCodesByID" name="GET">
                    <request>
                        <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="languagesID" style="query" type="xs:int"/>
                    </request>
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
            <resource path="clone">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/>
                <method id="diallerCampaignsClone" name="POST">
                    <request>
                        <representation mediaType="application/json"/>
                    </request>
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
            <resource path="campaign">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/>
                <method id="diallerCampaignsGetByName" name="GET">
                    <request>
                        <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="name" style="query" type="xs:string"/>
                    </request>
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
                <method id="diallerCampaignsDeleteByName" name="DELETE">
                    <request>
                        <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="name" style="query" type="xs:string"/>
                    </request>
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
            <resource path="campaign/{id}">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/>
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="id" style="template" type="xs:int"/>
                <method id="diallerCampaignsDeleteByID" name="DELETE">
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
                <method id="diallerCampaignsGetByID" name="GET">
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
        </resource>
        <resource path="routingrunner">
            <resource path="/run/{clientsID}/{caller}/{called}">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/>
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="caller" style="template" type="xs:string"/>
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="called" style="template" type="xs:string"/>
                <method id="runRoutingApplication" name="GET">
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
        </resource>
        <resource path="{clientsID}/dialler/contacts">
            <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/>
            <method id="getDiallerContacts" name="GET">
                <response>
                    <representation mediaType="application/json"/>
                </response>
            </method>
            <resource path="import">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/>
                <method id="diallerContactsImport" name="POST">
                    <request>
                        <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="overwriteDuplicates" style="query" type="xs:boolean"/>
                        <representation mediaType="application/json"/>
                    </request>
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
            <resource path="contact/{id}/unlock">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/>
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="id" style="template" type="xs:int"/>
                <method id="unlockDiallerContactsByID" name="PATCH">
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
            <resource path="contact">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/>
                <method id="getDiallerContactsByUserData" name="GET">
                    <request>
                        <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="userData" style="query" type="xs:string"/>
                    </request>
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
                <method id="deleteDiallerContactsByUserData" name="DELETE">
                    <request>
                        <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="userData" style="query" type="xs:string"/>
                    </request>
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
            <resource path="contact/lock">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/>
                <method id="lockDiallerContactsByUserData" name="PATCH">
                    <request>
                        <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="userData" style="query" type="xs:string"/>
                    </request>
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
            <resource path="contact/unlock">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/>
                <method id="unlockDiallerContactsByUserData" name="PATCH">
                    <request>
                        <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="userData" style="query" type="xs:string"/>
                    </request>
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
            <resource path="contact/{id}/lock">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/>
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="id" style="template" type="xs:int"/>
                <method id="lockDiallerContactsByID" name="PATCH">
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
            <resource path="contact/{id}">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/>
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="id" style="template" type="xs:int"/>
                <method id="getDiallerContactsByID" name="GET">
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
                <method id="deleteDiallerContactsByID" name="DELETE">
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
        </resource>
    </resources>
</application>





Sv translation
languagede

Status
colourRed
titleThis page is only available in English

Sv translation
languagefr

Récupération de la WADL

Cela permet de récupérer le WADL pour le point final REST.

URL

Translations Ignore


Code Block
{{BaseURL}}/application.wadl OR {{BaseURL}}/application.wadl=detail=true



Autorisation

Aucun. C'est la seule fonction qui ne nécessite pas d'autorisation.

Paramètres

Aucun

Réponses

Si la demande est exécutée, 200 OK est renvoyé. Voir Codes de retour pour d'autres codes de statut possibles.

Données retournées (200 OK)

WADL pour l'API REST.


Exemple


Translations Ignore


Code Block
languagexml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <application xmlns="http://wadl.dev.java.net/2009/02"> <doc xmlns:jersey="http://jersey.java.net/" jersey:generatedBy="Jersey: 2.30.1 2020-02-21 08:10:47"/> <doc xmlns:jersey="http://jersey.java.net/" jersey:hint="This is simplified WADL with user and core resources only. Pour obtenir une WADL complète avec des ressources étendues, utilisez le détail des paramètres d'interrogation. Link: http://localhost:8091/rest/v1.0/application.wadl?detail=true"/> <grammars/> <resources base="http://localhost:8091/rest/v1.0/"> <resource path="{clientsID}/dialler/campaigns"> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/> <method id="diallerCampaignsGetList" name="GET"> <response> <representation mediaType="application/json"/> </response> </method> <resource path="campaign/{id}/resultCodes"> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="id" style="template" type="xs:int"/> <method id="diallerCampaignsGetResultCodesByID" name="GET"> <request> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="languagesID" style="query" type="xs:int"/> </request> <response> <representation mediaType="application/json"/> </response> </method> </resource> <resource path="clone"> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/> <method id="diallerCampaignsClone" name="POST"> <request> <representation mediaType="application/json"/> </request> <response> <representation mediaType="application/json"/> </response> </method> </resource> <resource path="campaign"> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/> <method id="diallerCampaignsGetByName" name="GET"> <request> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="name" style="query" type="xs:string"/> </request> <response> <representation mediaType="application/json"/> </response> </method> <method id="diallerCampaignsDeleteByName" name="DELETE"> <request> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="name" style="query" type="xs:string"/> </request> <response> <representation mediaType="application/json"/> </response> </method> </resource> <resource path="campaign/{id}"> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="id" style="template" type="xs:int"/> <method id="diallerCampaignsDeleteByID" name="DELETE"> <response> <representation mediaType="application/json"/> </response> </method> <method id="diallerCampaignsGetByID" name="GET"> <response> <representation mediaType="application/json"/> </response> </method> </resource> </resource> <resource path="routingrunner"> <resource path="/run/{clientsID}/{caller}/{called}"> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="caller" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="called" style="template" type="xs:string"/> <method id="runRoutingApplication" name="GET"> <response> <representation mediaType="application/json"/> </response> </method> </resource> </resource> <resource path="{clientsID}/dialler/contacts"> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/> <method id="getDiallerContacts" name="GET"> <response> <representation mediaType="application/json"/> </response> </method> <resource path="import"> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/> <method id="diallerContactsImport" name="POST"> <request> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="overwriteDuplicates" style="query" type="xs:boolean"/> <representation mediaType="application/json"/> </request> <response> <representation mediaType="application/json"/> </response> </method> </resource> <resource path="contact/{id}/unlock"> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="id" style="template" type="xs:int"/> <method id="unlockDiallerContactsByID" name="PATCH"> <response> <representation mediaType="application/json"/> </response> </method> </resource> <resource path="contact"> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/> <method id="getDiallerContactsByUserData" name="GET"> <request> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="userData" style="query" type="xs:string"/> </request> <response> <representation mediaType="application/json"/> </response> </method> <method id="deleteDiallerContactsByUserData" name="DELETE"> <request> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="userData" style="query" type="xs:string"/> </request> <response> <representation mediaType="application/json"/> </response> </method> </resource> <resource path="contact/lock"> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/> <method id="lockDiallerContactsByUserData" name="PATCH"> <request> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="userData" style="query" type="xs:string"/> </request> <response> <representation mediaType="application/json"/> </response> </method> </resource> <resource path="contact/unlock"> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/> <method id="unlockDiallerContactsByUserData" name="PATCH"> <request> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="userData" style="query" type="xs:string"/> </request> <response> <representation mediaType="application/json"/> </response> </method> </resource> <resource path="contact/{id}/lock"> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="id" style="template" type="xs:int"/> <method id="lockDiallerContactsByID" name="PATCH"> <response> <representation mediaType="application/json"/> </response> </method> </resource> <resource path="contact/{id}"> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="clientsID" style="template" type="xs:int"/> <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="id" style="template" type="xs:int"/> <method id="getDiallerContactsByID" name="GET"> <response> <representation mediaType="application/json"/> </response> </method> <method id="deleteDiallerContactsByID" name="DELETE"> <response> <representation mediaType="application/json"/> </response> </method> </resource> </resource> </resources> </application>