partyroletmfwebservices API

basic

extended

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

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

string

@type
optional

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

string

description
optional

Detailed description of the account

string

href
optional

Reference of the account

string

id
optional

Unique identifier of the account

string

name
required

Name of the account

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

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

string

@type
optional

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

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the agreement

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

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

string

@type
optional

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

string

name
required

Name of the characteristic

string

value
required

The value of the characteristic

object

valueType
optional

Data type of the value of the characteristic

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

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

string

@type
optional

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

string

characteristic
required

Any additional characteristic(s) of this contact medium

MediumCharacteristic

mediumType
required

Type of the contact medium, such as: email address, telephone number, postal address

string

preferred
optional

If true, indicates that is the preferred contact medium

boolean

validFor
optional

The time period that the contact medium is valid for

TimePeriod

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

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

string

@type
optional

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

string

creditProfileDate
required

The date the profile was established

string(date-time)

creditRiskRating
optional

This is an integer whose value is used to rate the risk

integer(int32)

creditScore
optional

A measure of a person or organizations creditworthiness calculated on the basis of a combination of factors such as their income and credit history

integer(int32)

validFor
required

The period for which the profile is valid

TimePeriod

@baseType
optional

When sub-classing, this defines the super-class.

string

@schemaLocation
optional

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

string

@type
optional

When sub-classing, this defines the sub-class entity name.

string

code
required

Application relevant detail, defined in the API or a common list.

string

message
optional

More details and corrective actions related to the error which can be shown to a client user.

string

reason
required

Explanation of the reason for the error which can be shown to a client user.

string

referenceError
optional

URI of documentation describing the error.

string

status
optional

HTTP Error code extension

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

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

string

@type
optional

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

string

city
optional

The city

string

contactType
optional

The type of contact, for example: phone number such as mobile, fixed home, fixed office. postal address such as shipping instalation…

string

country
optional

The country

string

emailAddress
optional

Full email address in standard format

string

faxNumber
optional

The fax number of the contact

string

phoneNumber
optional

The primary phone number of the contact

string

postCode
optional

Postcode

string

socialNetworkId
optional

Identifier as a member of a social network

string

stateOrProvince
optional

State or province

string

street1
optional

Describes the street

string

street2
optional

Complementary street description

string

@baseType
optional

When sub-classing, this defines the super-class

string

@schemaLocation
optional

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

string

@type
optional

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

string

account
optional

< AccountRef > array

agreement
optional

< AgreementRef > array

characteristic
optional

Describes the characteristic of a party role.

< Characteristic > array

contactMedium
optional

< ContactMedium > array

creditProfile
optional

< CreditProfile > array

engagedParty
optional

RelatedParty

href
optional

Url used to reference the party role.

string

id
optional

Unique identifier for PartyRoles

string

name
optional

A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles.

string

paymentMethod
optional

< PaymentMethodRef > array

relatedParty
optional

< RelatedParty > array

status
optional

Used to track the lifecycle status of the party role.

string

statusReason
optional

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.

string

validFor
optional

The time period that the PartyRole is valid for.

TimePeriod

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
optional

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

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

string

@type
optional

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

string

href
optional

Reference of the payment mean

string

id
required

Unique identifier of the payment mean

string

name
optional

Name of the payment mean

string

@baseType
optional

When sub-classing, this defines the super-class

string

@referredType
required

The actual type of the target instance when needed for disambiguation.

string

@schemaLocation
optional

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

string

@type
optional

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

string

href
optional

Reference of the related entity.

string

id
required

Unique identifier of a related entity.

string

name
optional

Name of the related entity.

string

role
optional

Role played by the related party

string

endDateTime
optional

End of the time period, using IETC-RFC-3339 format

string(date-time)

startDateTime
optional

Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end

string(date-time)