api:porting:poa-send
Table of Contents
API : Porting POA Send
Introduction
This request will send the Power Of Attorney document for a given porting to the donor operator or a specified recipient.
Request
| URL | https://api.telecomx.dk/porting/PORTING_ID/poa/send | |
|---|---|---|
| Method | GET | |
| Access level | ADMIN if no recipient given, otherwise OWNER, RESELLER or ADMIN. | |
| Param | PORTING_ID | Id of the porting (24 hex-char string) |
| Query | recipient | If the document should not be sent to the donor using the default recipient and default method, then this is the e-mail address or fax number (E.164 format) to send it to instead. |
Query example
https://api.telecomx.dk/porting/1234567890ABCDEF12345678/poa/send https://api.telecomx.dk/porting/1234567890ABCDEF12345678/poa/send?recipient=test@tester.com https://api.telecomx.dk/porting/1234567890ABCDEF12345678/poa/send?recipient=+4570305051
Response
| Json object | ||
|---|---|---|
| success | Boolean | True if request was sucessful. |
Example
{ success: true }
Errors
| Error code | Message | Description |
|---|---|---|
| 400 | bad_request | Porting id not found in requested URI |
| 403 | access_denied | Insufficient access level |
| 404 | documents | Porting has no documents |
| 422 | recipient | Recipient is neither an e-mail address nor a fax number |
| 500 | internal_error | Donor operator XXXXX not found |
| 500 | internal_error | <Unspecified> |
api/porting/poa-send.txt · Last modified: 2014/10/21 09:25 by Per Møller