post https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/getDocumentsforOffering
This method is used to retrieve the document URL path and document details for a particular offering document (addDocumentsforOffering).
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| clientID | yes | string | TransactAPI Client ID |
| developerAPIKey | yes | string | TransactAPI Developer Key |
| offeringId | yes | integer | Offering ID that is generated by the API once an offering is created (createOffering) |
Sample Request
curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/getDocumentsforOffering
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=55591
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| statusCode | string | API Status Code |
| statusDesc | string | API Status Description |
| documentTitle | string | Title of the document |
| documentId | integer | Document ID |
| url | string | Document URL after water marked |
Sample Response
{
"statusCode": "101",
"statusDesc": "Ok",
"document_details": [
{
"documentTitle": "Offer Doc one",
"documentId": "97891",
"templateName": Offering Documents,
"documentFileReferenceCode": "080916113242",
"documentName": "GKrQ090916063243.pdf",
"createdDate": "2016-09-09 06:32:43",
"url": "https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/stamp/PDF/VGVzdA==/GKrQ090916063243.pdf"
},
{
"documentTitle": "Offer Doc two",
"documentId": "34122",
"templateName": Offering Documents,
"documentFileReferenceCode": "080916113242",
"documentName": "GKrQ0909160632431.pdf",
"createdDate": "2016-09-09 06:32:43",
"url": "https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/stamp/PDF/VGVzdA==/GKrQ0909160632431.pdf"
},
{
"documentTitle": "24oct2016_1",
"documentId": "21344",
"templateName": Offering Documents,
"documentFileReferenceCode": "24102016121212",
"documentName": "GKrQ241016060807.pdf",
"createdDate": "2016-10-24 06:08:07",
"url": "https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/stamp/PDF/VGVzdA==/GKrQ241016060807.pdf"
},
{
"documentTitle": "24oct2016_2",
"documentId": "52348",
"templateName": Offering Documents,
"documentFileReferenceCode": "24102016121212",
"documentName": "GKrQ2410160608071.pdf",
"createdDate": "2016-10-24 06:08:07",
"url": "https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/stamp/PDF/VGVzdA==/GKrQ2410160608071.pdf"
}
]
}