API docs by Redocly

Prizz-Telecom Extranet API (2.0)

Download OpenAPI specification:Download

License: proprietary

Prizz-Telecom Extranet API https://dev.prizz-telecom.fr/

Appointments

get appointments

Authorizations:
(bearerAuthtokenAuth)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Appointment

get appointment

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

id

Responses

Response samples

Content type
application/json
{
  • "availableWorkflows": [
    ],
  • "id": 0,
  • "name": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "houseNumber": 0,
  • "houseNumberComplement": "string",
  • "streetName": "string",
  • "postalCode": "string",
  • "cityName": "string",
  • "inseeCode": "string",
  • "serviceContract": {
    },
  • "contact": {
    },
  • "tech": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "accepted": true,
  • "status": "to_plan",
  • "type": "technical_tour",
  • "confirmationProcessId": 0
}

Attachment

Get attachment

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

attachment id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "category": "string",
  • "mimeType": "string",
  • "presignedUrl": "string",
  • "presignedUrlExpires": "2019-08-24T14:15:22Z"
}

Attachments Public

Get public attachments

Authorizations:
(bearerAuthtokenAuth)

Responses

Response samples

Content type
application/json
{
  • "attachments": [
    ]
}

Attachements entity

Get entity linked attachments

Authorizations:
(bearerAuthtokenAuth)
query Parameters
entityId
required
integer

attached entity id

entityType
required
string
Enum: "invoice" "commercial_offer" "service_contract"

attached entity type

Responses

Response samples

Content type
application/json
{
  • "attachments": [
    ]
}

Client legal entity

Get customer company details

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifier

Responses

Response samples

Content type
application/json
{
  • "availableWorkflows": [
    ],
  • "id": 0,
  • "name": "string",
  • "houseNumber": 0,
  • "houseNumberComplement": "string",
  • "streetName": "string",
  • "postalCode": "string",
  • "cityName": "string",
  • "inseeCode": "string",
  • "url": "string",
  • "numVatIntracommunity": "string",
  • "siren": "string",
  • "codeApe": "string",
  • "rcs": "string",
  • "tel": "string",
  • "email": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "x": 0.1,
  • "y": 0.1,
  • "projection": "string",
  • "arcepCode": "string",
  • "contacts": [
    ],
  • "configuredContacts": [
    ],
  • "contracts": [
    ],
  • "roles": [
    ]
}

Client legal entities

company list owned

Authorizations:
(bearerAuthtokenAuth)
query Parameters
page
integer
itemsPerPage
integer
sort[id]
string
Enum: "ASC" "DESC"
legalEntityId
integer
search
string

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Comment thread

Get comment thread

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

thread id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "createDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "owner": "string",
  • "title": "string",
  • "entityClass": "string",
  • "entityId": 0,
  • "public": "string",
  • "subscribers": [
    ],
  • "comments": [
    ]
}

Comment threads

Get comment threads

Authorizations:
(bearerAuthtokenAuth)
query Parameters
entityClass
required
string

thread linked entity class

entityId
required
integer

thread linked entity id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Commercial Offer

Récupérer le détail d'un devis

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant du devis

Responses

Response samples

Content type
application/json
{
  • "availableWorkflows": [
    ],
  • "id": 0,
  • "name": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "rcTotal": {
    },
  • "rcTotalStr": {
    },
  • "rcVATTotal": {
    },
  • "rcVATTotalStr": {
    },
  • "nrcTotal": 0,
  • "nrcTotalStr": "string",
  • "nrcVATTotal": 0,
  • "nrcVATTotalStr": "string",
  • "status": "new",
  • "legalEntity": {
    },
  • "clientLegalEntity": {
    },
  • "signDate": "2019-08-24T14:15:22Z",
  • "submitDate": "2019-08-24T14:15:22Z",
  • "deliveryDelay": 0,
  • "total": 0,
  • "totalStr": "string",
  • "vatTotal": 0,
  • "vatTotalStr": "string",
  • "sectionNames": "string",
  • "vatDetail": [
    ],
  • "vatDetailStr": [
    ],
  • "sections": [
    ],
  • "contacts": [
    ],
  • "configuredContacts": [
    ]
}

Commercial Offer by reference CPTXXXXXX, CPIXXXXXX

Get commercial offer by reference

