Account

An established relationship between an User and the System

APIDescription
GET Api/v{apiVersion}/Account

Gets the current account details
PUT Api/v{apiVersion}/Account

Updates the account
POST Api/v{apiVersion}/Account/Login

Validates an e-mail address and password combination, returns detailed results
POST Api/v{apiVersion}/Account/ResetPassword

Resets the User password with a reset token send by e-mail
POST Api/v{apiVersion}/Account/ForgotPassword

Enqueues an e-mail message with instructions to reset the Users password
POST Api/v{apiVersion}/Account?operatorID={operatorID}

Creates a new account
POST Api/v{apiVersion}/Account/MailUnsubscribe?userid={userid}

Sets the IsMailSubscribed value to false for the current user

AdLocations

An AdLocation is a particular place for advertising space

APIDescription
GET Api/v{apiVersion}/AdLocations/{id}

Gets the adlocation details
GET Api/v{apiVersion}/AdLocations/{id}/AsGeoJson

Gets the object in GeoJSON format
GET Api/v{apiVersion}/AdLocations/{id}/AsWellKnownText

Gets the WKT of the adlocation spatial
GET Api/v{apiVersion}/AdLocations/NameValues?mediumid={mediumid}&term={term}&mapID={mapID}

Gets a list of Location Names that matches the search term
GET Api/v{apiVersion}/AdLocations?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of adlocations
GET Api/v{apiVersion}/AdLocations/AsGeoJson?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of adlocations in GeoJSON format
PUT Api/v{apiVersion}/AdLocations/{id}

Updates a adlocation
POST Api/v{apiVersion}/AdLocations

Creates a new adlocation
POST Api/v{apiVersion}/AdLocations/Upload

Creates new adlocations from Excel upload
DELETE Api/v{apiVersion}/AdLocations/{id}

Removes a adlocation

Areas

An Area is a particular part of a place, in this scope: Neighbourhood, Postcode area, Locality, District, Region or Country

APIDescription
GET Api/v{apiVersion}/Areas/{id}

Gets the area details
GET Api/v{apiVersion}/Areas/{id}/AsGeoJson

Gets the object in GeoJSON format
GET Api/v{apiVersion}/Areas/{id}/AsWellKnownText

Gets the WKT of the spatial
GET Api/v{apiVersion}/Areas/{id}/Offers?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of Offers for this Area
GET Api/v{apiVersion}/Areas/{id}/Parents?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of parent areas
GET Api/v{apiVersion}/Areas/{id}/Children?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of child areas
GET Api/v{apiVersion}/Areas/{id}/Features?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of Features for this Area
GET Api/v{apiVersion}/Areas/{id}/Parents/AsGeoJson?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of parent areas in GeoJSON format
GET Api/v{apiVersion}/Areas/{id}/Children/AsGeoJson?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of child areas in GeoJSON format
GET Api/v{apiVersion}/Areas/AsGeoJson?longitude={longitude}&latitude={latitude}&rangeInKm={rangeInKm}&query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of areas in GeoJSON format
GET Api/v{apiVersion}/Areas?longitude={longitude}&latitude={latitude}&rangeInKm={rangeInKm}&areaType={areaType}&query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of areas
PUT Api/v{apiVersion}/Areas/{id}

Updates an area
POST Api/v{apiVersion}/Areas

Creates a new area
POST Api/v{apiVersion}/Areas/{id}/Children

Adds children to an area
POST Api/v{apiVersion}/Areas/{id}/Children/{areaid}

Adds a child to an area
DELETE Api/v{apiVersion}/Areas/{id}

Removes an area
DELETE Api/v{apiVersion}/Areas/{id}/Children

Removes children from an area
DELETE Api/v{apiVersion}/Areas/{id}/Children/{areaid}

Removes a child from a area

CampaignBudgets

Budgets to a Campaign (e.g. exclude a Medium from being offered)

APIDescription
GET Api/v{apiVersion}/CampaignBudgets/{id}

Gets the campaignbudget details
PUT Api/v{apiVersion}/CampaignBudgets/{id}

Updates a campaignbudget
POST Api/v{apiVersion}/CampaignBudgets

Creates a new campaignbudget
DELETE Api/v{apiVersion}/CampaignBudgets/{id}

Removes a campaignbudget

CampaignExceptions

Exceptions to a Campaign (e.g. exclude a Medium from being offered)

APIDescription
GET Api/v{apiVersion}/CampaignExceptions/{id}

Gets the campaignexception details
PUT Api/v{apiVersion}/CampaignExceptions/{id}

Updates a campaignexception
POST Api/v{apiVersion}/CampaignExceptions

