Skip to content

Offers

AFS Energy Portal uses offers to accept or reject provided prices.

Object Structure

PropertyTypeDescriptionNullable
idStringUUIDNo
priceFloatPrice per volumeNo
totalPriceFloatNotional priceNo
currencyCodeIntegerCurrency code, for example, EUR or GBPNo
createdAtStringDate and time. Atom format (Y-m-d\TH:i:sP )No
answeredAtStringDate and time. Atom format (Y-m-d\TH:i:sP )Yes
isAcceptedBooleanIt shows whether the offer was accepted or notNo
iriStringInternational Resource IdentifierNo

PATCH Accept the Offer

PATCH /api/offers/<id>/accept

This endpoint allows you to accept the Offer by id.

Parameters

PropertyTypeDescriptionNullable
idStringUUIDNo

Request header should contain Content-Type: application/merge-patch+json and Accept: application/json.

Request body

Empty

Responses

PropertyTypeDescriptionNullable
idStringUUIDNo

Example:

{
"id": "string",
"iri": "/api/offers/1eef674e-3698-6450-82fb-5922191c8aa1"
}

PATCH Reject the Offer

PATCH /api/offers/<id>/reject

This endpoint allows you to reject the Offer by id.

Parameters

PropertyTypeDescriptionNullable
idStringUUIDNo

Request header should contain Content-Type: application/merge-patch+json and Accept: application/json.

Request body

Empty

Responses

PropertyTypeDescriptionNullable
idStringUUIDNo

Example:

{
"id": "string",
"iri": "/api/offers/1eef674e-3698-6450-82fb-5922191c8aa1"
}