{"id":8363,"date":"2022-06-20T12:43:56","date_gmt":"2022-06-20T12:43:56","guid":{"rendered":"https:\/\/www.use-snip.com\/kb\/?post_type=ht_kb&p=8363"},"modified":"2022-06-21T20:30:04","modified_gmt":"2022-06-21T20:30:04","slug":"web-api-add-a-base","status":"publish","type":"ht_kb","link":"https:\/\/www.use-snip.com\/kb\/knowledge-base\/web-api-add-a-base\/","title":{"rendered":"Web API, Add a Base"},"content":{"rendered":"

This article describes the step-by-step<\/em> process to remotely add a new Push_In Base Station Reservation<\/a> (for an NTRIP Server<\/a>) to the Caster.\u00a0 When the Web API Plug-In is present, SNIP<\/strong><\/span> allows adding new Base Station reservations remotely with a browser.\u00a0 For the Caster Admin account this process is never limited (you can create as many Base Stations as you wish and your license allows).\u00a0 For Customer Accounts, the number of Bases which can be added by that Customer is limited by the value set by the Caster Administrator for the Customer.\u00a0\u00a0 An active Web API Plug-in<\/a> is required for this feature.\u00a0 First Login<\/strong> <\/a>from an authorized account with read-write<\/em> privileges, not with read-only<\/em> privileges.<\/p>\n

From the Web API top page<\/a>, go to the Current PUSH-In<\/span> Bases and Reservations <\/strong>section at the top of the page.\u00a0 Press the button marked Add a New Base Station Reservation (NTRIP Server)<\/strong>.<\/p>\n

<\/form>\n

You will then be taken to a page to establish the name<\/strong> to be used with new Base (its mountPt name).\u00a0 See this article<\/a> for details of the naming process.\u00a0 Once a name has been determined, you will be taken to the New Push_in Reservation page, shown below (click to enlarge).<\/p>\n

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

The data fields all follow the same general flow which the SNIP<\/strong><\/span> dialog for a new Push-In Reservation<\/a> does.<\/p>\n

The name<\/strong> you entered on the prior page is used for the mountPt.\u00a0 This is the name the NTRIP Server<\/a> will\u00a0 use to connect.<\/p>\n

The password<\/strong> field is completed with a suggested password.\u00a0 You may change this if desired.\u00a0 This is the password the NTRIP Server will\u00a0 use to connect.<\/p>\n

The Rev<\/strong> selects which\u00a0 NTRIP Protocol will be used, Rev1 or Rev2.<\/p>\n

When Rev2 is selected an account user name is also required for greater security.<\/p>\n

Please provide the (optional) name of City<\/strong> near the base.\u00a0 Only ASCII characters are allowed, as well as spaces.\u00a0 No diacritical marks are allowed.<\/p>\n

Please select the (optional) Country<\/strong> where the Base is located from the drop down list.<\/p>\n

It is generally best to leave the data stream Parsed<\/strong>.\u00a0 SNIP<\/strong><\/span> will automatically determine the contents of the data stream ad us that data to complete the Caster Table entry and other details for you.<\/p>\n

You can also hide<\/strong> the mountPt from being listed in the Caster table.\u00a0 This provide a minimal level of security, but some NTRIP Clients (notably older Trimble devices) cannot use a hidden mountPts.<\/p>\n

If you wish to restrict the IP<\/strong> that can connect and send this data stream, enter the details here.\u00a0 This provides an additional level of level of security. The stream must still use the correct mountPt name and password defined above.<\/p>\n

You can also enter pre-defined Caster Table Entry<\/strong> if you wish.\u00a0 It if generally best to let SNIP<\/strong><\/span> set this for you based on the contents of the data stream.<\/p>\n

If you wish the raw message data to be Logged<\/strong> as a data file, check this button.<\/p>\n

The Owner Details<\/strong> allow you to assign ownership of the new Base Station to a Customer Account.\u00a0 The default is to not assign the new Base.\u00a0 In such cases the Admin account “owns” the base station.\u00a0 If needed, you can assign ownership to a new Customer Account after it is created (by editing the Reservation).<\/p>\n

 <\/p>\n

When the form is submitted (press the Update the Reservation<\/strong> button), the new Push-In reservation is created and an email with similar details is send to the Admin and the owner of the account (if the eMail Plug-In<\/a> is active)\u00a0\u00a0 See the below image.\u00a0 If there are any creation problems, a page with a summary of\u00a0 the errors is presented.<\/p>\n

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

Use by Customer Accounts<\/h2>\n

When this process is performed by a browser logged in with a Customer Account, the top of the page also provides a summary of how many Base Stations they have already created (and therefore own<\/em>) and how many more they are allowed to create.\u00a0 The ownership section is automatically assigned to their account (and they cannot edit this).<\/p>\n

 <\/p>\n

 <\/p>\n","protected":false},"excerpt":{"rendered":"

This article describes the step-by-step process to remotely add a new Push_In Base Station Reservation (for an NTRIP Server) to the Caster.\u00a0 When the Web API Plug-In is present, SNIP allows adding new Base Station reservations remotely with a browser.\u00a0 For the Caster Admin account this process is never limited […]<\/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":[331,332,518],"class_list":["post-8363","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-reports","ht_kb_tag-push-in","ht_kb_tag-reservations","ht_kb_tag-web-api"],"_links":{"self":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb\/8363","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=8363"}],"version-history":[{"count":14,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb\/8363\/revisions"}],"predecessor-version":[{"id":8439,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb\/8363\/revisions\/8439"}],"wp:attachment":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/media?parent=8363"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb-category?post=8363"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb-tag?post=8363"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}