Authorizations:
(bearerAuthtokenAuth)
path Parameters
offer_name
required
string

commercial offer name string

Responses

Response samples

Content type
application/json
{
  • "availableWorkflows": [
    ],
  • "id": 0,
  • "name": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "rcTotal": {
    },
  • "rcTotalStr": {
    },
  • "rcVATTotal": {
    },
  • "rcVATTotalStr": {
    },
  • "nrcTotal": 0,
  • "nrcTotalStr": "string",
  • "nrcVATTotal": 0,
  • "nrcVATTotalStr": "string",
  • "status": "new",
  • "legalEntity": {
    },
  • "clientLegalEntity": {
    },
  • "signDate": "2019-08-24T14:15:22Z",
  • "submitDate": "2019-08-24T14:15:22Z",
  • "deliveryDelay": 0,
  • "total": 0,
  • "totalStr": "string",
  • "vatTotal": 0,
  • "vatTotalStr": "string",
  • "sectionNames": "string",
  • "vatDetail": [
    ],
  • "vatDetailStr": [
    ],
  • "sections": [
    ],
  • "contacts": [
    ],
  • "configuredContacts": [
    ]
}

Commercial Offer PDF

Récupérer le PDF d'un devis

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant du devis

Responses

Commercial Offers

Récupérer une liste de devis

Authorizations:
(bearerAuthtokenAuth)
query Parameters
page
integer
itemsPerPage
integer
sort[id]
string
Enum: "ASC" "DESC"
sort[createDate]
string
Enum: "ASC" "DESC"
legalEntityId
integer
clientLegalEntityId
integer
sections.offerId
integer
status
string
Enum: "new" "estimate_pending" "approval_pending" "validated" "abandoned" "signed"
createDate[from]
string <date>
createDate[to]
string <date>
search
string

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Commercial Offers

Créer un devis

Authorizations:
(bearerAuthtokenAuth)
Request Body schema: application/json
required
legalEntityId
integer
clientLegalEntityId
integer

Responses

Request samples

Content type
application/json
{
  • "legalEntityId": 0,
  • "clientLegalEntityId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "success": true,
  • "lastLog": "string"
}

Submit Commercial Offer

Valider un devis

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant du devis

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "success": true,
  • "lastLog": "string"
}

Sign Commercial Offer

Signer un devis

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant du devis

Request Body schema: application/json
optional
code
string or null

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "success": true,
  • "lastLog": "string",
  • "step": "codeSent"
}

Fast order with eligiblity result

Créer un devis à partir d'un résultat d'éligibilité

Authorizations:
(bearerAuthtokenAuth)
path Parameters
elig_ctx_id
required
integer

identifiant du contexte d'éligibilité

Request Body schema: application/json
required
name
string
clientReference
string or null
combinationId
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "clientReference": "string",
  • "combinationId": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "success": true,
  • "lastLog": "string"
}

Commercial Offer Sections

Ajouter une section à un devis

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant du devis

Request Body schema: application/json
required
name
string
clientReference
string or null
clientContractId
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "clientReference": "string",
  • "clientContractId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "success": true,
  • "lastLog": "string"
}

Rename Commercial Offer Section

Renommer une section

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant du devis

sectionId
required
integer

identifiant de la section

Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "success": true,
  • "lastLog": "string"
}

Set Commercial Offer Section Offer

Appliquer une offre à une section

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant du devis

sectionId
required
integer

identifiant de la section

Request Body schema: application/json
required
offerId
integer
object

Responses

Request samples

Content type
application/json
{
  • "offerId": 0,
  • "eligibility": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "success": true,
  • "lastLog": "string"
}

Remove Commercial Offer Section

Supprimer une section

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant du devis

sectionId
required
integer

identifiant de la section

Responses

Update Commercial Offer Section Items

Update items in commercial offer section

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant du devis

sectionId
required
integer

identifiant de la section

Request Body schema: application/json
required
bandwidth
string or null

bandwith in mb/s

grt
string or null

duration and type

commitment
string or null

duration in months

express
string or null

Construction time in days

Responses

Request samples

Content type
application/json
{
  • "bandwidth": "1000",
  • "grt": "4HNO",
  • "commitment": "24",
  • "express": "28"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "success": true,
  • "lastLog": "string"
}

Commercial Offer Section

Get commercial offer section

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

commercial offer section identifier

Responses

Response samples

Content type
application/json
{
  • "availableWorkflows": [
    ],
  • "id": 0,
  • "name": "string",
  • "commercialOfferId": 0,
  • "clientReference": "string",
  • "commercialOfferItems": [
    ],
  • "offer": {
    },
  • "serviceContract": {
    },
  • "clientContract": {
    }
}

Commercial Offer Item

Get commercial offer item

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

commercial offer item identifier

Responses

Response samples

Content type
application/json
{
  • "availableWorkflows": [
    ],
  • "id": 0,
  • "name": "string",
  • "unitPrice": 0,
  • "unitPriceStr": "string",
  • "unit": "string",
  • "vat": "string",
  • "recurrence": "monthly",
  • "unitPriceDiscount": 0,
  • "unitPriceDiscountStr": "string",
  • "quantity": 0,
  • "houseNumber": 0,
  • "houseNumberComplement": "string",
  • "streetName": "string",
  • "postalCode": "string",
  • "cityName": "string",
  • "inseeCode": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "x": 0.1,
  • "y": 0.1,
  • "projection": "string",
  • "price": 0,
  • "sectionId": 0,
  • "commercialOfferId": 0,
  • "priceStr": "string",
  • "vatRate": 0.1,
  • "commercialCode": "string",
  • "description": "string",
  • "toEstimate": true,
  • "priceListItem": {
    }
}

Commercial offer add comment

Add commercial offer comment

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

commercial offer identifier

Request Body schema: application/json
optional
title
string or null
threadId
integer or null
parentId
integer or null
contentType
string or null
Enum: "text" "markdown"
content
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "threadId": 0,
  • "parentId": 0,
  • "contentType": "text",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "success": true,
  • "lastLog": "string"
}

Create Eligibility

Eligibility request for your user. One eligibility is made for each company allowed to your user

Authorizations:
(bearerAuthtokenAuth)
query Parameters
address
string

address to test

lat
number <double>

latitude for tests by lon,lat

lon
number <double>

longitude for tests by lon,lat

clientId
required
integer

client to test

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "responses": [
    ]
}

Get Eligibility

Get eligibility result

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

process identifier

Responses

Response samples

Content type
application/json
{
  • "wf": 0,
  • "wfs": "string",
  • "attrs": { },
  • "wftr": [
    ],
  • "client": {
    },
  • "response": [
    ]
}

Eligibility History

View last executed eligibilities

Authorizations:
(bearerAuthtokenAuth)
query Parameters
page
integer
itemsPerPage
integer

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Exploitation Ticket Deprecated

Récupérer le détail d'un ticket

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant de l'opérateur

ref
required
string

numero du ticket

Responses

Response samples

Content type
application/json
{
  • "numero": "string",
  • "date_creation": "string",
  • "date_cloture": "string",
  • "date_debut_incident": "string",
  • "date_resolution": "string",
  • "date_gtr": "string",
  • "etat": "string",
  • "running_workflows": [
    ],
  • "archived_workflows": [
    ]
}

Exploitation Operator Tickets Deprecated

Créer un opérateur

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant de l'opérateur

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "lib": "string"
}

Exploitation Operator Tickets Deprecated

Lister les tickets pour l'opérateur

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant de l'opérateur

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Exploitation Tickets Deprecated

Ouvrir un ticket pour l'opérateur

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant de l'opérateur

query Parameters
serviceId
integer

identifiant du service

Responses

Response samples

Content type
application/json
{
  • "numero": "string",
  • "ticket_id": 0,
  • "running_process": [
    ]
}

Exploitation Tickets Deprecated

Lister les tickets

Authorizations:
(bearerAuthtokenAuth)
query Parameters
sort[date_creation]
string
Enum: "ASC" "DESC"
etat
string
Enum: "ticket_setup" "att_prise_en_compte" "dispatch" "investigation" "resolu" "end"
operator
integer
Value: 42
showArchived
boolean
Default: false

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Exploitation Process Deprecated

Detail d'un worklow de ticket

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant de l'opérateur

processId
required
integer

identifiant du process

Responses

Response samples

Content type
application/json
{
  • "context_id": 0,
  • "entity_id": 0,
  • "entity_class": "string",
  • "process_class": "string",
  • "start_date": "string",
  • "state": "string",
  • "state_lib": "string",
  • "end_date": "string",
  • "attrs": {
    },
  • "lib": "string",
  • "title": "string",
  • "states": [
    ],
  • "attachments": [
    ],
  • "actions": [
    ]
}

Exploitation Process Deprecated

Executer un process

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant de l'opérateur

processId
required
integer

identifiant du process

Request Body schema: multipart/form-data
required
files
Array of strings <binary> [ items <binary > ]
transition_class
string
property name*
additional property
any

Responses

Response samples

Content type
application/json
{
  • "context_id": 0,
  • "entity_id": 0,
  • "entity_class": "string",
  • "process_class": "string",
  • "start_date": "string",
  • "state": "string",
  • "state_lib": "string",
  • "end_date": "string",
  • "attrs": {
    },
  • "lib": "string",
  • "title": "string",
  • "states": [
    ],
  • "attachments": [
    ],
  • "actions": [
    ]
}

Invoice

Récupérer le détail d'une facture

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant de la facture

Responses

Response samples

Content type
application/json
{
  • "availableWorkflows": [
    ],
  • "id": 0,
  • "createDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "rcTotal": {
    },
  • "rcTotalStr": {
    },
  • "rcVATTotal": {
    },
  • "rcVATTotalStr": {
    },
  • "nrcTotal": 0,
  • "nrcTotalStr": "string",
  • "nrcVATTotal": 0,
  • "nrcVATTotalStr": "string",
  • "clientLegalEntity": {
    },
  • "legalEntity": {
    },
  • "ref": "string",
  • "monthPeriod": 0,
  • "yearPeriod": 0,
  • "total": 0,
  • "totalStr": "string",
  • "totalVAT": 0,
  • "totalVATStr": "string",
  • "details": [
    ],
  • "useVATReverseCharge": true,
  • "dueDate": "2019-08-24T14:15:22Z",
  • "submitDate": "2019-08-24T14:15:22Z"
}

Invoice Pdf

Récupérer le pdf d'une facture

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant de la facture

Responses

Invoices

Récupérer une liste de factures

Authorizations:
(bearerAuthtokenAuth)
query Parameters
page
integer
itemsPerPage
integer
sort[id]
string
Enum: "ASC" "DESC"
sort[createDate]
string
Enum: "ASC" "DESC"
clientLegalEntityId
integer
legalEntityId
integer
month
integer
year
integer
search
string

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Invoice Detail

Get invoice detail

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

invoice detail identifier

Responses

Response samples

Content type
application/json
{
  • "availableWorkflows": [
    ],
  • "id": 0,
  • "unitPrice": 0,
  • "unitPriceStr": "string",
  • "unit": "string",
  • "vat": "string",
  • "recurrence": "monthly",
  • "quantity": 0,
  • "unitPriceDiscount": 0,
  • "unitPriceDiscountStr": "string",
  • "name": "string",
  • "houseNumber": 0,
  • "houseNumberComplement": "string",
  • "streetName": "string",
  • "postalCode": "string",
  • "cityName": "string",
  • "inseeCode": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "x": 0.1,
  • "y": 0.1,
  • "projection": "string",
  • "amount": 0,
  • "invoiceId": 0,
  • "amountStr": "string",
  • "VATrate": 0.1,
  • "serviceId": 0,
  • "serviceContractId": 0,
  • "description": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z"
}

Legal entity

Récupérer le détail d'une société

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant de la société

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "houseNumber": 0,
  • "houseNumberComplement": "string",
  • "streetName": "string",
  • "postalCode": "string",
  • "cityName": "string",
  • "inseeCode": "string",
  • "url": "string",
  • "numVatIntracommunity": "string",
  • "siren": "string",
  • "codeApe": "string",
  • "rcs": "string",
  • "tel": "string",
  • "email": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "x": 0.1,
  • "y": 0.1,
  • "projection": "string",
  • "logo": "string"
}

Legal entities

Récupérer une liste de sociétés

Authorizations:
(bearerAuthtokenAuth)
query Parameters
page
integer
itemsPerPage
integer
sort[id]
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Offers

Récupérer une liste d'offres

Authorizations:
(bearerAuthtokenAuth)
query Parameters
ids[]
Array of integers

identifiant de l'offre

codes[]
Array of strings

nom de l'offre

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Offers Contexts

Get all prices combinations for an offer and a price list

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer
query Parameters
priceList
required
integer
groups[]
Array of strings
Items Enum: "bandwidth" "grt" "nrc" "commitment" "pop" "upgade_lag" "securisation" "express" "distance" "fiber_count" "extremities" "extremity_site_a" "extremity_site_b" "racco_event" "subnet" "maintenance" "desserte" "volume" "national" "location"

group list (e.g. bandwith, commitment, ...)

autofillOffer
boolean

add default products for each missing required groups to get a valid offer

items[]
Array of integers

determined items id to avoid combination with (e.g. FAS which are determined during eligibility)

distance
integer

estimate of the extension of our network to be built

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Offers Contexts

Get all prices combinations for an offer and a price list (shortened)

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer
query Parameters
priceList
required
integer
groups[]
Array of strings
Items Enum: "bandwidth" "grt" "nrc" "commitment" "pop" "upgade_lag" "securisation" "express" "distance" "fiber_count" "extremities" "extremity_site_a" "extremity_site_b" "racco_event" "subnet" "maintenance" "desserte" "volume" "national" "location"

group list (e.g. bandwith, commitment, ...)

autofillOffer
boolean

add default products for each missing required groups to get a valid offer

items[]
Array of integers

determined items id to avoid combination with (e.g. FAS which are determined during eligibility)

distance
integer

estimate of the extension of our network to be built

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Offers Context

Get an offer context

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer
query Parameters
items[]
required
Array of integers

price list items ids

distance
integer

distance for L2 basic offer

Responses

Response samples

Content type
application/json
{
  • "offerId": 0,
  • "isValid": true,
  • "total": 0,
  • "totalWithoutNrc": 0,
  • "items": [
    ]
}

Price List

Récupérer un catalogue

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant du catalogue

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "legalEntity": {
    },
  • "commercialCode": "string",
  • "description": "string",
  • "items": [
    ]
}

Price Lists

Récupérer une liste de catalogues

Authorizations:
(bearerAuthtokenAuth)
query Parameters
ids[]
required
Array of integers

identifiant de catalogue

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Price List Offers

Récupérer la liste des offres associées à un catalogue

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant du catalogue

Responses

Response samples

Content type
application/json
{
  • "offers": [
    ]
}

Price List Items

Récupérer une liste d'éléments d'un catalogue

Authorizations:
(bearerAuthtokenAuth)
query Parameters
ids[]
required
Array of integers

identifiant de l'élément de catalogue

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search

Perform search

Authorizations:
(bearerAuthtokenAuth)
query Parameters
q
required
string

text to search for

legalEntityId
integer

identifier to filter results

clientLegalEntityId
integer

identifier to filter results

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Service Contract

Récupérer le détail d'un pack de services

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant du pack de services

Responses

Response samples

Content type
application/json
{
  • "availableWorkflows": [
    ],
  • "id": 0,
  • "name": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "canceledReason": "string",
  • "canceledDate": "2019-08-24T14:15:22Z",
  • "status": "new",
  • "legalEntityId": 0,
  • "clientContractId": 0,
  • "subscriptionDate": "2019-08-24T14:15:22Z",
  • "activationDate": "2019-08-24T14:15:22Z",
  • "firstActivationDate": "2019-08-24T14:15:22Z",
  • "offer": {
    },
  • "client": {
    },
  • "refClient": "string",
  • "refService": "string",
  • "description": "string",
  • "services": [
    ],
  • "nrcs": [
    ],
  • "plannedActivationDate": "2019-08-24T14:15:22Z",
  • "soldActivationDate": "2019-08-24T14:15:22Z",
  • "commitmentEndDate": "2019-08-24T14:15:22Z",
  • "attributes": { },
  • "consolidatedAttributes": { },
  • "consolidatedAttributesStagingOrNew": { },
  • "commercialOffers": [
    ],
  • "contacts": [
    ],
  • "configuredContacts": [
    ],
  • "replaces": 0
}

Service Contract by name

Récupérer le détail d'un pack de services

Authorizations:
(bearerAuthtokenAuth)
path Parameters
service_name
required
string

identifiant du pack de services

Responses

Response samples

Content type
application/json
{
  • "availableWorkflows": [
    ],
  • "id": 0,
  • "name": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "canceledReason": "string",
  • "canceledDate": "2019-08-24T14:15:22Z",
  • "status": "new",
  • "legalEntityId": 0,
  • "clientContractId": 0,
  • "subscriptionDate": "2019-08-24T14:15:22Z",
  • "activationDate": "2019-08-24T14:15:22Z",
  • "firstActivationDate": "2019-08-24T14:15:22Z",
  • "offer": {
    },
  • "client": {
    },
  • "refClient": "string",
  • "refService": "string",
  • "description": "string",
  • "services": [
    ],
  • "nrcs": [
    ],
  • "plannedActivationDate": "2019-08-24T14:15:22Z",
  • "soldActivationDate": "2019-08-24T14:15:22Z",
  • "commitmentEndDate": "2019-08-24T14:15:22Z",
  • "attributes": { },
  • "consolidatedAttributes": { },
  • "consolidatedAttributesStagingOrNew": { },
  • "commercialOffers": [
    ],
  • "contacts": [
    ],
  • "configuredContacts": [
    ],
  • "replaces": 0
}

Get service contract operational status

Le statut présenté est un état consolidé du résultat de plusieurs tests et de mesures en différents points du réseau effectué périodiquement. Les valeurs de status disponibles sont :

  • ok : votre service est produit normalement
  • warning : le service laisse penser qu'il nécessite une attention particulière (exemple: uptime faible)
  • critical : le service est interrompu
  • unknown : nous n'avons pas pu remonter l'état du service

L'attribut lastCheck vous indique quand le service a été testé pour la dernière fois

Authorizations:
(bearerAuthtokenAuth)
path Parameters
service_name
required
string

identifiant du contrat de services

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "lastCheck": "string"
}

Service Contracts

Récupérer une liste de packs de services

Authorizations:
(bearerAuthtokenAuth)
query Parameters
page
integer
itemsPerPage
integer
sort[id]
string
Enum: "ASC" "DESC"
sort[status]
string
Enum: "ASC" "DESC"
status
string
Enum: "new" "staging" "active" "ending" "terminated"
legalEntityId
integer
offerId
integer
search
string

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Service Contract set vlan

Set service contract vlan

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

service contract identifier

Request Body schema: application/json
required
vid
integer

vlan id in group

Responses

Request samples

Content type
application/json
{
  • "vid": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "success": true,
  • "lastLog": "string"
}

Service Contract add comment

Add service contract comment

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

service contract identifier

Request Body schema: application/json
optional
title
string or null
threadId
integer or null
parentId
integer or null
contentType
string or null
Enum: "text" "markdown"
content
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "threadId": 0,
  • "parentId": 0,
  • "contentType": "text",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "success": true,
  • "lastLog": "string"
}

Service

Récupérer le détail d'un service

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

identifiant du service

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "unitPriceDiscount": 0,
  • "unitPriceDiscountStr": "string",
  • "houseNumber": 0,
  • "houseNumberComplement": "string",
  • "streetName": "string",
  • "postalCode": "string",
  • "cityName": "string",
  • "inseeCode": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "attributes": { },
  • "quantity": 0,
  • "unitPrice": 0,
  • "unitPriceStr": "string",
  • "unit": "string",
  • "vat": "string",
  • "recurrence": "monthly",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "x": 0.1,
  • "y": 0.1,
  • "projection": "string",
  • "product": {
    },
  • "status": "new",
  • "subscriptionDate": "2019-08-24T14:15:22Z",
  • "activationDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "terminationDate": "2019-08-24T14:15:22Z",
  • "serviceContractId": 0,
  • "paidUntil": "2019-08-24T14:15:22Z"
}

Services

Récupérer une liste de services

Authorizations:
(bearerAuthtokenAuth)
query Parameters
page
integer
itemsPerPage
integer
sort[id]
string
Enum: "ASC" "DESC"
legalEntityId
integer

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

User

Récupérer le détail de l'utilisateur connecté

Authorizations:
(bearerAuthtokenAuth)

Responses

Response samples

Content type
application/json
{
  • "availableWorkflows": [
    ],
  • "id": 0,
  • "firstname": "string",
  • "lastname": "string",
  • "companyName": "string",
  • "email": "string",
  • "phone1": "string",
  • "phone2": "string",
  • "gender": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDate": "2019-08-24T14:15:22Z"
}

User Api Tokens

Récupérer les clés d'api pour un utilisateur

Authorizations:
(bearerAuthtokenAuth)
query Parameters
page
integer
itemsPerPage
integer

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Workflows

Create workflow

Authorizations:
(bearerAuthtokenAuth)
Request Body schema: application/json
required
contextName
string
Enum: "Infracorp\\Services\\Workflow\\ClientLegalEntity\\CreateCommercialOffer\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\Submit\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\Sign\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\Rename\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\AddSection\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\RemoveSection\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\RenameSection\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\UpdateOfferItemInOffer\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\SetOffer\\Context" "Infracorp\\Services\\Workflow\\Comment\\AddComment\\Context" "Infracorp\\Services\\Workflow\\Comment\\SubscribeThread\\Context" "Infracorp\\Services\\Workflow\\Comment\\UpdateComment\\Context" "Infracorp\\Services\\Workflow\\Comment\\UpdateThread\\Context" "Infracorp\\Services\\Workflow\\ClientLegalEntity\\CreateCommentThread\\Context" "Infracorp\\Services\\Workflow\\ServiceContract\\CreateCommentThread\\Context" "Infracorp\\Services\\Workflow\\Invoice\\CreateCommentThread\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\CreateCommentThread\\Context" "Infracorp\\Services\\Workflow\\Users\\CreateToken\\Context" "Infracorp\\Services\\Workflow\\Users\\RevokeToken\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\UpdateSubscribers\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\AddItem\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\RemoveItem\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\UpdateSectionItems\\Context" "Infracorp\\Services\\Workflow\\ClientLegalEntity\\AssignContact\\Context" "Infracorp\\Services\\Workflow\\ClientLegalEntity\\AddContact\\Context" "Infracorp\\Services\\Workflow\\ClientLegalEntityContact\\SwitchActive\\Context" "Infracorp\\Services\\Workflow\\Contact\\Update\\Context" "Infracorp\\Services\\Workflow\\ServiceContract\\UpdateDescription\\Context" "Infracorp\\Services\\Workflow\\ServiceContract\\UpdateClientRef\\Context" "Infracorp\\Services\\Workflow\\ServiceContract\\Activation\\SetupL2\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\UpdateClientRefSection\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\AssignContact\\Context" "Infracorp\\Services\\Workflow\\ServiceContract\\AssignContact\\Context" "Infracorp\\Services\\Workflow\\ServiceContract\\Contact\\SwitchActive\\Context" "Infracorp\\Services\\Workflow\\CommercialOffer\\Contact\\SwitchActive\\Context" "Infracorp\\Services\\Workflow\\Users\\SwitchActiveRole\\Context" "Infracorp\\Services\\Workflow\\ClientLegalEntity\\AddUserRole\\Context" "Infracorp\\Services\\Workflow\\Appointment\\ChangeContact\\Context" "Infracorp\\Services\\Workflow\\Appointment\\CustomerCancel\\Context" "Infracorp\\Services\\Workflow\\Appointment\\CustomerChangeDate\\Context" "Infracorp\\Services\\Workflow\\Appointment\\CustomerConfirm\\Context" "Infracorp\\Services\\Workflow\\ServiceContract\\MigrateCoaxToL2Premium\\Context"
entityId
integer

Responses

Request samples

Content type
application/json
{
  • "contextName": "Infracorp\\Services\\Workflow\\ClientLegalEntity\\CreateCommercialOffer\\Context",
  • "entityId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "state": "string",
  • "success": true,
  • "log": "string",
  • "redirect": {
    }
}

Workflow

get workflow

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

workflow id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "context": "string",
  • "entityId": 0,
  • "entityClass": "string",
  • "state": "string",
  • "html": "string",
  • "transitions": [
    ]
}

Workflow

run workflow

Authorizations:
(bearerAuthtokenAuth)
path Parameters
id
required
integer

workflow id

Request Body schema:
required
files
Array of strings <binary> [ items <binary > ]
property name*
additional property
any

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "id": 0,
  • "state": "string",
  • "success": true,
  • "log": "string",
  • "redirect": {
    }
}

Workflows running

Get running workflows

Authorizations:
(bearerAuthtokenAuth)
query Parameters
contexts
string

context names

states
string

states

Responses

Response samples

Content type
application/json
{
  • "workflows": [
    ]
}