PartyRole

Extends: Entity

The part played by a party in a given context.

Field Required Nullable Type Description Constraints Example

Field	Required	Nullable	Type	Description	Example
`@type`	Yes	No	`String`	When sub-classing, this defines the sub-class Extensible name
`@baseType`	No	No	`String`	When sub-classing, this defines the super-class
`@schemaLocation`	No	No	`String`	A URI to a JSON-Schema file that defines additional attributes and relationships
`id`	No	No	`String`	Unique identifier	2d7ed5fd-9f62-4211-bc84-357f5f7b80f5
`href`	No	No	`URI`	Hyperlink reference	https://api.example.org/resource/id
`businessId`	No	No	`String`	A business relevant identifier when different from the technical identifier documented with the .id property	1234
`name`	Yes	No	`String`	A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles. It’s the name of the PartyRole unique entity.	PartyRoleName
`description`	No	No	`String`	A description of the PartyRole.	Lorem ipsum dolor
`role`	No	No	`String`	Role played by the engagedParty in this context. As role is defined by partyRoleSpecification, this role attribute can be used to precise the role defined by partyRoleSpecification, or it can be used to define the role in case there is no partyRoleSpecification.
`engagedParty`	Yes	No	PartyRef
`characteristic`	No	No	`array` of Characteristic	Describes the characteristic of a party role.	[]
`account`	No	No	`array` of AccountRef	Account	[]
`agreement`	No	No	`array` of AgreementRef	Agreement	[]
`contactMedium`	No	No	`array` of ContactMedium	Contact medium	[]
`relatedParty`	No	No	`array` of RelatedPartyOrPartyRole	Related party	[]
`status`	No	No	`String`	Used to track the lifecycle status of the party role.
`statusReason`	No	No	`String`	A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection.
`validFor`	No	No	TimePeriod

@type

Yes

String

When sub-classing, this defines the sub-class Extensible name

@baseType

String

When sub-classing, this defines the super-class

@schemaLocation

String

A URI to a JSON-Schema file that defines additional attributes and relationships

id

String

Unique identifier

2d7ed5fd-9f62-4211-bc84-357f5f7b80f5

href

URI

Hyperlink reference

https://api.example.org/resource/id

businessId

String

A business relevant identifier when different from the technical identifier documented with the .id property

1234

name

Yes

String

A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles. It’s the name of the PartyRole unique entity.

PartyRoleName

description

String

A description of the PartyRole.

Lorem ipsum dolor

role

String

Role played by the engagedParty in this context. As role is defined by partyRoleSpecification, this role attribute can be used to precise the role defined by partyRoleSpecification, or it can be used to define the role in case there is no partyRoleSpecification.

engagedParty

Yes

PartyRef

characteristic

array of Characteristic

Describes the characteristic of a party role.

[]

account

array of AccountRef

Account

[]

agreement

array of AgreementRef

Agreement

[]

contactMedium

array of ContactMedium

Contact medium

[]

relatedParty

array of RelatedPartyOrPartyRole

Related party

[]

status

String

Used to track the lifecycle status of the party role.

statusReason

String

A string providing an explanation on the value of the status lifecycle. For instance if the status is Rejected, statusReason will provide the reason for rejection.

validFor

TimePeriod