API : Porting Update

Introduction

This request will update the specified porting.

When updating a porting, you do not need to send the full porting object. As little as a single property can be sent, so only send the properties you need to update, and the rest will be untouched. Although only 6 properties can be updated, it is perfectly fine to send the whole object, the rest will just be ignored.

Request

URL	https://api.telecomx.dk/porting/PORTING_ID
Method	POST
Access level	VIEWER, MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. ADMIN.
Param	PORTING_ID	Id of the porting (24 hex-char string)
Body	number	String	The phone number in E.164 format
	additionalNumbers	Array	If porting a series (at least 10 numbers) this is an array of the additional numbers in E.164 format.
	donorSimNumber	String	ICC/Sim card number from current SIM at donor operator. Only valid for MVNO portings.
	donorCustomerId	String	Id number of customer at donor operator, if known.
	requestedDate	Date	The requested date for the porting to be carried out.
	notify	Array	Array of e-mail address of the people who wish to be notified when a porting progresses.
	customSeries	Boolean	True if number series has custom formatting.
	customSeriesData	Array	List of custom series data, one series pr. line, <e.164-number>-<e.164 number>
	customSeriesPrimary	String	Custom series primary number.

Only properties to be updated should be included, so as little as a single property can be changed.

Query example

{
  donorSimNumber: '89450201456789245542'
}

Response

Json object
_id	Id	Id of the porting.
number	String	The phone number in E.164 format
additionalNumbers	Array	If porting a series (at least 10 numbers) this is an array of the additional numbers in E.164 format.
numberType	String	Type of numbers: SIP or MVNO.
portingType	String	Type of porting: IN or OUT.
donorSimNumber	String	ICC/Sim card number from current SIM at donor operator. Only valid for MVNO portings.
donorCustomerId	String	Id number of customer at donor operator, if known.
customer	Id	Id of customer the porting belongs to.
voiceAccount	Id	Id of voice account (SIP or MVNO account) the porting belongs to.
status.date	Date	The date and time the porting entered the current stage.
status.stage	String	The current stage of the porting, see list of porting stages above.
status.message	String	If stage is OUT_REJECTED then: AUTH_MISSING (No POA or valid ICC received in time ), WRONG_NUMBER (POA customer or signer is not the owner of the number), SIM_MISMATCH (SIM/ICC is not correct for the number) or NOT_IN_USE (Number is not in use). If stage is IN_CONFIRMED or OUT_CONFIRMED then: the porting date chosen. If stage is IN_DONOR_CONTACTED, OUT_RECEIVER_CONTACTED or IN_CANCELLED then: this is an optional message.
status.employee	Id	Id of the employee who caused the porting to move to the current stage, null if done by system.
statusHistory	Array	Array of Status object (4 rows above), for the previous stages the porting has been at.
operator	String	CPS code of the donor or receiving operator.
operatorName	String	Name of the donor or receiving operator.
createdDate	Date	The date the porting was created.
requestedDate	Date	The requested date for the porting to be carried out.
orderedDate	Date	The date the porting was ordered. Null if not yet ordered.
portingDate	Date	The actual date the porting will be carried out. Null if not yet determined.
documents	Array	Array of Ids of the Power Of Attorney documents received/uploaded from the customer, that are be to be used for this porting.
notify	Array	Array of e-mail address of the people who wish to be notified when a porting progresses.
customSeries	Boolean	True if number series has custom formatting.
customSeriesData	Array	List of custom series data, one series pr. line, <e.164-number>-<e.164 number>
customSeriesPrimary	String	Custom series primary number.

Note that properties holding no value may be omitted from the object.

Example

{
      _id: '1234567890ABCDEF12345678',
      ichId: '565254645',
      ochFlowId: '567356575663673',
      number: '+4581808888',
      numberType: 'MVNO',
      portingType: 'IN',
      status:
      {
        date: '2014-01-01T12:34:56.789Z',
        stage: 'IN_CONFIRMED',
        message: '2014-02-01T12:34:56.789Z',
        employee: '1234567890ABCDEF12345678'
      },
      statusHistory:
      [
        { ... },
        { ... },
        { ... }
      ],
      operator: '0211',
      operatorName: 'Oister',
      createdDate: '2014-01-01T12:34:56.789Z',
      requestedDate: '2014-01-01T12:34:56.789Z',
      orderedDate: '2014-01-01T12:34:56.789Z',
      portingDate: '2014-01-01T12:34:56.789Z',
      documents: ['1234567890ABCDEF12345678'],
      notify: ['donald@disney.com','goofy@disney.com'],
      customSeries: false
}

Errors

Error code	Message	Description
400	bad_request	Porting not found in body of request
400	bad_request	Porting id not foudn in request URI
404	porting	Porting not found
403	access_denied	Insufficient access level
422	number	Number is not a valid number
422	additionalNumbers	One or more additional numbers are not valid
422	donorSimNumber	Donor SIM number is not valid
500	number	Failed to lookup operator for number
422	notify	The e-mail address \'X\' is invalid
422	donorSimNumber	SIM number not valid according to donors validation
422	customSeriesData	Invalid formatting detected
409	customSeriesData	The number of phone numbers in the custom series data is wrong
404	customSeriesData[x]	Number XXX at row XXX does not belong to this porting
500	internal_error	<Unspecified>

WIKI

Table of Contents