POST to rel

WARNING

This API is frozen and deprecated. Please use the fluent API from 0.9.4 on

Follows a resource's link by way of its rel and sends a POST request with data.

Signature

The method signature for POST to rel is:

post_to_rel(resource,
            rel: string,
            data: JSON,
            parameters: dict[str, Any] | None = None,
            template: dict[str, Any] | None = None,
            headers: dict[str, Any] | None = None
            ) -> JSON

JSON: TypeAlias = dict[str, "JSON"] | list["JSON"] | str | int | float | bool | None

postToRel({resource, rel, parameters = {}, template = {}}: RelSpec, data: {}, headers = {}): Promise<any>

With JavaScript, the first four parameters are actually members of one parameter of type RelSpec, with each being a member of that object.

parameter	description
resource	The body of a response from a previous request, in HAL format
rel	The name of the link relation this POST request will follow. If not supplied, the default is self
data	The payload to POST
parameters	(optional) name/value pairs which will be used to create a query string. learn more
template	(optional) if the link is templated, name/value pairs to fill the template. learn more
headers	(optional) add to or override the default headers. learn more
-> returns	the JSON from the payload of the response to this request

Examples

from halchemy import Api

api = Api('http://example.org/api')

root = api.get()  # get the root resource

customer = {
    'customerId': '789',
    'givenName': 'Kelly',
    'familyName': 'Johnson'
}

order = {
    'orderNumber': 'PO3984',
    'partNumber': '0009-043',
    'quantity': 3
}

# create a new customer and post their first order:
customer = api.post_to_rel(root, 'customers', customer)
order = api.post_to_rel(customer, 'orders', order)

const {Api} = require('halchemy')

async function placeNewCustomerOrder(customer, order) {
    const api = new Api('http://example.org/api')

    const root = await api.get()  // get the root resource

    const newCustomer = await api.postToRel({
            resource: root,
            rel: 'customers'
        }, customer)

    const newOrder = await api.postToRel({
        resource: newCustomer,
        rel: 'orders'
    }, order)
}


const customer = {
    'customerId': '789',
    'givenName': 'Kelly',
    'familyName': 'Johnson'
}

const order = {
    'orderNumber': 'PO3984',
    'partNumber': '0009-043',
    'quantity': 3
}

placeNewCustomerOrder(customer, order)