Guindex HTTP API

# Install the command line client
$ pip install coreapi-cli

# Install the Python client library
$ pip install coreapi

contact

create

POST /api/contact/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required	Name of message poster
`email` required	Email of message poster (for sending replies)
`subject` required	Subject of message
`message` required	Message body

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action contact create -p name=... -p email=... -p subject=... -p message=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["contact", "create"]
var params = {
    name: ...,
    email: ...,
    subject: ...,
    message: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["contact", "create"]
params = {
    "name": ...,
    "email": ...,
    "subject": ...,
    "message": ...,
}
result = client.action(schema, action, params=params)

contributors

list

GET /api/contributors/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action contributors list -p page=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["contributors", "list"]
var params = {
    page: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["contributors", "list"]
params = {
    "page": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/contributors/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user.

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action contributors read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["contributors", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["contributors", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/contributors/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`usingEmailAlerts`	Does this contributor have email alerts enabled?
`usingTelegramAlerts`	Does this contributor have Telegram alerts enabled?

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action contributors partial_update -p id=... -p usingEmailAlerts=... -p usingTelegramAlerts=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["contributors", "partial_update"]
var params = {
    id: ...,
    usingEmailAlerts: ...,
    usingTelegramAlerts: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["contributors", "partial_update"]
params = {
    "id": ...,
    "usingEmailAlerts": ...,
    "usingTelegramAlerts": ...,
}
result = client.action(schema, action, params=params)

pending_price_creates

list

GET /api/pending_price_creates/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pending_price_creates list -p page=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pending_price_creates", "list"]
var params = {
    page: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pending_price_creates", "list"]
params = {
    "page": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/pending_price_creates/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this guinness pending create.

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pending_price_creates read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pending_price_creates", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pending_price_creates", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/pending_price_creates/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this guinness pending create.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`approved`	Is contribution approved?
`rejectReason`	Reason for rejecting contribution

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pending_price_creates partial_update -p id=... -p approved=... -p rejectReason=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pending_price_creates", "partial_update"]
var params = {
    id: ...,
    approved: ...,
    rejectReason: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pending_price_creates", "partial_update"]
params = {
    "id": ...,
    "approved": ...,
    "rejectReason": ...,
}
result = client.action(schema, action, params=params)

pending_pub_creates

list

GET /api/pending_pub_creates/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pending_pub_creates list -p page=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pending_pub_creates", "list"]
var params = {
    page: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pending_pub_creates", "list"]
params = {
    "page": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/pending_pub_creates/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this pub pending create.

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pending_pub_creates read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pending_pub_creates", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pending_pub_creates", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/pending_pub_creates/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this pub pending create.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`approved`	Is contribution approved?
`rejectReason`	Reason for rejecting contribution

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pending_pub_creates partial_update -p id=... -p approved=... -p rejectReason=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pending_pub_creates", "partial_update"]
var params = {
    id: ...,
    approved: ...,
    rejectReason: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pending_pub_creates", "partial_update"]
params = {
    "id": ...,
    "approved": ...,
    "rejectReason": ...,
}
result = client.action(schema, action, params=params)

pending_pub_patches

list

GET /api/pending_pub_patches/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pending_pub_patches list -p page=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pending_pub_patches", "list"]
var params = {
    page: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pending_pub_patches", "list"]
params = {
    "page": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/pending_pub_patches/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this pub pending patch.

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pending_pub_patches read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pending_pub_patches", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pending_pub_patches", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/pending_pub_patches/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this pub pending patch.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`approved`	Is contribution approved?
`rejectReason`	Reason for rejecting contribution

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pending_pub_patches partial_update -p id=... -p approved=... -p rejectReason=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pending_pub_patches", "partial_update"]
var params = {
    id: ...,
    approved: ...,
    rejectReason: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pending_pub_patches", "partial_update"]
params = {
    "id": ...,
    "approved": ...,
    "rejectReason": ...,
}
result = client.action(schema, action, params=params)

pubs

list

GET /api/pubs/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`name`
`closed`
`servingGuinness`
`county`
`creator`
`search`	A search term.

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pubs list -p page=... -p name=... -p closed=... -p servingGuinness=... -p county=... -p creator=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pubs", "list"]
var params = {
    page: ...,
    name: ...,
    closed: ...,
    servingGuinness: ...,
    county: ...,
    creator: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pubs", "list"]
params = {
    "page": ...,
    "name": ...,
    "closed": ...,
    "servingGuinness": ...,
    "county": ...,
    "creator": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/pubs/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required	Pub name
`county`	County pub is located in
`longitude` required	Longitude of pub location
`latitude` required	Latitude of pub location
`closed`	Is pub permanently closed?
`servingGuinness`	Is pub serving Guinness?

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pubs create -p name=... -p county=... -p longitude=... -p latitude=... -p closed=... -p servingGuinness=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pubs", "create"]
var params = {
    name: ...,
    county: ...,
    longitude: ...,
    latitude: ...,
    closed: ...,
    servingGuinness: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pubs", "create"]
params = {
    "name": ...,
    "county": ...,
    "longitude": ...,
    "latitude": ...,
    "closed": ...,
    "servingGuinness": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/pubs/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this pub.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`name`
`closed`
`servingGuinness`
`county`
`creator`
`search`	A search term.

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pubs read -p id=... -p name=... -p closed=... -p servingGuinness=... -p county=... -p creator=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pubs", "read"]
var params = {
    id: ...,
    name: ...,
    closed: ...,
    servingGuinness: ...,
    county: ...,
    creator: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pubs", "read"]
params = {
    "id": ...,
    "name": ...,
    "closed": ...,
    "servingGuinness": ...,
    "county": ...,
    "creator": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/pubs/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this pub.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`name`
`closed`
`servingGuinness`
`county`
`creator`
`search`	A search term.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name`	Pub name
`county`	County pub is located in
`longitude`	Longitude of pub location
`latitude`	Latitude of pub location
`closed`	Is pub permanently closed?
`servingGuinness`	Is pub serving Guinness?

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pubs partial_update -p id=... -p name=... -p county=... -p longitude=... -p latitude=... -p closed=... -p servingGuinness=... -p name=... -p closed=... -p servingGuinness=... -p county=... -p creator=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pubs", "partial_update"]
var params = {
    id: ...,
    name: ...,
    county: ...,
    longitude: ...,
    latitude: ...,
    closed: ...,
    servingGuinness: ...,
    name: ...,
    closed: ...,
    servingGuinness: ...,
    county: ...,
    creator: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pubs", "partial_update"]
params = {
    "id": ...,
    "name": ...,
    "county": ...,
    "longitude": ...,
    "latitude": ...,
    "closed": ...,
    "servingGuinness": ...,
    "name": ...,
    "closed": ...,
    "servingGuinness": ...,
    "county": ...,
    "creator": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

prices > list

GET /api/pubs/{pub_pk}/prices/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`pub_pk` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pubs prices > list -p pub_pk=... -p page=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pubs", "prices > list"]
var params = {
    pub_pk: ...,
    page: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pubs", "prices > list"]
params = {
    "pub_pk": ...,
    "page": ...,
}
result = client.action(schema, action, params=params)

prices > create

POST /api/pubs/{pub_pk}/prices/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`pub_pk` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`price` required	Price
`starRating`	Star rating (i.e. quality of pint)

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pubs prices > create -p pub_pk=... -p price=... -p starRating=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pubs", "prices > create"]
var params = {
    pub_pk: ...,
    price: ...,
    starRating: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pubs", "prices > create"]
params = {
    "pub_pk": ...,
    "price": ...,
    "starRating": ...,
}
result = client.action(schema, action, params=params)

prices > read

GET /api/pubs/{pub_pk}/prices/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`pub_pk` required
`id` required

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action pubs prices > read -p pub_pk=... -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["pubs", "prices > read"]
var params = {
    pub_pk: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["pubs", "prices > read"]
params = {
    "pub_pk": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

rest-auth

facebook > create

POST /api/rest-auth/facebook/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`access_token`
`code`

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action rest-auth facebook > create -p access_token=... -p code=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["rest-auth", "facebook > create"]
var params = {
    access_token: ...,
    code: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["rest-auth", "facebook > create"]
params = {
    "access_token": ...,
    "code": ...,
}
result = client.action(schema, action, params=params)

facebook > connect > create

POST /api/rest-auth/facebook/connect/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`access_token`
`code`

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action rest-auth facebook > connect > create -p access_token=... -p code=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["rest-auth", "facebook > connect > create"]
var params = {
    access_token: ...,
    code: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["rest-auth", "facebook > connect > create"]
params = {
    "access_token": ...,
    "code": ...,
}
result = client.action(schema, action, params=params)

POST /api/rest-auth/login/

Check the credentials and return the REST Token if the credentials are valid and authenticated. Calls Django Auth login method to register User ID in Django session framework

Accept the following POST parameters: username, password Return the REST Framework Token Object's key.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username`
`email`
`password` required

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action rest-auth login > create -p username=... -p email=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["rest-auth", "login > create"]
var params = {
    username: ...,
    email: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["rest-auth", "login > create"]
params = {
    "username": ...,
    "email": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

statistics

list

GET /api/statistics/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action statistics list -p page=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["statistics", "list"]
var params = {
    page: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["statistics", "list"]
params = {
    "page": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/statistics/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this statistics singleton.

# Load the schema document
$ coreapi get https://guindex.ie/api/docs/

# Interact with the API endpoint
$ coreapi action statistics read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["statistics", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://guindex.ie/api/docs/")

# Interact with the API endpoint
action = ["statistics", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)