MRR data collected in P4 or formatted as a P4 file may be submitted using the P4 software, or by using the PTAGIS API. P4 files cannot be submitted via email.
To submit files using P4, the user goes into the Manage Sessions section of the software, selects one or more sessions to submit and clicks the Upload button. After entering a valid registered email address and name for the sender, the user verifies the correct operation is selected for each file and then clicks the Upload button. The files are sent through the PTAGIS API. When the file is received, the status will be labeled as Pending. The user can update the status by clicking the Refresh Status button on the tool bar.
To submit files using the PTAGIS API directly, data contributors will need to do the following:
1.Obtain an API key from PTAGIS.
2.Build a properly formatted P4 file.
3.Build a properly formatted MRR Submission Manifest file.
4.Use the /MRR/RequestSubmitData endpoint to request authorization to submit a file, which will return a Submit Key, which is a GUID such as b419a72d-c111-fb70-d897-c2e613946b9a, if successful.
5.Use the /MRR/SubmitData endpoint with the Submit Key received in step four to submit the P4 file and the MRR Submission Manifest file in a zip file with a name that matches the Submit Key (e.g. b419a72d-c111-fb70-d897-c2e613946b9a.zip).
6.Use the /MRR/GetFileSubmissionStatus endpoint with the submit key to request the status of the file after it has been processed.
If you plan to build an application to submit P4 files using the web API, you should use the Test API while developing and testing the application. Files submitted using the Test API will be processed using the test system and will not be loaded into the production database. PTAGIS will provide source code and a sample console application as examples upon request.
After the file is accepted for processing, the /MRR/GetFileSubmissionStatus endpoint can be used to request the status of the file. Possible responses are shown below:
|
Response |
Definition |
|
Pending |
File has not been processed. |
|
Rejected |
The file did not pass data validation or file format requirements and was not loaded. |
|
Failed |
An unanticipated error occurred during file processing. Please contact PTAGIS for more information. |
|
Loaded |
First successful load of a data file with this name. |
|
Corrected |
A new version of the file was loaded successfully, replacing data from the previous version of the file. |
|
Provisional |
The file was loaded or corrected, but there were duplicate records, test tags, or some other condition that should be reviewed and corrected, if necessary. |
Version: 1.07
Published: 9/6/2023