API : Porting POA Create

Introduction

This request will scan through all SIP and MVNO accounts and gather all numbers that requires porting and has not yet been ordered. It will then create a Power Of Attorney (POA) PDF document for each operator that numbers are to be ported from, and either send it/them by e-mail or fax to the customer for signing or prepare it/them for download using the API : Porting POA Get request.

This request will always always create create as few documents as possible, so if e.g. 20 MVNO portings are created because 20 MVNO account which requires porting has been created, then only a single document will be created, but it will be linked to all the 20 portings.

Request

URL	https://api.telecomx.dk/porting/CUSTOMER_ID/poa/create
Method	GET or POST
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)
Query	method	How to receive the POA document(s): DOWNLOAD, EMAIL or FAX
	recipient	If method is EMAIL or FAX, then this is who it should be sent to. If not specified or the value 'DEFAULT' is specified, then the the e-mail address or fax number number of the primary contact at the customer is used. If specified then it is either a fax number (method=FAX) or an e-mail address (method=EMAIL). If method is DOWNLOAD this property is ignored.
	override	If the owner needs to be different from the customer on the POA documents, the override allows you to set an alternative name, address, zip, city, state, country and vatNumber. This requires that the request is a POST. Properties may be omitted if not needed.
	mitId	If poa can be signed with mitId. Set to true or false. In body if POST, query if GET

Query example

https://api.telecomx.dk/porting/1234567890ABCDEF12345678/poa/create?method=DOWNLOAD
https://api.telecomx.dk/porting/1234567890ABCDEF12345678/poa/create?method=EMAIL&recipient=test@tester.com
https://api.telecomx.dk/porting/1234567890ABCDEF12345678/poa/create?method=FAX&recipient=+4570305051
https://api.telecomx.dk/porting/1234567890ABCDEF12345678/poa/create?mitId=true

{
  method: 'DOWNLOAD',
  override: {
    name: 'Company-we-purchased',
    address: 'Some street 123',
    zip: '1234',
    city: 'Mytown',
    vatNumber: '1234567890'
  }
}

Response

Json object
success	Boolean	True if request was sucessful.
documents	Array

Example

{
  success: true,
  documents: ['1234567890ABCDEF12345678','1234567890ABCDEF12345678']
}

Errors

Error code	Message	Description
400	bad_request	Customer id not found in requested URI
403	access_denied	Insufficient access level
404	not_found	No portings found in the correct stage for creating power of attorney document
422	recipient	Recipient e-mail address is invalid
422	recipient	Recipient fax number is invalid
500	internal_error	<Unspecified>

WIKI

Table of Contents