<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40"><head><meta http-equiv=Content-Type content="text/html; charset=utf-8"><meta name=Generator content="Microsoft Word 15 (filtered medium)"><style><!--
/* Font Definitions */
@font-face
{font-family:Wingdings;
panose-1:5 0 0 0 0 0 0 0 0 0;}
@font-face
{font-family:"Cambria Math";
panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
{font-family:Aptos;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0cm;
font-size:12.0pt;
font-family:"Aptos",sans-serif;}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:blue;
text-decoration:underline;}
p.MsoListParagraph, li.MsoListParagraph, div.MsoListParagraph
{mso-style-priority:34;
margin-top:0cm;
margin-right:0cm;
margin-bottom:0cm;
margin-left:36.0pt;
font-size:12.0pt;
font-family:"Aptos",sans-serif;}
span.EmailStyle18
{mso-style-type:personal-compose;
font-family:"Times New Roman",serif;}
.MsoChpDefault
{mso-style-type:export-only;
font-size:10.0pt;
mso-ligatures:none;}
@page WordSection1
{size:612.0pt 792.0pt;
margin:72.0pt 72.0pt 72.0pt 72.0pt;}
div.WordSection1
{page:WordSection1;}
/* List Definitions */
@list l0
{mso-list-id:443429264;
mso-list-type:hybrid;
mso-list-template-ids:1311151936 2103083510 134807555 134807557 134807553 134807555 134807557 134807553 134807555 134807557;}
@list l0:level1
{mso-level-start-at:0;
mso-level-number-format:bullet;
mso-level-text:-;
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;
font-family:"Aptos",sans-serif;
mso-fareast-font-family:"Times New Roman";
mso-bidi-font-family:Aptos;}
@list l0:level2
{mso-level-number-format:bullet;
mso-level-text:o;
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;
font-family:"Courier New";}
@list l0:level3
{mso-level-number-format:bullet;
mso-level-text:;
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;
font-family:Wingdings;}
@list l0:level4
{mso-level-number-format:bullet;
mso-level-text:;
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;
font-family:Symbol;}
@list l0:level5
{mso-level-number-format:bullet;
mso-level-text:o;
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;
font-family:"Courier New";}
@list l0:level6
{mso-level-number-format:bullet;
mso-level-text:;
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;
font-family:Wingdings;}
@list l0:level7
{mso-level-number-format:bullet;
mso-level-text:;
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;
font-family:Symbol;}
@list l0:level8
{mso-level-number-format:bullet;
mso-level-text:o;
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;
font-family:"Courier New";}
@list l0:level9
{mso-level-number-format:bullet;
mso-level-text:;
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;
font-family:Wingdings;}
@list l1
{mso-list-id:508956956;
mso-list-type:hybrid;
mso-list-template-ids:-614047642 134807569 134807577 134807579 134807567 134807577 134807579 134807567 134807577 134807579;}
@list l1:level1
{mso-level-text:"%1\)";
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l1:level2
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l1:level3
{mso-level-number-format:roman-lower;
mso-level-tab-stop:none;
mso-level-number-position:right;
text-indent:-9.0pt;}
@list l1:level4
{mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l1:level5
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l1:level6
{mso-level-number-format:roman-lower;
mso-level-tab-stop:none;
mso-level-number-position:right;
text-indent:-9.0pt;}
@list l1:level7
{mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l1:level8
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l1:level9
{mso-level-number-format:roman-lower;
mso-level-tab-stop:none;
mso-level-number-position:right;
text-indent:-9.0pt;}
@list l2
{mso-list-id:1574503887;
mso-list-type:hybrid;
mso-list-template-ids:837732078 134807567 134807577 134807579 134807567 134807577 134807579 134807567 134807577 134807579;}
@list l2:level1
{mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l2:level2
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l2:level3
{mso-level-number-format:roman-lower;
mso-level-tab-stop:none;
mso-level-number-position:right;
text-indent:-9.0pt;}
@list l2:level4
{mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l2:level5
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l2:level6
{mso-level-number-format:roman-lower;
mso-level-tab-stop:none;
mso-level-number-position:right;
text-indent:-9.0pt;}
@list l2:level7
{mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l2:level8
{mso-level-number-format:alpha-lower;
mso-level-tab-stop:none;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l2:level9
{mso-level-number-format:roman-lower;
mso-level-tab-stop:none;
mso-level-number-position:right;
text-indent:-9.0pt;}
ol
{margin-bottom:0cm;}
ul
{margin-bottom:0cm;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]--></head><body lang=EN-GB link=blue vlink=purple style='word-wrap:break-word'><div class=WordSection1><div><p class=MsoNormal>As discussed, I looked at examples of REST API's and found (again) <a href="https://restfulapi.net/resource-naming/">https://restfulapi.net/resource-naming/</a><o:p></o:p></p></div><div><p class=MsoNormal style='background:white'><span style='color:#212121'><o:p> </o:p></span></p></div><div><p class=MsoNormal style='background:white'><span style='color:#212121'>I think the API in the BB should be changed to be more consistent. <o:p></o:p></span></p><p class=MsoNormal style='background:white'><span style='color:#212121'>The article suggests:<o:p></o:p></span></p><ul style='margin-top:0cm' type=disc><li class=MsoListParagraph style='color:#212121;margin-left:0cm;mso-list:l0 level1 lfo3;background:white'>Use nouns to represent resources<o:p></o:p></li><li class=MsoListParagraph style='color:#212121;margin-left:0cm;mso-list:l0 level1 lfo3;background:white'>Use “/” to indicate hierarchy<o:p></o:p></li><li class=MsoListParagraph style='color:#212121;margin-left:0cm;mso-list:l0 level1 lfo3;background:white'>Use hyphens to improve readability<o:p></o:p></li><li class=MsoListParagraph style='color:#212121;margin-left:0cm;mso-list:l0 level1 lfo3;background:white'>Do not use underscores<o:p></o:p></li><li class=MsoListParagraph style='color:#212121;margin-left:0cm;mso-list:l0 level1 lfo3;background:white'>Use lower case letters in URI<o:p></o:p></li><li class=MsoListParagraph style='color:#212121;margin-left:0cm;mso-list:l0 level1 lfo3;background:white'>Never use CRUD function names in URI<o:p></o:p></li></ul><p class=MsoNormal style='background:white'><span style='color:#212121'><o:p> </o:p></span></p><p class=MsoNormal style='background:white'><span style='color:#212121'>Here are some ideas:<o:p></o:p></span></p></div><div><p class=MsoNormal style='background:white'><span style='color:#212121'><o:p> </o:p></span></p></div><div><ol style='margin-top:0cm' start=1 type=1><li class=MsoListParagraph style='color:#212121;margin-left:0cm;mso-list:l1 level1 lfo2;background:white'>rather than having the URI named "Get", the GET part is in the type of request, as it shows in the Swagger docs.<o:p></o:p></li></ol></div><div><ol style='margin-top:0cm' start=2 type=1><li class=MsoListParagraph style='color:#212121;margin-left:0cm;mso-list:l1 level1 lfo2;background:white'>the resources are<o:p></o:p></li></ol><ol style='margin-top:0cm' start=2 type=1><ol style='margin-top:0cm' start=1 type=a><li class=MsoListParagraph style='color:#212121;margin-left:0cm;mso-list:l1 level2 lfo2;background:white'>Sources such as archives or users etc<o:p></o:p></li><li class=MsoListParagraph style='color:#212121;margin-left:0cm;mso-list:l1 level2 lfo2;background:white'>Information which will be available packaged as general IP or AIP<o:p></o:p></li></ol></ol><p class=MsoListParagraph style='margin-left:108.0pt;text-indent:-108.0pt;mso-text-indent-alt:-9.0pt;mso-list:l1 level3 lfo2;background:white'><![if !supportLists]><span style='color:#212121'><span style='mso-list:Ignore'><span style='font:7.0pt "Times New Roman"'> </span>i.<span style='font:7.0pt "Times New Roman"'> </span></span></span><![endif]><span style='color:#212121'>With subtypes RepInfo and PDI elements<o:p></o:p></span></p><ol style='margin-top:0cm' start=2 type=1><ol style='margin-top:0cm' start=3 type=a><li class=MsoListParagraph style='color:#212121;margin-left:0cm;mso-list:l1 level2 lfo2;background:white'>Data objects<o:p></o:p></li></ol></ol></div><div><p class=MsoNormal style='background:white'><span style='color:#212121'><o:p> </o:p></span></p></div><div><p class=MsoNormal style='background:white'><span style='color:#212121'>So we should have something like<o:p></o:p></span></p></div><div><p class=MsoNormal style='background:white'><span style='color:#212121'><a href="http://www.oais.info:8085/oaisif/sb/sources">http://www.oais.info:8085/oaisif/sb/sources</a> to list switchboard entries<o:p></o:p></span></p></div><div><p class=MsoNormal style='background:white'><span style='color:#212121'><o:p> </o:p></span></p></div><div><p class=MsoNormal style='background:white'><span style='color:#212121'><a href="http://www.oais.info:8765/oaisif/ga/information">http://www.oais.info:8765/oaisif/ga/information</a> - to list information available<o:p></o:p></span></p><p class=MsoNormal style='background:white'><span style='color:#212121'><o:p> </o:p></span></p><p class=MsoNormal style='background:white'><span style='color:#212121'><a href="http://www.oais.info:8765/oaisif/ga/information?id=nnn">http://www.oais.info:8765/oaisif/ga/information?id=nnn</a> –a specific piece of info<o:p></o:p></span></p><p class=MsoNormal style='background:white'><span style='color:#212121'><o:p> </o:p></span></p><p class=MsoNormal style='background:white'><span style='color:#212121'><a href="http://www.oais.info:8765/oaisif/ga/information/pdi?id=nnn">http://www.oais.info:8765/oaisif/ga/information/pdi?id=nnn</a> –PDI of specific info<o:p></o:p></span></p><p class=MsoNormal style='background:white'><span style='color:#212121'><o:p> </o:p></span></p><p class=MsoNormal style='background:white'><span style='color:#212121'><a href="http://www.oais.info:8765/oaisif/ga/information/data?id=nnn">http://www.oais.info:8765/oaisif/ga/information/data?id=nnn</a> – data object of specific info<o:p></o:p></span></p><p class=MsoNormal style='background:white'><span style='color:#212121'><o:p> </o:p></span></p></div><div><p class=MsoNormal style='background:white'><span style='color:#212121'><a href="http://www.oais.info:8765/oaisif/ga/information/repinfo?id=nnn">http://www.oais.info:8765/oaisif/ga/information/repinfo?id=nnn</a> – repinfo object of specific info<o:p></o:p></span></p><p class=MsoNormal style='background:white'><span style='color:#212121'><o:p> </o:p></span></p><p class=MsoNormal style='background:white'><span style='color:#212121'><a href="http://www.oais.info:8083/oaisif/rr/information">http://www.oais.info:8083/oaisif/rr/information</a> – list all repinfo in the RRORI<o:p></o:p></span></p><p class=MsoNormal style='background:white'><span style='color:#212121'><o:p> </o:p></span></p></div><div><p class=MsoNormal style='background:white'><span style='color:#212121'>..David<o:p></o:p></span></p></div></div></body></html>