Creates a new campaignexception
DELETE Api/v{apiVersion}/CampaignExceptions/{id}

Removes a campaignexception

Campaigns

A Campaign is a predefined period in where Stores are offered to Order Mediums

APIDescription
GET Api/v{apiVersion}/Campaigns/{id}

Gets the campaign details
GET Api/v{apiVersion}/Campaigns/Current?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of the currently running campaigns
GET Api/v{apiVersion}/Campaigns/{id}/Orders?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of orders
GET Api/v{apiVersion}/Campaigns?storeid={storeid}&query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of campaigns
GET Api/v{apiVersion}/Campaigns/{id}/CampaignBudgets?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of budgets
GET Api/v{apiVersion}/Campaigns/{id}/CampaignExceptions?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of exceptions
GET Api/v{apiVersion}/Campaigns/{id}/Offers?storeid={storeid}&query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of all offers for the Campaign
PUT Api/v{apiVersion}/Campaigns/{id}

Updates a campaign
POST Api/v{apiVersion}/Campaigns

Creates a new campaign
DELETE Api/v{apiVersion}/Campaigns/{id}

Removes a campaign

Categories

A Category distinguishes one Medium from the other

APIDescription
GET Api/v{apiVersion}/Categories/{id}

Gets the category details
GET Api/v{apiVersion}/Categories?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of categories
PUT Api/v{apiVersion}/Categories/{id}

Updates a category
POST Api/v{apiVersion}/Categories

Creates a new category
DELETE Api/v{apiVersion}/Categories/{id}

Removes a category

Coverages

A Coverage is the way in which Mediums are shared out among a group or spread over an Area

APIDescription
GET Api/v{apiVersion}/Coverages/{id}

Gets the coverage details
GET Api/v{apiVersion}/Coverages/{id}/AsGeoJson

Gets the object in GeoJSON format
GET Api/v{apiVersion}/Coverages?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of coverages
GET Api/v{apiVersion}/Coverages/AsGeoJson?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of coverages in GeoJSON format
PUT Api/v{apiVersion}/Coverages/{id}

Updates a coverage
POST Api/v{apiVersion}/Coverages

Creates a new coverage
POST Api/v{apiVersion}/Coverages/Upload

Creates new coverages from Excel upload
DELETE Api/v{apiVersion}/Coverages/{id}

Removes a coverage

Customers

An Customer is a company who buys the services this platform offers

APIDescription
GET Api/v{apiVersion}/Customers/{id}

Gets the customer details
GET Api/v{apiVersion}/Customers/{id}/Logo

Gets the logo details for this object
GET Api/v{apiVersion}/Customers/{id}/AsGeoJson

Gets the object in GeoJSON format
GET Api/v{apiVersion}/Customers/{id}/AsWellKnownText

Gets the WKT of the customer spatial
GET Api/v{apiVersion}/Customers?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of customers
GET Api/v{apiVersion}/Customers/AsGeoJson?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of customers in GeoJSON format
GET Api/v{apiVersion}/Customers/{id}/Orders?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of Orders
GET Api/v{apiVersion}/Customers/{id}/Stores?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of stores
GET Api/v{apiVersion}/Customers/{id}/Children?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of child objects
GET Api/v{apiVersion}/Customers/{id}/Stores/AsGeoJson?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of stores in GeoJSON format
GET Api/v{apiVersion}/Customers/{id}/RestrictedCategories?query={query}&pageSize={pageSize}&currentPage={currentPage}&categoryBy={categoryBy}&descending={descending}

Gets a list of allowed Categories
PUT Api/v{apiVersion}/Customers/{id}

Updates a customer
POST Api/v{apiVersion}/Customers

Creates a new customer
POST Api/v{apiVersion}/Customers/{id}/RestrictedCategories/{categoriyid}

Adds a restricted Category to a Customer
DELETE Api/v{apiVersion}/Customers/{id}

Removes a customer
DELETE Api/v{apiVersion}/Customers/{id}/RestrictedCategories/{categoriyid}

Deletes a restricted Category from a Customer

Errors

An Error is advertising space in a given Medium and in a particular Area, available to be bought by a Store

APIDescription
GET Api/v{apiVersion}/Errors/{id}

Gets the Error details
GET Api/v{apiVersion}/Errors?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of Errors
PUT Api/v{apiVersion}/Errors/{id}

Updates a Error
POST Api/v{apiVersion}/Errors

Creates a new Error
DELETE Api/v{apiVersion}/Errors/{id}

Removes a Error

Features

A Feature is a distinctive characteristic of an Area that sets it apart from similar Areas.

APIDescription
GET Api/v{apiVersion}/Features/{id}

