api:porting:poa-get
Table of Contents
API : Porting POA Get
Introduction
This request is used after a POA create with method DOWNLOAD has been completed, for downloading the POA PDF file(s) created. The request should be invoked once pr. POA PDF file.
An Id for downloading a POA PDF file can only be used once. After that POA Create must be called again to create new files.
Request
| URL | https://api.telecomx.dk/porting/CUSTOMER_ID/poa/get/POA_ID | |
|---|---|---|
| Method | GET | |
| Access level | OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. ADMIN. |
|
| Param | CUSTOMER_ID | Id of the customer (24 hex-char string) |
| POA_ID | Id of the POA PDF document (24 hex-char string) | |
| Query | forcedownload | 'true' to force the browser to download instead of showing. |
| filename | To specify or alter the filename returned with the file. | |
Query example
https://api.telecomx.dk/porting/1234567890ABCDEF12345678/poa/get/1234567890ABCDEF12345678 https://api.telecomx.dk/porting/1234567890ABCDEF12345678/poa/get/1234567890ABCDEF12345678?forcedownload=true https://api.telecomx.dk/porting/1234567890ABCDEF12345678/poa/get/1234567890ABCDEF12345678?filename=mydoc.pdf
Response
The PDF document.
Errors
| Error code | Message | Description |
|---|---|---|
| 400 | bad_request | Customer id not found in requested URI |
| 400 | bad_request | Porting power of attorney document id not found in request URI |
| 403 | access_denied | Insufficient access level |
| 404 | id | File not found |
| 500 | internal_error | <Unspecified> |
api/porting/poa-get.txt · Last modified: 2014/10/04 14:39 by Per Møller