Valantines Day API

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

# Install the Python client library
$ pip install coreapi

accounts

list

GET /accounts/

- List out all the accounts - Account created by user registration so no create account 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://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action accounts 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 = ["accounts", "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://valantines-drf-8626efa242cc.herokuapp.com/")

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

read

GET /accounts/{id}/

- Detail the specificly requested account - Uses same Accounts serializer - Uses IsOwnerOrReadOnly tailored permission class to ensure only owner can update profile info

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action accounts 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 = ["accounts", "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://valantines-drf-8626efa242cc.herokuapp.com/")

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

update

PUT /accounts/{id}/

- Detail the specificly requested account - Uses same Accounts serializer - Uses IsOwnerOrReadOnly tailored permission class to ensure only owner can update profile info

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`account_name`
`image`

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action accounts update -p id=... -p account_name=... -p image=...

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 = ["accounts", "update"]
var params = {
    id: ...,
    account_name: ...,
    image: ...,
}
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://valantines-drf-8626efa242cc.herokuapp.com/")

# Interact with the API endpoint
action = ["accounts", "update"]
params = {
    "id": ...,
    "account_name": ...,
    "image": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /accounts/{id}/

- Detail the specificly requested account - Uses same Accounts serializer - Uses IsOwnerOrReadOnly tailored permission class to ensure only owner can update profile info

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`account_name`
`image`

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action accounts partial_update -p id=... -p account_name=... -p image=...

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 = ["accounts", "partial_update"]
var params = {
    id: ...,
    account_name: ...,
    image: ...,
}
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://valantines-drf-8626efa242cc.herokuapp.com/")

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

dj-rest-auth

POST /dj-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://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action dj-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 = ["dj-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://valantines-drf-8626efa242cc.herokuapp.com/")

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

logout > list

GET /dj-rest-auth/logout/

Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action dj-rest-auth logout list

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 = ["dj-rest-auth", "logout > list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://valantines-drf-8626efa242cc.herokuapp.com/")

# Interact with the API endpoint
action = ["dj-rest-auth", "logout > list"]
result = client.action(schema, action)

logout > create

POST /dj-rest-auth/logout/

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action dj-rest-auth logout create

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 = ["dj-rest-auth", "logout > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://valantines-drf-8626efa242cc.herokuapp.com/")

# Interact with the API endpoint
action = ["dj-rest-auth", "logout > create"]
result = client.action(schema, action)

logout > create_0

POST /dj-rest-auth/logout/

Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action dj-rest-auth logout create_0

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 = ["dj-rest-auth", "logout > create_0"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://valantines-drf-8626efa242cc.herokuapp.com/")

# Interact with the API endpoint
action = ["dj-rest-auth", "logout > create_0"]
result = client.action(schema, action)

password > change > create

POST /dj-rest-auth/password/change/

Calls Django Auth SetPasswordForm save method. Accepts the following POST parameters: new_password1, new_password2 Returns the success/fail message.

Request Body

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

Parameter	Description
`new_password1` required
`new_password2` required

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action dj-rest-auth password change create -p new_password1=... -p new_password2=...

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 = ["dj-rest-auth", "password > change > create"]
var params = {
    new_password1: ...,
    new_password2: ...,
}
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://valantines-drf-8626efa242cc.herokuapp.com/")

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

password > reset > create

POST /dj-rest-auth/password/reset/

Calls Django Auth PasswordResetForm save method. Accepts the following POST parameters: email Returns the success/fail message.

Request Body

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

Parameter	Description
`email` required

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action dj-rest-auth password reset create -p email=...

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 = ["dj-rest-auth", "password > reset > create"]
var params = {
    email: ...,
}
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://valantines-drf-8626efa242cc.herokuapp.com/")

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

password > reset > confirm > create

POST /dj-rest-auth/password/reset/confirm/

Password reset e-mail link is confirmed, therefore this resets the user's password. Accepts the following POST parameters: token, uid, new_password1, new_password2 Returns the success/fail message.

Request Body

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

Parameter	Description
`new_password1` required
`new_password2` required
`uid` required
`token` required

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action dj-rest-auth password reset confirm create -p new_password1=... -p new_password2=... -p uid=... -p token=...

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 = ["dj-rest-auth", "password > reset > confirm > create"]
var params = {
    new_password1: ...,
    new_password2: ...,
    uid: ...,
    token: ...,
}
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://valantines-drf-8626efa242cc.herokuapp.com/")

# Interact with the API endpoint
action = ["dj-rest-auth", "password > reset > confirm > create"]
params = {
    "new_password1": ...,
    "new_password2": ...,
    "uid": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

registration > create

POST /dj-rest-auth/registration/

Request Body

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

Parameter	Description
`username` required
`email`
`password1` required
`password2` required

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action dj-rest-auth registration create -p username=... -p email=... -p password1=... -p password2=...

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 = ["dj-rest-auth", "registration > create"]
var params = {
    username: ...,
    email: ...,
    password1: ...,
    password2: ...,
}
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://valantines-drf-8626efa242cc.herokuapp.com/")

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

registration > verify-email > create

POST /dj-rest-auth/registration/verify-email/

Request Body

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

Parameter	Description
`key` required

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action dj-rest-auth registration verify-email create -p key=...

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 = ["dj-rest-auth", "registration > verify-email > create"]
var params = {
    key: ...,
}
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://valantines-drf-8626efa242cc.herokuapp.com/")

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

token > refresh > create

POST /dj-rest-auth/token/refresh/

Request Body

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

Parameter	Description
`refresh`	WIll override cookie.

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action dj-rest-auth token refresh create -p refresh=...

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 = ["dj-rest-auth", "token > refresh > create"]
var params = {
    refresh: ...,
}
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://valantines-drf-8626efa242cc.herokuapp.com/")

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

token > verify > create

POST /dj-rest-auth/token/verify/

Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use.

Request Body

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

Parameter	Description
`token` required

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action dj-rest-auth token verify create -p token=...

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 = ["dj-rest-auth", "token > verify > create"]
var params = {
    token: ...,
}
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://valantines-drf-8626efa242cc.herokuapp.com/")

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

user > read

GET /dj-rest-auth/user/

Reads and updates UserModel fields Accepts GET, PUT, PATCH methods. Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email Returns UserModel fields.

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action dj-rest-auth user read

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 = ["dj-rest-auth", "user > read"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://valantines-drf-8626efa242cc.herokuapp.com/")

# Interact with the API endpoint
action = ["dj-rest-auth", "user > read"]
result = client.action(schema, action)

user > update

PUT /dj-rest-auth/user/

Request Body

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

Parameter	Description
`username` required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
`first_name`
`last_name`

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action dj-rest-auth user update -p username=... -p first_name=... -p last_name=...

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 = ["dj-rest-auth", "user > update"]
var params = {
    username: ...,
    first_name: ...,
    last_name: ...,
}
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://valantines-drf-8626efa242cc.herokuapp.com/")

# Interact with the API endpoint
action = ["dj-rest-auth", "user > update"]
params = {
    "username": ...,
    "first_name": ...,
    "last_name": ...,
}
result = client.action(schema, action, params=params)

user > partial_update

PATCH /dj-rest-auth/user/

Request Body

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

Parameter	Description
`username`	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
`first_name`
`last_name`

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action dj-rest-auth user partial_update -p username=... -p first_name=... -p last_name=...

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 = ["dj-rest-auth", "user > partial_update"]
var params = {
    username: ...,
    first_name: ...,
    last_name: ...,
}
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://valantines-drf-8626efa242cc.herokuapp.com/")

# Interact with the API endpoint
action = ["dj-rest-auth", "user > partial_update"]
params = {
    "username": ...,
    "first_name": ...,
    "last_name": ...,
}
result = client.action(schema, action, params=params)

partnerprofile

list

GET /partnerprofile/

- List out all the accounts - Account created by user registration so no create account 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://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action partnerprofile 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 = ["partnerprofile", "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://valantines-drf-8626efa242cc.herokuapp.com/")

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

create

POST /partnerprofile/

- List out all the accounts - Account created by user registration so no create account required

Request Body

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

Parameter	Description
`age`
`zodiac_sign`
`relationship`
`characteristics`
`interests`
`location`

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action partnerprofile create -p age=... -p zodiac_sign=... -p relationship=... -p characteristics=... -p interests=... -p location=...

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 = ["partnerprofile", "create"]
var params = {
    age: ...,
    zodiac_sign: ...,
    relationship: ...,
    characteristics: ...,
    interests: ...,
    location: ...,
}
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://valantines-drf-8626efa242cc.herokuapp.com/")

# Interact with the API endpoint
action = ["partnerprofile", "create"]
params = {
    "age": ...,
    "zodiac_sign": ...,
    "relationship": ...,
    "characteristics": ...,
    "interests": ...,
    "location": ...,
}
result = client.action(schema, action, params=params)

read

GET /partnerprofile/{id}/

- Detail the specificly requested account - Uses same Accounts serializer - Uses IsOwnerOrReadOnly tailored permission class to ensure only owner can update profile info

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action partnerprofile 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 = ["partnerprofile", "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://valantines-drf-8626efa242cc.herokuapp.com/")

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

update

PUT /partnerprofile/{id}/

- Detail the specificly requested account - Uses same Accounts serializer - Uses IsOwnerOrReadOnly tailored permission class to ensure only owner can update profile info

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`age`
`zodiac_sign`
`relationship`
`characteristics`
`interests`
`location`

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action partnerprofile update -p id=... -p age=... -p zodiac_sign=... -p relationship=... -p characteristics=... -p interests=... -p location=...

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 = ["partnerprofile", "update"]
var params = {
    id: ...,
    age: ...,
    zodiac_sign: ...,
    relationship: ...,
    characteristics: ...,
    interests: ...,
    location: ...,
}
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://valantines-drf-8626efa242cc.herokuapp.com/")

# Interact with the API endpoint
action = ["partnerprofile", "update"]
params = {
    "id": ...,
    "age": ...,
    "zodiac_sign": ...,
    "relationship": ...,
    "characteristics": ...,
    "interests": ...,
    "location": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /partnerprofile/{id}/

- Detail the specificly requested account - Uses same Accounts serializer - Uses IsOwnerOrReadOnly tailored permission class to ensure only owner can update profile info

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`age`
`zodiac_sign`
`relationship`
`characteristics`
`interests`
`location`

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action partnerprofile partial_update -p id=... -p age=... -p zodiac_sign=... -p relationship=... -p characteristics=... -p interests=... -p location=...

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 = ["partnerprofile", "partial_update"]
var params = {
    id: ...,
    age: ...,
    zodiac_sign: ...,
    relationship: ...,
    characteristics: ...,
    interests: ...,
    location: ...,
}
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://valantines-drf-8626efa242cc.herokuapp.com/")

# Interact with the API endpoint
action = ["partnerprofile", "partial_update"]
params = {
    "id": ...,
    "age": ...,
    "zodiac_sign": ...,
    "relationship": ...,
    "characteristics": ...,
    "interests": ...,
    "location": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /partnerprofile/{id}/

- Detail the specificly requested account - Uses same Accounts serializer - Uses IsOwnerOrReadOnly tailored permission class to ensure only owner can update profile info

Path Parameters

The following parameters should be included in the URL path.

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

# Load the schema document
$ coreapi get https://valantines-drf-8626efa242cc.herokuapp.com/

# Interact with the API endpoint
$ coreapi action partnerprofile delete -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 = ["partnerprofile", "delete"]
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://valantines-drf-8626efa242cc.herokuapp.com/")

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