API : Porting Get

Introduction

This request will return the the specified porting.

Request

URL	https://api.telecomx.dk/porting/PORTING_ID
Method	GET
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)
Query	expand	If true, customer, voiceAccount and employee (in status) will be expanded with *Name

Query example

https://api.telecomx.dk/porting/1234567890ABCDEF12345678

Response

Json object
_id	Id	Id of the porting.
ichId	String	ICH id.
ochFlowId	String	OCH flow id.
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.
customerName	String	Name of customer if expand=true.
voiceAccount	Id	Id of voice account (SIP or MVNO account) the porting belongs to.
voiceAccount	String	Name of voice account, if expand=true and voice account is a SIP account.
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 here.
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.
status.employeeName	String	Name of the employee, if expand=true and status.employee is set.
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, if expand!=true.
documents[]	Array	Array of documents, if expand=true, see below.
documents._id	Id	Id of the document, used for downloading it.
documents.filename	String	Name of the file.
documents.size	Integer	Size of the file in bytes.
notify	Array	Array of e-mail address of the people who wish to be notified when a porting progresses.
auth	String
validation	String	If porting is inbound, number type is MVNO, and auth is ICC/ICC_FAX/ICC_EMAIL then this may contains a regular expression showing how to validate the donorSimNumber.
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.
mitIdEnabled	Boolean	True if poa can be created to be signed with mitId (does reseller have criipto integration)
mitIdData	Array	Array of objects containg data relevant to poa's to be signed with mitId
mitIdData	Object	Object containing data relevant to poa's to be signed with mitId
mitIdData.href	String	url to signing poa
mitIdData.updatedAt	Date	Date of when poa was updated / created
mitIdData.signatoryId	String	Id of signatory in criipto
mitIdData.state	String	The current state of the signature order - if not “NEW” it will not be included in get request

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

Example

{
      _id: '1234567890ABCDEF12345678',
      ichId: '565254645',
      ochFlowId: '567356575663673',
      number: '+4570305050',
      additionalNumbers: ['+4570305051','+4570305052','+4570305053','+4570305054','+4570305055','+4570305056','+4570305057','+4570305058','+4570305059'],
      numberType: 'SIP',
      portingType: 'IN',
      status:
      {
        date: '2014-01-01T12:34:56.789Z',
        stage: 'IN_CONFIRMED',
        message: '2014-02-01T12:34:56.789Z',
        employee: '1234567890ABCDEF12345678'
      },
      statusHistory:
      [
        { ... },
        { ... },
        { ... }
      ],
      operator: '01015',
      operatorName: 'Telenor',
      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','1234567890ABCDEF12345678','1234567890ABCDEF12345678'],
      notify: ['donald@disney.com','goofy@disney.com'],
      customSeries: false
}

Errors

Error code	Message	Description
404	porting	Porting not found
403	access_denied	Insufficient access level

WIKI

Table of Contents

API : Porting Get

Introduction

Request

Query example

Response

Example

Errors