Use the sources API endpoint with the GET method to retrieve information about a Data Source including the name, reference number, type, and current state.
Prerequisites
Note the FormSpace and Data Source IDs for the Data Sources that you want to retrieve details for.
Base URL
https://api.prontoforms.com
Endpoint
GET
/api/1.1/formspaces/{formSpaceID}/sources/{sourceID}
Retrieves the details of a Data Source.
URL structure
Copy
https://api.prontoforms.com/api/1.1/formspaces/{formspaceID}/sources/{sourceID}
Request parameters
None
Request header
Include the standard authorization header. This includes the username and password, where username is the API Key ID and password is the API Key Secret.
cURL example
curl -v -k -u {username}:{password} -X GET https://api.prontoforms.com/api/1.1/formspaces/{formSpaceID}/sources/{sourceID}
where username is the API Key ID and password is the API Key Secret.
Request body
None
Response code
200—OK
Response example
Copy
{
"identifier": "160000000",
"name": "Customer Information",
"description": "Customer information",
"type": "Upload",
"data": {
"identifier": "160000000",
"asyncStatus": null
}
}
Error codes
Error code | Error message | HTTP response code | Description |
---|---|---|---|
AccessDenied | Access Denied: You are not allowed to access the requested resource. | 403 | The Data Source doesn't exist in your account. |
ObjectNotFound | Object Not Found: The object you requested could not be found | 404 | The system couldn't find the Data Source or the FormSpace. Verify the FormSpace and Data Source IDs and try again. |
Comments
0 comments
Please sign in to leave a comment.