{"id":8333,"date":"2022-06-18T22:23:05","date_gmt":"2022-06-18T22:23:05","guid":{"rendered":"https:\/\/www.use-snip.com\/kb\/?post_type=ht_kb&p=8333"},"modified":"2022-06-21T20:43:03","modified_gmt":"2022-06-21T20:43:03","slug":"web-api-name-a-user-or-base","status":"publish","type":"ht_kb","link":"https:\/\/www.use-snip.com\/kb\/knowledge-base\/web-api-name-a-user-or-base\/","title":{"rendered":"Web API, Name a User or Base"},"content":{"rendered":"

Whenever a new ‘resource’ is created in SNIP<\/strong><\/span>, it is given a name.\u00a0 The name must follow certain rules and within a given ‘type’ of resource (such as User Accounts or Base Stations) the name must be unique.\u00a0 This article describes the Web API process when a new User or Base is being created.\u00a0 Aside<\/strong><\/span>: When using the SNIP<\/strong><\/span> console to enter a new name the feedback is presented immediately in the dialog box.<\/p>\n

The initial displayed web page allows the user to enter the proposed name, which is then checked for errors or conflicts before proceeding.\u00a0\u00a0 Once a suitable name has been entered, the page proceeds to the next step, registering either a new User Account<\/a> or a New Base Station Push-In reservation.<\/p>\n

The same page with minor textual changes is used for both new User Accounts<\/strong> and new Base Stations<\/strong>.<\/p>\n

\"\"<\/a><\/p>\n

Suitable names meet the following core rules:<\/h3>\n
    \n
  1. Names for both User and Bases can only be made up of the characters A~Z, a~z, the digits 0~9 and the “-” and “_” characters.\u00a0\u00a0 No spaces, no “non-ASCII codes”or diacritical marks, and in general try to select names that are fairly short.<\/li>\n
  2. The entry must be at least 3 characters long.<\/li>\n
  3. All names are always case sensitive<\/strong><\/span>.\u00a0 You can in fact have entries like both “base” and “Base” but it will most likely lead to confusion with your user community.<\/li>\n
  4. Unless you have enabled it in the Preferences dialog, a name may not start with a digit. The above line will be modified if this is enabled.<\/li>\n
  5. A few names (terms used in the NTRIP protocol itself such a “RTCM3”) are also prohibited from being used.<\/li>\n<\/ol>\n

    When you press Submit<\/strong>, the name is checked for these and other rules and then compared with other existing names on the Caster.\u00a0 If the name is acceptable, you proceed to the next step with a final registration page.<\/p>\n

    Recommendations vs Outright Errors<\/h3>\n

    If the name is not valid you cannot use it.\u00a0 But some names are in fact valid but may be ill-advised.\u00a0 In this case SNIP<\/strong><\/span> provides an information recommendations that you can override using the Add New User Account (NTRIP Client)<\/strong> button and proceed (for a Base Station a similar button is shown).<\/p>\n

    A few common Errors or Recommendations<\/h3>\n

    Here are a few examples where the chosen name is a conflict.<\/p>\n

    Here is an example where the selected name already exists and may be used<\/p>\n

    \"\"<\/a><\/p>\n

    Here is an example where the name is a close match to an existing name (differing only in case).<\/p>\n

    \"\"<\/a><\/p>\n

    Once a suitable name has been entered, the page proceeds to the next step, registering either a new User Account<\/a> or a New Base Station Push-In reservation.\u00a0 You can abandon the process by closing the page at any time.<\/p>\n","protected":false},"excerpt":{"rendered":"

    Whenever a new ‘resource’ is created in SNIP, it is given a name.\u00a0 The name must follow certain rules and within a given ‘type’ of resource (such as User Accounts or Base Stations) the name must be unique.\u00a0 This article describes the Web API process when a new User or […]<\/p>\n","protected":false},"author":13,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"_exactmetrics_skip_tracking":false,"_exactmetrics_sitenote_active":false,"_exactmetrics_sitenote_note":"","_exactmetrics_sitenote_category":0,"footnotes":""},"ht-kb-category":[418],"ht-kb-tag":[379,178,332,518],"class_list":["post-8333","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-reports","ht_kb_tag-base-station","ht_kb_tag-new-users","ht_kb_tag-reservations","ht_kb_tag-web-api"],"_links":{"self":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb\/8333","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/users\/13"}],"replies":[{"embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/comments?post=8333"}],"version-history":[{"count":10,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb\/8333\/revisions"}],"predecessor-version":[{"id":8441,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb\/8333\/revisions\/8441"}],"wp:attachment":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/media?parent=8333"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb-category?post=8333"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb-tag?post=8333"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}