IATA-Cargo / ONE-Record

This repository contains the documentation & specs for the ONE Record standard.
https://onerecord.iata.org
MIT License
102 stars 51 forks source link

[Ontology] changeRequest: phoneNumber & eMail for person #169

Closed LauraWeissgerber closed 1 year ago

LauraWeissgerber commented 1 year ago

Currently I am not sure where to put phoneNumber and eMail for a person. As a workaround I can use otherIdentifier in companyBranch: BookingOptionRequest - shipment - company - companyBranch - otherIdentifierer

Example / Use case: For temperature sensitive goods we need contact information (phone, email). In my opinion these information would belong to "person".

Option 1: Link from "person" to "otherIdentifier" BookingOptionRequest - shipment - company - companyBranch - person - otherIdentifierer otherIdentifierType: eMail identifier: max.mustermann@email.com

Option 2: Add new fields "eMail" & "phone" to "person"

What do you think about this? How could you in the current specification set eMail and phone of a person (example: contact for temperature sensitive goods)?

mskopp commented 1 year ago

I agree, contact info belongs to a person: phone, fax, email is handled via Person#contact array and contactType. So Option 2 is already there.

E.g.

      {
        "@type" : [ "https://onerecord.iata.org/Person" ],
        "https://onerecord.iata.org/Person#contact" : [ {
          "@type" : [ "https://onerecord.iata.org/Contact" ],
          "https://onerecord.iata.org/Contact#contactType" : "Phone number",
          "https://onerecord.iata.org/Contact#contactValue" : "862123454321"
        } ],
        "https://onerecord.iata.org/Person#lastName" : "PAUL PERSON"
      }

See also https://onerecord.riege.com which also contains a demo XFWB with a phone number for PAUL PERSON. Valid contactType are described in the ontology, you may also consider to check out #92 or https://github.com/riege/one-record-ontologymodel/blob/main/src/main/java/org/iata/cargo/codelists/ContactTypeCode.java (which is Java source code but still might help).

LauraWeissgerber commented 1 year ago

In the ontology "contactType" has range { "Customer contact" , "Customs contact" , "Emergency contact" , "Other" }. https://onerecord.iata.org/cargo#Person#contactType

So I thought "phone numver" is not possible. So we should extend the range of "contactType" with "phone" and "eMail"?

mskopp commented 1 year ago
Contact#contactType
lambertciata commented 1 year ago

Hi, In fact there is Person#contactType which is supposed to be within { "Customer contact" , "Customs contact" , "Emergency contact" , "Other" } range And there is Contact#contactType which is supposed to be within the range displayed above.

To avoid misunderstanding the Person#contactType could be renamed.

LauraWeissgerber commented 1 year ago

Sorry, now I got it. It's okay like that :)