Skip to content
This repository has been archived by the owner on Nov 7, 2023. It is now read-only.

Party object / displayedAddress field #12

Open
enriquesempe opened this issue Aug 2, 2022 · 6 comments
Open

Party object / displayedAddress field #12

enriquesempe opened this issue Aug 2, 2022 · 6 comments

Comments

@enriquesempe
Copy link

I would suggest adding a field like "displayedAddress" with a maxLength of 500 in the party object, to complete the whole description of the address rather than having only each independent field such as street, streetNumber, floor, etc

@pimg
Copy link
Contributor

pimg commented Aug 3, 2022

@enriquesempe I think that's a fair suggestion. Especially if it is in addition to the separate fields so the sender can decide what to send depending on the available information. This is indeed also inline in what has been discussed previously.

@pimg
Copy link
Contributor

pimg commented Aug 5, 2022

@enriquesempe below a proposal (I have not update the OAS yet) I added a displayedAddress to the address object all fields are optional. This way we do not loose the capability to send a structured address if needed.

A Max Length of 500 does seem quite large, do you have real life examples where such a large displayedAddress is needed?

{
    "eBLPlatformIdentifier": "[email protected]",
    "partyName": "Asseco Denmark",
    "taxReference1": "CVR-25645774",
    "taxReference2": "CVR-25645774",
    "publicKey": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkFzaW",
    "address": {
        "displayAddress": "Kronprincessegade 54, 5. sal, 1306 København Denmark",
        "name": "Henrik",
        "street": "Kronprincessegade",
        "streetNumber": "54",
        "floor": "5. sal",
        "postCode": "1306",
        "city": "København",
        "stateRegion": "N/A",
        "country": "Denmark"
    },
    "partyContactDetails": [
        {
            "name": "Henrik",
            "phone": "+45 33364660",
            "email": "[email protected]",
            "url": "https://www.dcsa.org"
        }
    ],
    "identifyingCodes": [
        {
            "DCSAResponsibleAgencyCode": "SMDG",
            "partyCode": "MSK",
            "codeListName": "LCL"
        }
    ]
}

@pimg
Copy link
Contributor

pimg commented Aug 5, 2022

We should consider making this an optional choice (OAS oneOf), otherwise what if the structured address and displayed address contain different information?

@enriquesempe
Copy link
Author

We should consider making this an optional choice (OAS oneOf), otherwise what if the structured address and displayed address contain different information?

Agree with considering this as an optional choice, it's up to the user/service provider to decide how they will be completing this information

@enriquesempe
Copy link
Author

@enriquesempe below a proposal (I have not update the OAS yet) I added a displayedAddress to the address object all fields are optional. This way we do not loose the capability to send a structured address if needed.

A Max Length of 500 does seem quite large, do you have real life examples where such a large displayedAddress is needed?

{
    "eBLPlatformIdentifier": "[email protected]",
    "partyName": "Asseco Denmark",
    "taxReference1": "CVR-25645774",
    "taxReference2": "CVR-25645774",
    "publicKey": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkFzaW",
    "address": {
        "displayAddress": "Kronprincessegade 54, 5. sal, 1306 København Denmark",
        "name": "Henrik",
        "street": "Kronprincessegade",
        "streetNumber": "54",
        "floor": "5. sal",
        "postCode": "1306",
        "city": "København",
        "stateRegion": "N/A",
        "country": "Denmark"
    },
    "partyContactDetails": [
        {
            "name": "Henrik",
            "phone": "+45 33364660",
            "email": "[email protected]",
            "url": "https://www.dcsa.org"
        }
    ],
    "identifyingCodes": [
        {
            "DCSAResponsibleAgencyCode": "SMDG",
            "partyCode": "MSK",
            "codeListName": "LCL"
        }
    ]
}

Ok with this proposal.

Regarding the Max Length of 500, it is true that it might seem quite large, we could consider 250 instead. On our side, the vast majority of the address are below 250 characters. Those out of this group might be because in some situations they might be adding some other information on this field such as telephone numbers, tax id numbers, etc..., which is not correct.

@enriquesempe enriquesempe changed the title Party object / address field Party object / displayedAddress field Aug 8, 2022
@pimg
Copy link
Contributor

pimg commented Aug 9, 2022

Would suggest making it 255 (default varchar length for many of the databases available)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants