V1
Tesamanager
API to create and get TESA request.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| body | body | TesaActivationRequest | false | ‘none’ |
Request body - instance of TesaActivationRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| territoryOwner | string | true | Territory owner: * NEBA - Neba* VULA_COMMERCIAL - Vula commercial* VULA_REGULATED - Vula regulated |
| portabilityIndicator | string | false | Portability type: * D - Donor* T - Third party* N - Without portability* A - Agreement |
| externalReference | string | true | none |
| technicalCoordinators | TesaTechnicalCoordinators | true | none |
| customer | TesaCustomer | true | none |
| servicePoint | TesaServicePoint | true | none |
| Property | Values |
|---|---|
| territoryOwner | one of [NEBA, VULA_COMMERCIAL, VULA_REGULATED] |
| portabilityIndicator | one of [D, T, N, A] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created | TesaResult |
| 400 | Bad Request | Bad request | TesaResult |
| 401 | Unauthorized | Unauthorized | TesaResult |
| default | Default | Internal Server Error | TesaResult |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| body | body | TesaTerminationRequest | false | ‘none’ |
Request body - instance of TesaTerminationRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| territoryOwner | string | true | Territory owner: * NEBA - Neba* VULA_COMMERCIAL - Vula commercial* VULA_REGULATED - Vula regulated |
| externalReference | string | true | none |
| technicalCoordinators | TesaTechnicalCoordinators | true | none |
| customer | TesaCustomer | true | none |
| servicePoint | TesaTerminationServicePoint | true | none |
| Property | Values |
|---|---|
| territoryOwner | one of [NEBA, VULA_COMMERCIAL, VULA_REGULATED] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created | TesaResult |
| 400 | Bad Request | Bad request | TesaResult |
| 401 | Unauthorized | Unauthorized | TesaResult |
| default | Default | Internal Server Error | TesaResult |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| body | body | TesaModificationRequest | false | ‘none’ |
Request body - instance of TesaModificationRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | none |
| territoryOwner | string | true | Territory owner: * NEBA - Neba* VULA_COMMERCIAL - Vula commercial* VULA_REGULATED - Vula regulated |
| technicalCoordinators | TesaTechnicalCoordinators | true | none |
| customer | TesaCustomer | true | none |
| servicePoint | TesaServicePoint | true | none |
| Property | Values |
|---|---|
| territoryOwner | one of [NEBA, VULA_COMMERCIAL, VULA_REGULATED] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created | TesaResult |
| 400 | Bad Request | Bad request | TesaResult |
| 401 | Unauthorized | Unauthorized | TesaResult |
| default | Default | Internal Server Error | TesaResult |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| body | body | TesaCancellationRequest | false | ‘none’ |
Request body - instance of TesaCancellationRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | none |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Ok | TesaResult |
| 400 | Bad Request | Bad Request | TesaResult |
| 401 | Unauthorized | Unauthorized | TesaResult |
| 404 | Not Found | Not found | TesaResult |
| 406 | Not Acceptable | Not acceptable | TesaResult |
| default | Default | Internal Server Error | TesaResult |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| body | body | TesaIncidentResolveRequest | false | ‘none’ |
Request body - instance of TesaIncidentResolveRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | none |
| observations | string | false | none |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Ok | TesaResult |
| 400 | Bad Request | Bad Request | TesaResult |
| 401 | Unauthorized | Unauthorized | TesaResult |
| 404 | Not Found | Not found | TesaResult |
| 406 | Not Acceptable | Not acceptable | TesaResult |
| default | Default | Internal Server Error | TesaResult |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| body | body | TesaCreateAccessRequest | false | ‘none’ |
Request body - instance of TesaCreateAccessRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | none |
| technicianCode | string | true | none |
| reason | string | false | none |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | TesaCreateAccessResult |
| 400 | Bad Request | Bad request | TesaResult |
| 401 | Unauthorized | Unauthorized | TesaResult |
| 404 | Not Found | Not found | TesaResult |
| 406 | Not Acceptable | Not acceptable | TesaResult |
| default | Default | Internal Server Error | TesaResult |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| body | body | TesaCreateStatusCtoRequest | false | ‘none’ |
Request body - instance of TesaCreateStatusCtoRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | none |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | TesaResult |
| 400 | Bad Request | Bad request | TesaResult |
| 401 | Unauthorized | Unauthorized | TesaResult |
| 404 | Not Found | Not found | TesaResult |
| 406 | Not Acceptable | Not acceptable | TesaResult |
| default | Default | Internal Server Error | TesaResult |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| body | body | TesaCreatePortRequest | false | ‘none’ |
Request body - instance of TesaCreatePortRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | none |
| port | string | true | none |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | TesaResult |
| 400 | Bad Request | Bad request | TesaResult |
| 401 | Unauthorized | Unauthorized | TesaResult |
| 404 | Not Found | Not found | TesaResult |
| 406 | Not Acceptable | Not acceptable | TesaResult |
| default | Default | Internal Server Error | TesaResult |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| body | body | TesaCreatePortRequest | false | ‘none’ |
Request body - instance of TesaCreatePortRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | none |
| port | string | true | none |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | TesaResult |
| 400 | Bad Request | Bad request | TesaResult |
| 401 | Unauthorized | Unauthorized | TesaResult |
| 404 | Not Found | Not found | TesaResult |
| 406 | Not Acceptable | Not acceptable | TesaResult |
| default | Default | Internal Server Error | TesaResult |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| body | body | TesaTerminateAccessRequest | false | ‘none’ |
Request body - instance of TesaTerminateAccessRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | none |
| observations | string | true | none |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | TesaResult |
| 400 | Bad Request | Bad request | TesaResult |
| 401 | Unauthorized | Unauthorized | TesaResult |
| 404 | Not Found | Not found | TesaResult |
| 406 | Not Acceptable | Not acceptable | TesaResult |
| default | Default | Internal Server Error | TesaResult |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| body | body | TesaInstallationIncidentRequest | false | ‘none’ |
Request body - instance of TesaInstallationIncidentRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | none |
| requestType | string | true | none |
| requestNumber | integer(int64) | true | none |
| subRequestNumber | integer(int64) | true | none |
| incidence | string | true | none |
| cto | string | true | none |
| comments | string | true | none |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | TesaResult |
| 400 | Bad Request | Bad request | TesaResult |
| 401 | Unauthorized | Unauthorized | TesaResult |
| 404 | Not Found | Not found | TesaResult |
| 406 | Not Acceptable | Not acceptable | TesaResult |
| default | Default | Internal Server Error | TesaResult |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| body | body | TesaInstallationEndRequest | false | ‘none’ |
Request body - instance of TesaInstallationEndRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | none |
| requestType | string | true | none |
| requestNumber | integer(int64) | true | none |
| subRequestNumber | integer(int64) | true | none |
| test | string | true | none |
| indicator | string | true | none |
| owner | string | true | none |
| Property | Values |
|---|---|
| requestType | one of [NEBA, VULA] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | TesaResult |
| 400 | Bad Request | Bad request | TesaResult |
| 401 | Unauthorized | Unauthorized | TesaResult |
| 404 | Not Found | Not found | TesaResult |
| 406 | Not Acceptable | Not acceptable | TesaResult |
| default | Default | Internal Server Error | TesaResult |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| body | body | TesaMaintenanceCtoChangeRequest | false | ‘none’ |
Request body - instance of TesaMaintenanceCtoChangeRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| externalReference | string | true | none |
| territoryOwner | string | true | Territory owner: * NEBA - Neba* VULA_COMMERCIAL - Vula commercial* VULA_REGULATED - Vula regulated |
| iua | string | true | none |
| ctoIdentifier | string | true | none |
| ctoPort | string | false | none |
| reason | TesaReasonForCtoChange | true | Reason for the CTO change: * AV - Broken* OT - Others |
| Property | Values |
|---|---|
| territoryOwner | one of [NEBA, VULA_COMMERCIAL, VULA_REGULATED] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | TesaResult |
| 400 | Bad Request | Bad request | TesaResult |
| 401 | Unauthorized | Unauthorized | TesaResult |
| 404 | Not Found | Not found | TesaResult |
| 406 | Not Acceptable | Not acceptable | TesaResult |
| default | Default | Internal Server Error | TesaResult |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| statuses | query | array[string] | false | Get reference ids of requests with a status. Admits more than one status separated by ‘,’ |
| externalReference | query | string | false | Get reference ids of requests with an external reference |
| autoInstallation | query | boolean | false | Get reference ids of requests which are of auto-installation |
| cancelling | query | boolean | false | Get reference ids of cancelling requests |
| persistence_type | query | TesaPersistenceType | false | Persistence Type |
| notUpdatedSince | query | string(date-time) | false | Get reference ids of requests not updated since |
Enumerated Values
| Property | Values |
|---|---|
| statuses | one of [NOT_SENT, VALIDATING, REJECTED, PROCESSING, PROCESSED, INCIDENCE_TESA, INCIDENCE_OPERATOR, INSTALLING, INCIDENCE_INSTALLING, INSTALLED, CANCELED, FINISHED] |
| persistence_type | one of [ACTIVATION, TERMINATION] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The ids have been successfully retrieved | TesaReferenceIdList |
| 401 | Unauthorized | Unauthorized | TesaError |
| default | Default | Unexpected error | TesaError |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| reference_id | path | string | true | The id of the request to retrieve issues for |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The Tesa request has been successfully retrieved | TesaRequest |
| 401 | Unauthorized | Unauthorized | TesaError |
| 404 | Not Found | Not Found | TesaError |
| default | Default | Unexpected error | TesaError |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| reference_id | path | string | true | The id of the request to retrieve issues for |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The request events have been successfully retrieved | [TesaEvent] |
| 401 | Unauthorized | Unauthorized | TesaError |
| 404 | Not Found | Not Found | TesaError |
| default | Default | Unexpected error | TesaError |
200 - instance of TesaEvent
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer(int64) | false | Event id |
| reference_id | string | true | Request reference id |
| message_type | string | true | TESA message type |
| request_number | integer(int64) | true | TESA request code |
| subrequest_number | integer(int64) | true | TESA subrequest code returned |
| event_date | string(date-time) | true | Event date |
| sequence_number | integer(int32) | true | Sequence Number |
| inconsistent | boolean | true | If true, the event must be reconciled. |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| reference_id | path | string | true | The id of the request to retrieve issues for |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The request events have been successfully retrieved | [TesaConnectionEvent] |
| 401 | Unauthorized | Unauthorized | TesaError |
| 404 | Not Found | Not Found | TesaError |
| default | Default | Unexpected error | TesaError |
200 - instance of TesaConnectionEvent
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer(int64) | false | Event id |
| reference_id | string | true | Request reference id |
| message_type | string | true | TESA message type |
| request_number | integer(int64) | true | TESA request code |
| subrequest_number | integer(int64) | true | TESA subrequest code returned |
| event_date | string(date-time) | true | Event date |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | Tenant |
| reference_id | path | string | true | The id of the request to retrieve issues for |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The request issues have been successfully retrieved | [TesaIssue] |
| 401 | Unauthorized | Unauthorized | TesaError |
| 404 | Not Found | Not Found | TesaError |
| default | Default | Unexpected error | TesaError |
200 - instance of TesaIssue
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer(int64) | true | Id of the issue |
| reference_id | string | true | Request reference id |
| issue_sequence | integer(int32) | true | Number of issue |
| issue_code | string | true | Issue code |
| resolved | boolean | true | Issue is resolved or not |
| repeated | boolean | false | Issue is repeated or not |
| last_updated | string(date-time) | true | The date of the issue |
Endpoints
Provision TV Amazon
Provision TV Netflix
Provision TV HBO
Provision FTTH
Provision Orange TV
Tesamanager
Mobile
Device Insurance