RegRep

From DE4A
Revision as of 10:13, 1 March 2023 by Javier.ferrero (talk | contribs) (Initial version)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

RegRep is a data format standard by OASIS. It adds another layer of abstraction onto XML schema and splits the data into so called “slots”.

The usage of RegRep is very limited to inside the DE4A Connector. Before the main DEA message is send it is wrapped into a thin RegRep wrapper.

RegRep Evidence Request

The RegRep Evidence Request consists of the following slots:

  • SpecificationIdentifier (of type String) – Defines the underlying specification that is implemented. Must contain the value de4a-iem-v2.
  • IssueDateTime (of type DateTime) – Defines the date and time when request was created.
  • DE4AQuery (of type Any) – Contains the main DE4A data model.

The following example code shows a complete DE4A RegRep query.

<query:QueryRequest xmlns:lcm="urn:oasis:names:tc:ebxml-regrep:xsd:lcm:4.0" xmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:4.0" xmlns:spi="urn:oasis:names:tc:ebxml-regrep:xsd:spi:4.0" xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:4.0" xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0" id="fa62b109-b564-4985-a322-afb92e82d906">
  <rim:Slot name="SpecificationIdentifier">
   <rim:SlotValue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="rim:StringValueType">
     <rim:Value>de4a-iem-v2</rim:Value>
   </rim:SlotValue>
  </rim:Slot>
  <rim:Slot name="IssueDateTime">
   <rim:SlotValue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="rim:DateTimeValueType">
    <rim:Value>2023-01-28T20:10:49.827+01:00</rim:Value>
   </rim:SlotValue>
  </rim:Slot>
  <query:ResponseOption returnType="LeafClassWithRepositoryItem" />
  <query:Query queryDefinition="DE4AQueryIt2">
   <rim:Slot name="DE4AQuery">
     <rim:SlotValue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="rim:AnyValueType">
       <!-- main DE4A request here -->
     </rim:SlotValue>
   </rim:Slot>
  </query:Query>
</query:QueryRequest>

RegRep Evidence Response

The RegRep Evidence Response consists of the following slots:

  • SpecificationIdentifier (of type String) – Defines the underlying specification that is implemented. Must contain the value de4a-iem-v2.
  • IssueDateTime (of type DateTime) – Defines the date and time when request was created.
  • DE4AResponse (of type Any) – Contains the main DE4A data model.

The following example code shows a complete DE4A RegRep query response.

<query:QueryResponse xmlns:lcm="urn:oasis:names:tc:ebxml-regrep:xsd:lcm:4.0" xmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:4.0" xmlns:spi="urn:oasis:names:tc:ebxml-regrep:xsd:spi:4.0" xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:4.0" xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0" status="urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Success" requestId="reqid">
  <rim:Slot name="SpecificationIdentifier">
    <rim:SlotValue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="rim:StringValueType">
      <rim:Value>de4a-iem-v2</rim:Value>
    </rim:SlotValue>
  </rim:Slot>
  <rim:Slot name="IssueDateTime">
    <rim:SlotValue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="rim:DateTimeValueType">
      <rim:Value>2023-01-28T20:18:46.598+01:00</rim:Value>
    </rim:SlotValue>
  </rim:Slot>
  <rim:RegistryObjectList>
    <rim:RegistryObject id="910a4e63-a08d-4d8b-b736-e94e9098b1fd">
      <rim:Slot name="DE4AResponse">
        <rim:SlotValue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="rim:AnyValueType">
          <!-- main DE4A response here -->
        </rim:SlotValue>
      </rim:Slot>
    </rim:RegistryObject>
  </rim:RegistryObjectList>
</query:QueryResponse>