Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Abbreviation #10

Closed
kaiqu opened this issue Jan 20, 2017 · 10 comments
Closed

Abbreviation #10

kaiqu opened this issue Jan 20, 2017 · 10 comments

Comments

@kaiqu
Copy link

kaiqu commented Jan 20, 2017

@wrygiel :
We concluded here that you would add abbreviation to the Institutions and possibly the OUnits API, but it's not there yet. Just a reminder - my apologies if you remember, but just haven't got around to it yet :-)

@wrygiel
Copy link
Collaborator

wrygiel commented Jan 20, 2017

No, I forgot about it.

I think we need to clearly specify the scope of this abbreviation. Otherwise I fear we will get some junk data there. For example, should we say that "this abbreviation should be unique within a country"? I don't think we may require it to be "unique on the world's scale", but the country seems reasonable. Clients would then display this abbreviation with a country-code prefix to get a somewhat world-unique value.

What do you think?

@kaiqu
Copy link
Author

kaiqu commented Jan 23, 2017

For example, should we say that "this abbreviation should be unique within a country"? I don't think we may require it to be "unique on the world's scale", but the country seems reasonable. Clients would then display this abbreviation with a country-code prefix to get a somewhat world-unique value.

I would agree for the Institutions API, but on second thought, I believe "other-id" can serve this purpose here? In that case, this leaves the OUnits API - with only a "HEI-wide" uniqueness.

@wrygiel
Copy link
Collaborator

wrygiel commented Jan 23, 2017

I feel that "other-id" should be used for unique identifiers (assigned by an external party), while this abbreviation seems to be a code/label (assigned by the HEI itself). This label may "struggle" to be unique, but often won't be.

@wrygiel
Copy link
Collaborator

wrygiel commented Jan 23, 2017

Of course, if you have unique abbreviations in Norway (assigned centrally, with no possible conflicts), then you could use "other-id" for that (e.g. with a type of "norwegian-abbreviation-code"). Perhaps this is what you really want to achieve?

@wrygiel
Copy link
Collaborator

wrygiel commented Jan 23, 2017

you could use "other-id" for that (e.g. with a type of "norwegian-abbreviation-code")

But then nobody would display those in their client software. So there's not much point in this solution, I think.

@kaiqu
Copy link
Author

kaiqu commented Jan 23, 2017

you could use "other-id" for that (e.g. with a type of "norwegian-abbreviation-code")

But then nobody would display those in their client software. So there's not much point in this solution, I think.

Ah - if "other-id" isn't supposed to be displayed, there is no point, I agree.

So, the "abbreviation" suggestion remains for both APIs, with the following (attempted) uniqueness:

  • Institutions API: Country-wide
  • OUnits API: HEI-wide

@wrygiel
Copy link
Collaborator

wrygiel commented Jan 23, 2017

Ah - if "other-id" isn't supposed to be displayed, there is no point, I agree.

Depends on the implementer, but I would display only the "known" other-id types, the ones my users would find useful (as opposed to displaying all of them).

So, the "abbreviation" suggestion remains for both APIs, with the following (attempted) uniqueness

Ok!

@wrygiel
Copy link
Collaborator

wrygiel commented Jan 23, 2017

One more thing - should we allow HEI (or unit) to specify more than one abbreviation?

wrygiel added a commit that referenced this issue Jan 23, 2017
wrygiel added a commit to erasmus-without-paper/ewp-specs-api-ounits that referenced this issue Jan 23, 2017
@wrygiel
Copy link
Collaborator

wrygiel commented Jan 23, 2017

should we allow HEI (or unit) to specify more than one abbreviation?

I assumed that one abbreviation is enough. If multiple abbreviations exist, then one of them should be selected.

@wrygiel wrygiel closed this as completed Jan 23, 2017
@kaiqu
Copy link
Author

kaiqu commented Jan 23, 2017

I assumed that one abbreviation is enough. If multiple abbreviations exist, then one of them should be selected.

I agree.

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

No branches or pull requests

2 participants