Gets the store details
GET Api/v{apiVersion}/Features/{id}/AsGeoJson

Gets the object in GeoJSON format
GET Api/v{apiVersion}/Features?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of stores
GET Api/v{apiVersion}/Features/AsGeoJson?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of stores in GeoJSON format
PUT Api/v{apiVersion}/Features/{id}

Updates a store
POST Api/v{apiVersion}/Features

Creates a new store
DELETE Api/v{apiVersion}/Features/{id}

Removes a store

Files

A File is a document stored in the system

APIDescription
GET Api/v{apiVersion}/Files/{id}

Gets the file details
GET Api/v{apiVersion}/files/{id}/blob?openInline={openInline}

Gets the file bytes
GET Api/v{apiVersion}/files/blob?linkedentityid={linkedentityid}&propertyName={propertyName}&openInline={openInline}

Gets the file bytes
PUT Api/v{apiVersion}/Files/{id}

Updates a file
POST Api/v{apiVersion}/Files

Creates a new file
DELETE Api/v{apiVersion}/Files/{id}

Removes a file

ImportJobs

An ImportJob is background job for importing excel data

APIDescription
GET Api/v{apiVersion}/ImportJobs/{id}

Gets the store details
GET Api/v{apiVersion}/ImportJobs?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of stores
GET Api/v{apiVersion}/ImportJobs/{id}/Errors?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of errors
GET Api/v{apiVersion}/ImportJobs/{id}/Stores?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of stores
GET Api/v{apiVersion}/ImportJobs/{id}/Coverages?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of stores
GET Api/v{apiVersion}/ImportJobs/{id}/AdLocations?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of adlocations
PUT Api/v{apiVersion}/ImportJobs/{id}

Updates a store
POST Api/v{apiVersion}/ImportJobs

Creates a new store
DELETE Api/v{apiVersion}/ImportJobs/{id}

Removes a store

LinkedEntities

A LinkedEntity is an entity which is linked to a User (Operator, Customer, Supplier or Store)

APIDescription
GET Api/v{apiVersion}/LinkedEntities?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of campaigns

Maps

A Map is a diagrammatic representation of an Area showing Features, Coverages and AdLocations

APIDescription
GET Api/v{apiVersion}/Maps/{id}

Gets the map details
GET Api/v{apiVersion}/Maps/{id}/FeatureFilterValues

Gets a list of available feature filter values for this map
GET Api/v{apiVersion}/Maps/{id}/CoverageFilterValues

Gets a list of available circulation filter values for this map
GET Api/v{apiVersion}/Maps/{id}/AdLocationFilterValues

Gets a list of available feature filter values for this map
GET Api/v{apiVersion}/Maps/{id}/AsGeoJson?includeStoreLocation={includeStoreLocation}

Gets the map details in GeoJSON format
GET Api/v{apiVersion}/Maps?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of maps
GET Api/v{apiVersion}/Maps/{id}/Areas?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of areas
GET Api/v{apiVersion}/Maps/{id}/FeatureFilterResults?featureItem={featureItem}&minValue={minValue}&maxValue={maxValue}&fillColor={fillColor}

Gets a list of filter results
GET Api/v{apiVersion}/Maps/{id}/AdLocationFilterResults?supplierid={supplierid}&nameFilter={nameFilter}&mediumid={mediumid}&iconUrl={iconUrl}

Gets a list of filter results
GET Api/v{apiVersion}/Maps/{id}/Mediums?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of areas
GET Api/v{apiVersion}/Maps/{id}/FeatureFilterResults/AsGeoJson?featureItem={featureItem}&minValue={minValue}&maxValue={maxValue}&fillColor={fillColor}

Gets a list of filter results in GeoJSON format
GET Api/v{apiVersion}/Maps/{id}/AdLocationFilterResults/AsGeoJson?supplierid={supplierid}&nameFilter={nameFilter}&mediumid={mediumid}&iconUrl={iconUrl}

Gets a list of filter results in GeoJSON format
GET Api/v{apiVersion}/Maps/{id}/CoverageFilterResults?supplierid={supplierid}&mediumid={mediumid}&minValue={minValue}&maxValue={maxValue}&fillColor={fillColor}

Gets a list of filter results in GeoJSON format
GET Api/v{apiVersion}/Maps/{id}/CoverageFilterResults/AsGeoJson?supplierid={supplierid}&mediumid={mediumid}&minValue={minValue}&maxValue={maxValue}&fillColor={fillColor}

Gets a list of filter results in GeoJSON format
PUT Api/v{apiVersion}/Maps/{id}

Updates a map
POST Api/v{apiVersion}/Maps

