Arla Encyclopedia

API Reference

API Version 1

Alphabetical

Provides access to encyclopedia.

APIDescription
GET api/{lang}/alphabet?letters={letters}

Get all info by alphabet.

Guides

Provides access to encyclopedia guides.

APIDescription
GET api/{lang}/guides

Get all encyclopedia guides.

GET api/{lang}/guides/id/{id}

Get full guide content by guide ID.

GET api/{lang}/guides/{urlSegment}

Get full guide content by guide Url segment.

Ingredients

Provides access to ingredients

APIDescription
GET api/{lang}/ingredients

Get all encyclopedia ingredients.

GET api/{lang}/ingredients/id/{id}

Get ingredient by id.

GET api/{lang}/ingredients/tag/{tagId}

Get ingredient by Tag.

GET api/{lang}/ingredients/{urlSegment}

Get ingredient by Url segment.

Instruction

Provides access to instructions

APIDescription
GET api/{lang}/instructions

Get all encyclopedia instructions.

GET api/{lang}/instructions/id/{id}

Get instruction by id.

GET api/{lang}/instructions/{urlSegment}

Get instruction by Url segment.

GET api/{lang}/instructions/tag/{tagId}

Get by Tag.

Pdb

Provides access to PDB data.

APIDescription
GET api/pdb/categories/{pageId}?name={name}

No documentation available.

GET api/pdb/categories/{pageId}/{name}

No documentation available.

GET api/pdb/products/{pageId}?name={name}

No documentation available.

GET api/pdb/products/{pageId}/{name}

No documentation available.

GET api/pdb/manufactures/{pageId}?name={name}

No documentation available.

GET api/pdb/manufactures/{pageId}/{name}

No documentation available.

Provides access to search functionality

APIDescription
GET api/{lang}/search?query={query}

Search pages by query

GET api/{lang}/search/tag/{tagId}

Search pages by tag

Techniques

Provides access to techniques

APIDescription
GET api/{lang}/techniques

Get all encyclopedia techniques.

GET api/{lang}/techniques/id/{id}

Get technique by id.

GET api/{lang}/techniques/{urlSegment}

Get technique by Url segment.

GET api/{lang}/techniques/tag/{tagId}

Get by Tag.

API Version 2

Generic

Provides generic access to content.

APIDescription
GET api/v2/{lang}/{instance}/all?skip={skip}&take={take}

Get content for provided instance.

GET api/v2/{lang}/{instance}/{contentType}?ids[0]={ids[0]}&ids[1]={ids[1]}&take={take}&skip={skip}

Get specified content for provided instance.

GET api/v2/{lang}/{instance}/feed?page={page}

Get feed elements for provided instance.

GET api/v2/{lang}/{instance}/tags?skip={skip}&take={take}

Get all tags for porovided instance.

GET api/v2/{lang}/{instance}/{contentType}/{urlSegment}?withRelations={withRelations}

Get specified content for provided instance by content URL Segment.

GET api/v2/{lang}/{instance}/{contentType}/tag/{tagId}?take={take}&skip={skip}

Get specified content for provided instance by tag.

GET api/v2/{lang}/{instance}/{contentType}/tag/{tagId}/random?take={take}

Get specified content for provided instance by tag in random order.

GET api/v2/{lang}/{instance}/{contentType}/categories

Get specified content by global categories.

GlobalCategories

Provides access to global categories.

APIDescription
GET api/v2/{lang}/globalcategories

Get all global categories.

SearchApi

Provides generic access to content.

APIDescription
GET api/v2/{lang}/{instance}/search/{skip}/{take}?excludeIds={excludeIds}&contentTypes={contentTypes}&categories={categories}&query={query}&boostLastDays={boostLastDays}&boostCategoryProperties={boostCategoryProperties}&boostModelProperties={boostModelProperties}&orderByProperties={orderByProperties}

Get content for provided instance.