| 1 Definition | 2 Protocol | 3 Syntax | 4 Semantics |
1 Definition
The Action of a User requesting a Locate Service to
- Place an Item at an M-Location with a Spatial Attitude.
- Grant Rights to the MM-Added Item based on requested Rights.
If the request is accepted, the Locate Service places the Item at the requested M-Location providing Rights (Status=Final) to the requesting User.
2 Protocol
- User sends “MM-Add PA Request including Item, Point of View, Location, and Rights (Status=Model)” to MM-Add Service.
- If MM-Add Service is a free service, goto MM-Add.
- If MM-Add Service is a pay service:
- User sends “MM-Add PA Request with Service Pricing Model (Status=Model)” to MM-Add Service.
- MM-Add Service sends “MM-Add PA Response”:
- If “MM-Add PA Response includes Status=Err”, goto End
- If “MM-Add PA Response includes Status=Ack and Service Pricing Model with Transaction (both Status=Model)”, User:
- Transacts “Value included in Transaction”.
- Sends “MM-Add PA Request includes Service Pricing Model (Status=Model) with Transaction (both Status=Final)” to MM-Add Service.
- MM-Add: MM-Add Service
- MM-Adds Item.
- Sends “MM-Add PA Response” including
- “Rights (Status=Final)” to MM-Added Item.
- “Service Pricing Model (Status=Final)”, if MM-Add is pay.
- End.
The protocol described using Workflow Description Language (WDL) is available at this link:
https://schemas.mpai.community/MMM4/V2.2/wdl/MMAddPA.wdl
3 Syntax
The structure of the input and output messages, using JavaScript Object Notation (JSON) is available at this link:
https://schemas.mpai.community/MMM4/V2.2/actions/MMAddPA.json
4 Semantics
| Label | Description |
| Header | MM-Add Process Action Header – Standard “MMM-2DP-V” |
| MInstanceID | Identifier of M-Instance. |
| UEnvironmentID | Identifier of U-Environment. |
| MMAddPAID | Identifier of this PA Instance. |
| MMAddPATime | Creation time of this PA Instance. |
| MMAddPAData | Data included in this PA Instance. |
| – Time | Time of PA Request emission and execution or PA Response emission. |
| – RQ-Complements | Source Complements. |
| – Nil Item | Item to be MM-Added. |
| – At MLocationID | M-Location where the Item is to be MM-Added and may subsequently MM-Move. |
| – With SpatialAttitude | The Spatial Attitude of the Item to be MM-Added. |
| – With Perceptibility State | 0=Imperceptible, 1=Perceptible. |
| – With Rights | Requested Rights to the MM-Added Item. |
| – With SPM | Service Pricing Model, if Locate is a pay service. |
| – RS-Complements | Destination Complements. |
| – With Rights | Rights (Status=Final) based on requested Rights. |
| – With SPM | Service Pricing Model (Status=Final), if Locate is a pay service. |
| – With PAStatus | Possible Error Messages. |
| – Ack | If PA Request could be performed |
| – Err | If Error was found |
| – Clash | MM-Added Item clashes with an existing Item. |
| – FaultyPA | Faulty PA Request. |
| – IncID | Incorrect ID. |
| – MLocOOR | M-Location out of range. |
| – InsRights | Insufficient Rights. |
| – InsValue | Insufficient Value in Wallet. |
| DataXMData | Identity, provenance, authorised usage, source, type, governance context, security, legality, and annotation of exchanged data. |
| DescMetadata | Descriptive Metadata. |