Creates a new map
POST Api/v{apiVersion}/Maps/{id}/Areas

Adds arearen to an Map
POST Api/v{apiVersion}/Maps/{id}/Areas/{areaid}

Adds a area to an Map
DELETE Api/v{apiVersion}/Maps/{id}

Removes a customer
DELETE Api/v{apiVersion}/Maps/{id}/Areas/{areaid}

Removes a area from a Map

Mediums

A Medium is the intervening substance through which sensory impressions are conveyed or physical forces are transmitted

APIDescription
GET Api/v{apiVersion}/Mediums/{id}

Gets the medium details
GET Api/v{apiVersion}/Mediums/{id}/Logo

Gets the logo details for this object
GET Api/v{apiVersion}/Mediums?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of mediums
GET Api/v{apiVersion}/Mediums/{id}/Offers?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of offers
GET Api/v{apiVersion}/Mediums/{id}/Coverages?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of presence items
GET Api/v{apiVersion}/Mediums/{id}/AdLocations?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of adlocations
GET Api/v{apiVersion}/Mediums/{id}/Coverages/AsGeoJson?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of presence items in GeoJSON format
GET Api/v{apiVersion}/Mediums/{id}/AdLocations/AsGeoJson?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of adlocations in GeoJSON format
GET Api/v{apiVersion}/Mediums/{id}/AsGeoJson?areaid={areaid}&query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of coverages or adlocations in GeoJSON format
PUT Api/v{apiVersion}/Mediums/{id}

Updates a medium
POST Api/v{apiVersion}/Mediums

Creates a new medium
POST Api/v{apiVersion}/Mediums/{id}/UpdateCirculations?totalCirculationValue={totalCirculationValue}

Updates all Circulation Values of the Coverages
DELETE Api/v{apiVersion}/Mediums/{id}

Removes a medium

Messages

A Message is a written and recorded communication sent to or left for a User

APIDescription
GET Api/v{apiVersion}/Messages/{id}

Gets the message details
GET Api/v{apiVersion}/Messages?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of messages
PUT Api/v{apiVersion}/Messages/{id}

Updates a message
POST Api/v{apiVersion}/Messages

Creates a new message
DELETE Api/v{apiVersion}/Messages/{id}

Removes a message

Offers

An Offer is advertising space in a given Medium and in a particular Area, available to be bought by a Store

APIDescription
GET Api/v{apiVersion}/Offers/{id}

Gets the offer details
GET Api/v{apiVersion}/Offers/{id}/AsGeoJson?areaid={areaid}

Gets the offer in GeoJSON format
GET Api/v{apiVersion}/Offers/{id}/Rates?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of rates for a particular offer
GET Api/v{apiVersion}/Offers?storeid={storeid}&campaignid={campaignid}&query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of offers
PUT Api/v{apiVersion}/Offers/{id}

Updates a offer
POST Api/v{apiVersion}/Offers

Creates a new offer
DELETE Api/v{apiVersion}/Offers/{id}

Removes a offer

Operators

An Operator is the instance that facilitates the System for its Customers

APIDescription
GET Api/v{apiVersion}/Operators/{id}

Gets the operator details
GET Api/v{apiVersion}/Operators?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of operators
PUT Api/v{apiVersion}/Operators/{id}

Updates an operator
POST Api/v{apiVersion}/Operators

Creates a new operator
DELETE Api/v{apiVersion}/Operators/{id}

Removes an operator

OrderItems

An OrderItem is a detailed item of an Order, containing a Medium, Unit and a Price.

APIDescription
GET Api/v{apiVersion}/OrderItems/{id}

Gets the orderitem details
PUT Api/v{apiVersion}/OrderItems/{id}

Updates a orderitem
POST Api/v{apiVersion}/OrderItems

Creates a new orderitem
POST Api/v{apiVersion}/OrderItems?offerid={offerid}&storeid={storeid}&orderid={orderid}&campaignid={campaignid}&numberOfPieces={numberOfPieces}&preferredStartDate={preferredStartDate}

Creates an new OrderItem for an Offer
DELETE Api/v{apiVersion}/OrderItems/{id}

Removes a orderitem

Orders

An Order is a request for a Store containing 1 or multiple OrderItems

APIDescription
GET Api/v{apiVersion}/Orders/{id}

Gets the order details
GET Api/v{apiVersion}/Orders/Current?storeid={storeid}&offerid={offerid}&campaignid={campaignid}

Gets the current order details
GET Api/v{apiVersion}/Orders?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of orders
GET Api/v{apiVersion}/Orders/{id}/OrderItems?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderitemBy={orderitemBy}&descending={descending}

