Party
The thing that interacts with and are authorized in the Flexibility Information System.
A party can have different types, e.g. system operator or end user.
Business Identifiers
Business identifiers for party originate outside of the system. The system itself will not generate or administer these identifiers. As an example, a service provider registration procedure will require the party to obtain a GLN from GS1 or an EIC-X from ENTSO-E prior to registration (probably via the Ediel Register).
We support both GLN and EIC-X as identifiers for parties, since they are both used and globally unique.
The exception to this rule is the End User party type, which is not required to have an external business identifier. End Users are modelled as parties to standardize/simplify the authorization logic. For those parties, the system will generate a UUID as the business identifier.
Relevant links
Fields
| Name | Description | Format | Reference |
|---|---|---|---|
| id | Unique surrogate identifier. | bigint Read only |
|
| business_id | The business identifier of the party. Format depends on business_id_type. |
text Non-updatable |
|
| business_id_type | The type of the business identifier. | text One of: gln, uuid, eic_x, orgDefault: uuidNon-updatable |
|
| entity_id | Reference to the entity that is the parent of the party. | bigint Required Non-updatable |
entity.id |
| name | Name of the party. Maximum 128 characters. | text Required |
|
| role | The role of the party. Currently maps to 1:1 to type. E.g. system_operator, service_provider. |
text One of: flex_balance_responsible_party, flex_end_user, flex_energy_supplier, flex_flexibility_information_system_operator, flex_market_operator, flex_organisation, flex_service_provider, flex_system_operator, flex_third_partyRequired Non-updatable |
|
| type | The type of the party, e.g SystemOperator, ServiceProvider | text One of: balance_responsible_party, end_user, energy_supplier, flexibility_information_system_operator, market_operator, organisation, service_provider, system_operator, third_partyRequired Non-updatable |
|
| status | The status of the party. | text One of: new, active, inactive, suspended, terminatedDefault: new |
|
| recorded_at | When the resource was recorded (created or updated) in the system. | date-time Read only |
|
| recorded_by | The identity that recorded the resource. | bigint Read only |
Validation Rules
| Policy key | Policy | Status |
|---|---|---|
| PTY-VAL001 | business_id_type is UUID if and only if the party is an end_user. |
DONE |
| PTY-VAL002 | business_id is not required if business_id_type is UUID (it will be generated). |
DONE |
| PTY-VAL003 | business_id_type is ORG if and only if the party is an organisation. |
DONE |
Notifications
No notifications.
Authorization
Resource Level Authorization
Below is the RLA for the resource. The default policy is deny.
Entity
| Policy key | Policy | Status |
|---|---|---|
| PTY-ENT001 | Read all PTY whose memberships they can read | DONE |
| PTY-ENT002 | Read all PTY that they own | DONE |
Anonymous
No policies.
Common
| Policy key | Policy | Status |
|---|---|---|
| PTY-COM001 | Read history on PTY that they can read. | DONE |
| PTY-COM002 | Read all PTY that are not end_user |
DONE |
| PTY-COM003 | Read all PTY whose memberships they can read | DONE |
Balance Responsible Party
No policies.
End User
No policies.
Energy Supplier
No policies.
Flexibility Information System Operator
| Policy key | Policy | Status |
|---|---|---|
| PTY-FISO001 | Create, read and update all PTY | DONE |
Organisation
No policies.
System Operator
No policies.
Service Provider
No policies.
Third Party
No policies.
Field Level Authorization
For party type abbreviations, check the authentication docs.
| FIELD | ANON | BRP | ES | EU | FISO | SO | SP | TP | ORG |
|---|---|---|---|---|---|---|---|---|---|
| id | R | R | R | R | R | R | R | R | |
| name | R | R | R | RCU | R | R | R | R | |
| business_id | R | R | R | RC | R | R | R | R | |
| business_id_type | R | R | R | RC | R | R | R | R | |
| entity_id | R | R | R | RC | R | R | R | R | |
| type | R | R | R | RC | R | R | R | R | |
| role | R | R | R | RC | R | R | R | R | |
| status | R | R | R | RCU | R | R | R | R | |
| recorded_at | R | R | R | R | R | R | R | R | |
| recorded_by | R | R | R | R | R | R | R | R |