Party

Extends

Entity

Generic Party structure used to define commonalities between sub concepts of Individual and Organization.

Field Required Nullable Type Description Constraints Example

@type

Yes

No

String

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

default null;

@baseType

No

No

String

When sub-classing, this defines the super-class

default null;

@schemaLocation

No

No

String

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

default null;

id

No

No

String

Unique identifier

default null;

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

href

No

No

URI

Hyperlink reference

default null;

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

contactMedium

No

No

array of ContactMedium

List of means for contacting the party, e.g. mobile phone, email address

default null;

[]

externalReference

No

No

array of ExternalIdentifier

List of identifiers of the Party in an external system, for example when party information is imported from a commerce system

default null;

[]

businessId

No

No

String

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

default null;

1234

partyCharacteristic

No

No

array of Characteristic

List of additional characteristics that a Party can take on.

default null;

[]