NegotiationDetailDto

localIdstringrequired

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

remoteIdstringrequired

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa7

remotePartystringrequired

Example: Remote Party Name

rolestringrequired

Possible values: [provider, consumer]

Example: provider

remoteAddressstringrequired

Example: 192.168.1.100

statestringrequired

Possible values: [REQUESTED, OFFERED, ACCEPTED, AGREED, VERIFIED, FINALIZED, TERMINATED]

Example: REQUESTED

dataSetstringrequired

Example: defaultDataSet

modifiedDatestring<date-time>required

Example: 2023-10-11T00:00:00.000Z

offer object

@idstringrequired

Example: 3f2592da-ffc9-40cb-a336-a9daa9343ce8

@typestringrequired

Example: Offer

assignerstring

Example: did:example:assigner

assigneestring

Example: assigneeExample

profilestring

Example: profileExample

permission object[]

Array [

@typestringrequired

Example: Permission

assignerstring

Example: assignerExample

assigneestring

Example: assigneeExample

actionstringrequired

Example: actionExample

targetstring

Example: targetExample

constraint object[]

Array [

@typestringrequired

Example: Constraint

leftOperandstringrequired

Example: leftOperandExample

operatorstringrequired

Example: operatorExample

rightOperandobject

Example: {"value":"rightOperandExample"}

rightOperandReferencestring

Example: rightOperandReferenceExample

]

Dutystring[]

Example: []

]

prohibition object[]

Array [

@typestringrequired

Example: Prohibition

assignerstring

Example: assignerExample

assigneestring

Example: assigneeExample

actionstringrequired

Example: actionExample

targetstring

Example: targetExample

constraint object[]

Array [

@typestringrequired

Example: Constraint

leftOperandstringrequired

Example: leftOperandExample

operatorstringrequired

Example: operatorExample

rightOperandobject

Example: {"value":"rightOperandExample"}

rightOperandReferencestring

Example: rightOperandReferenceExample

]

]

obligation object[]

Array [

@typestringrequired

Example: Duty

assignerstring

Example: assignerExample

assigneestring

Example: assigneeExample

actionstringrequired

Example: actionExample

targetstring

Example: targetExample

constraint object[]

Array [

@typestringrequired

Example: Constraint

leftOperandstringrequired

Example: leftOperandExample

operatorstringrequired

Example: operatorExample

rightOperandobject

Example: {"value":"rightOperandExample"}

rightOperandReferencestring

Example: rightOperandReferenceExample

]

]

targetstring

Example: targetExample

agreement object

@idstringrequired

Example: 3f2592da-ffc9-40cb-a336-a9daa9343ce8

@typestringrequired

Example: Agreement

assignerstring

Example: did:example:assigner

assigneestring

Example: did:example:assignee

profilestring

Example: profileExample

permission object[]

Array [

@typestringrequired

Example: Permission

assignerstring

Example: assignerExample

assigneestring

Example: assigneeExample

actionstringrequired

Example: actionExample

targetstring

Example: targetExample

constraint object[]

Array [

@typestringrequired

Example: Constraint

leftOperandstringrequired

Example: leftOperandExample

operatorstringrequired

Example: operatorExample

rightOperandobject

Example: {"value":"rightOperandExample"}

rightOperandReferencestring

Example: rightOperandReferenceExample

]

Dutystring[]

Example: []

]

prohibition object[]

Array [

@typestringrequired

Example: Prohibition

assignerstring

Example: assignerExample

assigneestring

Example: assigneeExample

actionstringrequired

Example: actionExample

targetstring

Example: targetExample

constraint object[]

Array [

@typestringrequired

Example: Constraint

leftOperandstringrequired

Example: leftOperandExample

operatorstringrequired

Example: operatorExample

rightOperandobject

Example: {"value":"rightOperandExample"}

rightOperandReferencestring

Example: rightOperandReferenceExample

]

]

obligation object[]

Array [

@typestringrequired

Example: Duty

assignerstring

Example: assignerExample

assigneestring

Example: assigneeExample

actionstringrequired

Example: actionExample

targetstring

Example: targetExample

constraint object[]

Array [

@typestringrequired

Example: Constraint

leftOperandstringrequired

Example: leftOperandExample

operatorstringrequired

Example: operatorExample

rightOperandobject

Example: {"value":"rightOperandExample"}

rightOperandReferencestring

Example: rightOperandReferenceExample

]

]

targetstring

Example: urn:example:target

timestampstringrequired

Example: 2023-10-01T12:34:56Z

events object[]required

Array [

timestring<date-time>required

Example: 2023-10-11T00:00:00.000Z

statestringrequired

Possible values: [REQUESTED, OFFERED, ACCEPTED, AGREED, VERIFIED, FINALIZED, TERMINATED]

Example: REQUESTED

localMessagestring

Example: A local message example

codestring

Example: ERR_CODE

reason object[]

Array [

@valuestringrequired

Example: This is a sentence.

@languagestringrequired

Example: en

]

agreementMessagestring

Example: Agreement reached on event

verification object

@typestringrequired

Example: ContractAgreementVerificationMessage

consumerPidstringrequired

Example: urn:example:consumerPid

providerPidstringrequired

Example: urn:example:providerPid

hashedMessage object

digeststringrequired

Example: sha256:abcdef1234567890

algorithmstringrequired

Example: SHA-256

hashedMessage object

digeststringrequired

Example: sha256:abcdef1234567890

algorithmstringrequired

Example: SHA-256

typestringrequired

Possible values: [local, remote]

Example: local

]

NegotiationDetailDto

{
  "localId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "remoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa7",
  "remoteParty": "Remote Party Name",
  "role": "provider",
  "remoteAddress": "192.168.1.100",
  "state": "REQUESTED",
  "dataSet": "defaultDataSet",
  "modifiedDate": "2023-10-11T00:00:00.000Z",
  "offer": {},
  "agreement": {},
  "events": [
    {
      "time": "2023-10-11T00:00:00.000Z",
      "state": "REQUESTED",
      "localMessage": "A local message example",
      "code": "ERR_CODE",
      "reason": [],
      "agreementMessage": "Agreement reached on event",
      "verification": {},
      "hashedMessage": {},
      "type": "local"
    }
  ]
}