C# Класс BalihooBlipDotNet.Blip

The BLIP object and its methods.
Показать файл Открыть проект

Private Properties

Свойство Тип Описание
IsValidEmail bool
IsValidUrl bool

Открытые методы

Метод Описание
Blip ( string apiKey, string secretKey, string endpoint = "https://blip.balihoo-cloud.com" ) : System

The Blip constructor.
BulkLoad ( string brandKey, string source, string filePath, bool implicitDelete, int expectedRecordCount, string successEmail = null, string failEmail = null, string successCallbackUrl = null, string failCallbackUrl = null ) : BlipResponse

Load a bulk location file into BLIP.
DeleteLocation ( string brandKey, string locationKey, string source ) : BlipResponse

Delete a location.
GetBrandKeys ( ) : BlipResponse

Get a list of brandKeys that the API user is authorized to access.
GetBrandProjections ( string brandKey ) : BlipResponse

Get a list of data projections available for an individual brand.
GetBrandSources ( string brandKey ) : BlipResponse

Get a list of data sources available for an individual brand.
GetLocation ( string brandKey, string locationKey, string projection = "universal", bool includeRefs = false ) : BlipResponse

Get data for an individual location that belongs to the specified brand.
GetLocationKeys ( string brandKey, string projection = "universal" ) : BlipResponse

Get a list of locationKeys for all locations belonging to the specified brand.
Ping ( ) : BlipResponse

Ping the BLIP API.
PutLocation ( string brandKey, string locationKey, string source, string locationData ) : BlipResponse

Add or update a location.
QueryLocations ( string brandKey, string query, string view = "full", int pageSize, int pageNumber, string sortColumn = "locationKey", string sortDirection = "asc" ) : BlipResponse

Get data for locations in a single brand that match the specified BLIP query.

Приватные методы

Метод Описание
IsValidEmail ( string email ) : bool

Validate email address or comma delimited list of email addresses.
IsValidUrl ( string url ) : bool

Validate URL.

Описание методов

Blip() публичный Метод

The Blip constructor.
public Blip ( string apiKey, string secretKey, string endpoint = "https://blip.balihoo-cloud.com" ) : System
apiKey string The key used to access the BLIP API.
secretKey string The secret key used to access the BLIP API.
endpoint string The BLIP endpoint to target. Defaults to Balihoo's production environment.
Результат System

BulkLoad() публичный Метод

Load a bulk location file into BLIP.
public BulkLoad ( string brandKey, string source, string filePath, bool implicitDelete, int expectedRecordCount, string successEmail = null, string failEmail = null, string successCallbackUrl = null, string failCallbackUrl = null ) : BlipResponse
brandKey string The unique identifier for a single brand.
source string The unique identifier for the data source.
filePath string The full path to the bulk location file.
implicitDelete bool Whether or not to delete locations from BLIP if they're missing from the file.
expectedRecordCount int The number of location records to expect in the file.
successEmail string An optional email address to notify upon success. Can be a comma-delimited list.
failEmail string An optional email address to notify upon failure. Can be a comma-delimited list.
successCallbackUrl string An optional URL to call upon success.
failCallbackUrl string An optional URL to call upon failure.
Результат BlipResponse

DeleteLocation() публичный Метод

Delete a location.
public DeleteLocation ( string brandKey, string locationKey, string source ) : BlipResponse
brandKey string The unique identifier for a single brand.
locationKey string The unique identifier for a single location within the brand.
source string The unique identifier for the data source being used to delete the location.
Результат BlipResponse

GetBrandKeys() публичный Метод

Get a list of brandKeys that the API user is authorized to access.
public GetBrandKeys ( ) : BlipResponse
Результат BlipResponse

GetBrandProjections() публичный Метод

Get a list of data projections available for an individual brand.
public GetBrandProjections ( string brandKey ) : BlipResponse
brandKey string The unique identifier for a single brand.
Результат BlipResponse

GetBrandSources() публичный Метод

Get a list of data sources available for an individual brand.
public GetBrandSources ( string brandKey ) : BlipResponse
brandKey string The unique identifier for a single brand.
Результат BlipResponse

GetLocation() публичный Метод

Get data for an individual location that belongs to the specified brand.
public GetLocation ( string brandKey, string locationKey, string projection = "universal", bool includeRefs = false ) : BlipResponse
brandKey string The unique identifier for a single brand.
locationKey string The unique identifier for a single location within the brand.
projection string Optionally filter data in a single projection. Defaults to "universal".
includeRefs bool Optionally include objects referenced by the location in its data. Defaults to false.
Результат BlipResponse

GetLocationKeys() публичный Метод

Get a list of locationKeys for all locations belonging to the specified brand.
public GetLocationKeys ( string brandKey, string projection = "universal" ) : BlipResponse
brandKey string The unique identifier for a single brand.
projection string Optionally filter data to locations in a single projecttion. Defaults to "universal".
Результат BlipResponse

Ping() публичный Метод

Ping the BLIP API.
public Ping ( ) : BlipResponse
Результат BlipResponse

PutLocation() публичный Метод

Add or update a location.
public PutLocation ( string brandKey, string locationKey, string source, string locationData ) : BlipResponse
brandKey string The unique identifier for a single brand.
locationKey string The unique identifier for a single location within the brand.
source string The unique identifier for the data source being used to add/update the location.
locationData string The stringified JSON location document.
Результат BlipResponse

QueryLocations() публичный Метод

Get data for locations in a single brand that match the specified BLIP query.
public QueryLocations ( string brandKey, string query, string view = "full", int pageSize, int pageNumber, string sortColumn = "locationKey", string sortDirection = "asc" ) : BlipResponse
brandKey string The unique identifier for a single brand.
query string A stringified JSON query used to filter locations in BLIP.
view string Optionally specify the view returned. Defaults to "full".
pageSize int Optionally specify the number of results to include in each page of results.
pageNumber int Optionally specify the page index to return.
sortColumn string The column by which to sort results. ('name' or 'locationKey' -- defaults to 'locationKey').
sortDirection string The direction to sort results. ('asc' or 'desc' -- defaults to 'asc').
Результат BlipResponse