AccessLogs

An access log is a list of all the requests that an user has made to the system

APIDescription
GET api/AccessLogs?filter={filter}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets a list of user log items
GET api/AccessLogs/{id}

Gets the user log item details

Account

An established relationship between a user and the system

APIDescription
GET api/Account

Gets the current account details
POST api/Account/Login

Validates an e-mail address and password combination, returns detailed results
POST api/Account/ForgotPassword

Enqueues an e-mail message with instructions to reset the Users password
POST api/Account/ResetPassword

Resets the User password with a reset token send by e-mail
POST api/Account/Unsubscribe?userid={userid}

Unsubscribes the user for commercial mailings
POST api/Account?operatorID={operatorID}

Creates a new account
PUT api/Account

Updates the account

Categories

A Category is used to group Offers

APIDescription
DELETE api/Categories/{id}

Removes an category
GET api/Categories?operatorID={operatorID}&filter={filter}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets a list of categories
GET api/Categories/{id}

Gets the category details
POST api/Categories

Creates a new category
PUT api/Categories/{id}

Updates an category

Customers

A Customer represents a company within the system that can view and order Offers

APIDescription
DELETE api/Customers/{id}

Removes an customer
GET Api/Customers/ToCsv

Gets al list of Customers within a CSV file
GET api/Customers?filter={filter}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets a list of customers
GET api/Customers/{id}

Gets the customer details
POST api/Customers

Creates a new customer
PUT api/Customers/{id}

Updates an customer

Files

A File represents a peace of binary data, containing a document or an image (such as a logo)

APIDescription
DELETE api/Files/{id}

Removes a file
GET Api/Files/{id}/Blob?openInline={openInline}

Gets the file bytes
GET api/Files/{id}

Gets the file details
GET api/Files?linkedEntityID={linkedEntityID}&propertyName={propertyName}

Gets the file details for a property from a specific object
POST api/Files

Creates a new file
PUT api/Files/{id}

Updates a file

Mailings

A Mailing sent at one time to multiple addressees by an Operator (as for promotional purposes)

APIDescription
DELETE api/Mailings/{id}/Users/{userid}

Deletes an User from a Mailing
DELETE api/Mailings/{id}/Customers/{customerid}

Deletes all Users linked to a Customer from a Mailing
DELETE api/Mailings/{id}/UserTypes/{userType}

Deletes all Users of a UserType from a Mailing
DELETE api/Mailings/{id}/Offers/{offerid}

Deletes an Offer from a Mailing
DELETE api/Mailings/{id}

Removes an mailing
GET api/Mailings?filter={filter}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets a list of mailings
GET api/Mailings/{id}

Gets the mailing details
POST api/Mailings/{id}/Users/{userid}

Adds an User to a Mailing
POST api/Mailings/{id}/Customers/{customerid}

Adds all Users linked to a Customer to a Mailing
POST api/Mailings/{id}/UserTypes/{userType}

Adds all Users of a UserType to a Mailing
POST api/Mailings/{id}/Offers/{offerid}

Adds an Offer to a Mailing
POST api/Mailings

Creates a new mailing
PUT api/Mailings/{id}

Updates an mailing

Messages

A Message represents a communication containing some information, news, advice, request, or the like, sent by the system

APIDescription
DELETE api/Messages/{id}

Removes an mailing
GET api/Messages?filter={filter}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets a list of mailings
GET api/Messages/{id}

Gets the mailing details
POST api/Messages

Creates a new mailing
PUT api/Messages/{id}

Updates an mailing

Offers

An Offer represents an item for sale (advertising space)

APIDescription
DELETE api/Offers/{id}/ExcludedCustomers/{customerid}

Removes an excluded Customer from an Offer
DELETE api/Offers/{id}

Removes an offer
GET Api/Offers/Topical?searchText={searchText}&operatorID={operatorID}&categoryID={categoryID}&dateFrom={dateFrom}&dateTo={dateTo}&saveSearch={saveSearch}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets a list of topical offers (searchable)
GET Api/Offers/Featured?operatorID={operatorID}&take={take}

Gets a list of featured offers
GET Api/Offers/{id}/RelatedOffers?filter={filter}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets the related offers from an offer
GET Api/Offers/ForMailings/{id}?filter={filter}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets the applicable Offers for a Mailing
GET Api/Offers/ToCsv

Gets al list of Offers within a CSV file
GET api/Offers?operatorID={operatorID}&showAll={showAll}&filter={filter}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets a list of offers
GET api/Offers/{id}

Gets the offer details
POST Api/Offers/{id}/Clone

Clones an offer
POST api/Offers/{id}/ExcludedCustomers/{customerid}

Excludes a Customer from an Offer
POST api/Offers

Creates a new offer
PUT api/Offers/{id}

Updates an offer

Operators

An Operator is the instance who facilitates the system

APIDescription
DELETE api/Operators/{id}

Removes an operator
GET api/Operators?filter={filter}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets a list of operators
GET api/Operators/{id}

Gets the operator details
POST Api/Operator/{id}/ContactRequest

Sends a contact request to the Operator
POST api/Operators

Creates a new operator
PUT api/Operators/{id}

Updates an operator

Orders

An Order represents a bought Offer by an User

APIDescription
DELETE api/Orders/{id}

Removes an order
GET api/Orders?filter={filter}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets a list of orders
GET api/Orders/{id}

Gets the order details
POST api/Orders

Creates a new order
PUT api/Orders/{id}

Updates an order

SavedSearches

A saved search is a search command stored by the user

APIDescription
DELETE api/SavedSearches/{id}

Removes a saved search
GET api/SavedSearches?filter={filter}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets a list of saved searches
GET api/SavedSearches/{id}

Gets the saved search details

Settings

Settings

APIDescription
DELETE api/Settings/{id}

Removes an setting
GET api/Settings?operatorID={operatorID}&filter={filter}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets a list of settings
GET api/Settings/{id}

Gets the setting details
GET api/Settings?key={key}&operatorID={operatorID}

Gets the setting details
POST api/Settings

Creates a new setting
PUT api/Settings/{id}

Updates an setting

Suppliers

A Supplier represents a company that owns and sells products and makes offers via the system

APIDescription
DELETE api/Suppliers/{id}

Removes an supplier
GET Api/Suppliers/ToCsv

Gets al list of Suppliers within a CSV file
GET api/Suppliers?operatorID={operatorID}&filter={filter}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets a list of suppliers
GET api/Suppliers/{id}

Gets the supplier details
POST api/Suppliers

Creates a new supplier
PUT api/Suppliers/{id}

Updates an supplier

Users

A person who uses a the System. A User can identify itself by e-mail address and password

APIDescription
DELETE api/Users/{id}

Removes an user
GET Api/Users/ForMailings/{id}?filter={filter}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets the applicable Users for a Mailing
GET Api/Users/ToCsv

Gets al list of Users within a CSV file
GET api/Users?filter={filter}&take={take}&skip={skip}&orderby={orderby}&descending={descending}

Gets a list of users
GET api/Users/{id}

Gets the user details
POST api/Users

Creates a new user
PUT api/Users/{id}

Updates an user