تصميم:دواسوا/API

The API should implement the following verbs:

lookup

( name: string, count: int, index: int ): listings-enumeration

Returns count number of listings having name as the name, starting with index. Each listing item is comprised of basic package information sans contact information processed properly.

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

get_item_info

( id: string(id) ): item-info

Returns details information on a specific listing item; comprised of the package information and the contact information.

This is a GET request via the URL /item/id

request_insertion

( package-info: package-info, contact-info: contact-info, accept-terms: boolean )

Initiates an insertion request. Where:

• package-info : package information record
• contact-info : contact information record
• accept-terms : a boolean flag indicating the acceptance of the terms of service.

This request is a POST request

instate_entry

( id: string(id), token: string(token) )

Instates a listing via user action.

This is a GET request via the URL /instate-listing/id/token

request_entry_removal

( id: string(id) )

Initiates a listing deletion request

This is a GET request via the URL /removal-request/id

remove_entry

( id: string(id), token: string(token) )

Initiates the removal of a listing from the public listings into the archive. Listings removed via this procedure have a status flag removed-by-user.

This is a GET request via the URL /remove/id/token

get_user_listings

( email_address )

Initiates a listings retrieval procedure