Gets a list of orderitems
PUT Api/v{apiVersion}/Orders/{id}

Updates a order
POST Api/v{apiVersion}/Orders

Creates a new order
PATCH Api/v{apiVersion}/Orders/{id}?property={property}&value={value}

Patches an order
DELETE Api/v{apiVersion}/Orders/{id}

Removes a order

Rates

An Rate is advertising space in a given Medium and in a particular Area, available to be bought by a Store

APIDescription
GET Api/v{apiVersion}/Rates/{id}

Gets the rate details
GET Api/v{apiVersion}/Rates?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of rates
PUT Api/v{apiVersion}/Rates/{id}

Updates a rate
POST Api/v{apiVersion}/Rates

Creates a new rate
DELETE Api/v{apiVersion}/Rates/{id}

Removes a rate

Reports

...

APIDescription
GET Api/v{apiVersion}/Reports/StoresWithBudgetAvailable?campaignEndDate={campaignEndDate}&query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of Stores with budget available per Campaign
GET Api/v{apiVersion}/Reports/StoresWithoutActiveOffers?customerid={customerid}&mediumid={mediumid}&query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of Stores without active Offers

Settings

A Setting is a value at which the system can be adjusted to operate

APIDescription
GET Api/v{apiVersion}/Settings/{id}

Gets the setting details
GET Api/v{apiVersion}/Settings?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of settings
PUT Api/v{apiVersion}/Settings/{id}

Updates an setting

Stores

A Store is a shop of any size or kind owned by a Customer

APIDescription
GET Api/v{apiVersion}/Stores/{id}

Gets the store details
GET Api/v{apiVersion}/Stores/{id}/Logo

Gets the logo details for this object
GET Api/v{apiVersion}/Stores/{id}/AsGeoJson

Gets the object in GeoJSON format (address location and market area)
GET Api/v{apiVersion}/Stores/{id}/AsWellKnownText

Gets the WKT of the store spatial
GET Api/v{apiVersion}/Stores/{id}/Offers/{offerid}

Gets the details of an Offer for the Store
GET Api/v{apiVersion}/Stores/{id}/Orders/Current?campaignid={campaignid}

Gets the current order details
GET Api/v{apiVersion}/Stores/AsGeoJson?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of stores in GeoJSON format
GET Api/v{apiVersion}/Stores/{id}/Maps?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of Maps
GET Api/v{apiVersion}/Stores/{id}/Areas?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of Areas
GET Api/v{apiVersion}/Stores/{id}/Offers?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of Offers
GET Api/v{apiVersion}/Stores/{id}/Orders?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of Orders
GET Api/v{apiVersion}/Stores/{id}/Mediums?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of Mediums
GET Api/v{apiVersion}/Stores/{id}/Children?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of child objects
GET Api/v{apiVersion}/Stores/{id}/Campaigns?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of Campaigns
GET Api/v{apiVersion}/Stores?campaignid={campaignid}&query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of stores
GET Api/v{apiVersion}/Stores/{id}/Campaigns/{campaignid}/Offers?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of Offers for a Campaign
PUT Api/v{apiVersion}/Stores/{id}

Updates a store
POST Api/v{apiVersion}/Stores

Creates a new store
POST Api/v{apiVersion}/Stores/Upload

Creates new adlocations from Excel upload
DELETE Api/v{apiVersion}/Stores/{id}

Removes a store

Suppliers

An Supplier is a person or organization that provides Mediums

APIDescription
GET Api/v{apiVersion}/Suppliers/{id}

Gets the supplier details
GET Api/v{apiVersion}/Suppliers/{id}/Logo

Gets the logo details for this object
GET Api/v{apiVersion}/Suppliers?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of suppliers
GET Api/v{apiVersion}/Suppliers/{id}/Mediums?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of mediums
GET Api/v{apiVersion}/Suppliers/{id}/Children?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of child objects
PUT Api/v{apiVersion}/Suppliers/{id}

Updates a supplier
POST Api/v{apiVersion}/Suppliers

Creates a new supplier
POST Api/v{apiVersion}/Suppliers/{id}/UpdateCirculations?totalCirculationValue={totalCirculationValue}

Updates all Circulation Values of the Coverages
DELETE Api/v{apiVersion}/Suppliers/{id}

Removes a supplier

Users

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

APIDescription
GET Api/v{apiVersion}/Users/{id}

Gets the user details
GET Api/v{apiVersion}/Users?query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Gets a list of users
PUT Api/v{apiVersion}/Users/{id}

Updates an user
POST Api/v{apiVersion}/Users

Creates a new user
DELETE Api/v{apiVersion}/Users/{id}

Removes an user