عرض مصدر تصميم:دواسوا/API

<div dir="ltr" style="direction: ltr;">
The API should implement the following verbs:

== <code>lookup</code> ==
<code>( <var>name</var>: string, <var>count</var>: int, <var>index</var>: int ): listings-enumeration</code>

Returns <var>count</var> number of listings having <var>name</var> as the name, starting with <var>index</var>. Each listing item is comprised of basic [[../data#package-info|package information]] sans [[../data#contact-info|contact information]] processed properly.

This is a GET request via the URL <code>/lookup?<var>name</var>=&<var>count</var>=&<var>index</var>=</code>


== <code>get_item_info</code> ==
<code>( <var>id</var>: string(id) ): item-info</code>

Returns details information on a specific listing item; comprised of the [[../data#package-info|package information]] and the [[../data#contact-info|contact information]].

This is a GET request via the URL <code>/item/<var>id</var></code>


== <code>request_insertion</code> ==
<code>( <var>package-info</var>: [[../data#package-info|package-info]], <var>contact-info:</var> [[../data#contact-info|contact-info]], <var>accept-terms</var>: boolean )</code>

Initiates an [[../workflow#insertion request|insertion request]]. Where:
* [[../data#package-info|package-info]] : package information record
* [[../data#contact-info|contact-info]] : contact information record
* accept-terms : a boolean flag indicating the acceptance of the terms of service.
This request is a POST request


== <code>instate_entry</code> ==
<code>( <var>id</var>: string(id), <var>token</var>: string([[../cryptographic-token|token]]) )</code>

[[../workflow#Listing instatement|Instates a listing]] via user action.

This is a GET request via the URL <code>/instate-listing/<var>id</var>/<var>token</var></code>


== <code>remove_entry</code> ==
<code>( <var>id</var>: string(id), <var>token</var>: string([[../cryptographic token|token]]) )</code>

Initiates the [[../workflow#Listing removal|removal of a listing]] from the public listings into the [[../data#archive|archive]]. Listings removed via this procedure have a status flag <kbd>removed-by-user</kbd>.

This is a GET request via the URL <code>/remove/<var>id</var>/<var>token</var></code>


== <code>request_user_listings</code> ==
<code>( <var>email_address</var>, <var>token</var>: string([[../cryptographic token|token]]) )</code>

Initiates the [[../workflow#Inquiring user listings|retrieval of listings]] associated with a given user's email address.

</div>