Prizz-Telecom Extranet API (1.0)

Download OpenAPI specification:

Obtention des contacts

Permet l’obtention des identifiants de contacts opérateur. Ces identifiants seront utilisés lors de l’appel au WS de commande pour indiquer les contacts.

Responses

Response samples

200

Content type

application/json

[{"idContact": 0,
"nom": "string",
"prenom": "string",
"civilite": 0,
"actif": true,
"mail": "string",
"numTel1": "string",
"numTel2": "string",
"fonction": "string"
}
]

Création d'un contact

Permet de créer un nouveau contact qui pourra être associé à un service

Request Body schema: application/json
required

nom	string
prenom	string
civilite	integer
mail	string
numTel1	string
numTel2	string
fonction	string

Responses

Request samples

Payload

Content type

application/json

{"nom": "string",
"prenom": "string",
"civilite": 0,
"mail": "string",
"numTel1": "string",
"numTel2": "string",
"fonction": "string"
}

Response samples

201
400
401

Content type

application/json

{"statusCode": 0,
"status": "string",
"object": {"idContact": 0,
"nom": "string",
"prenom": "string",
"civilite": 0,
"actif": true,
"mail": "string",
"numTel1": "string",
"numTel2": "string",
"fonction": "string"
}
}

Obtention des portes de livraison

Permet l’obtention des codes des portes de livraison. Ces identifiants seront utilisés lors de l’appel au WS de commande L2 pour indiquer les portes.

Responses

Response samples

200

Content type

application/json

[{"code": "string",
"lib": "string",
"site": "string",
"bandwidth_mb": "string",
"is_default": true
}
]

Souscription commande L2

Permet de souscrire à une commande de type L2

Request Body schema: application/json
required

nomClient	string nom du client final
idOffre	integer identifiant de l'offre
idOptions	Array of integers
commentaire	string un commentaire
	Array of objects (ContactGTROrderForm)
	object (AdresseDTO)
	object (ContactSiteDTO)
idContacts	Array of integers
	object (InfosActivationDTO) service subscription query v1

Responses

Request samples

Payload

Content type

application/json

{"nomClient": "string",
"idOffre": 0,
"idOptions": [0
],
"commentaire": "string",
"contactsGTR": [{"type": "string",
"idContact": 0
}
],
"adresse": {"codePostal": "string",
"extension": "string",
"numero": "string",
"rue": "string",
"ville": "string",
"typeVoie": "string",
"escalier": "string",
"etage": "string",
"extAppart": "string",
"localisation": "string",
"nomBatiment": "string",
"numAppart": "string"
},
"contactSite": {"nom": "string",
"nmTel": "string",
"mail": "string",
"horaire": "string"
},
"idContacts": [0
],
"infosActivationService": {"nvlanPorte": 0,
"nvlanSite": 0,
"refPorte": "string",
"siteUtilisateurFinal": "string",
"porteLivraison": "string",
"interfaceLivraison": "string"
}
}

Response samples

201
400
401
404
409

Content type

application/json

{"id": 0,
"ref": "string",
"statusCode": 0,
"status": "string"
}

Obtention des catalogues

Cette méthode permet de lister les offres au catalogue. Il s’agit de l’ensemble des couples « offre – frais d’accès au service » éligibles et possédant un identifiant produit unique idProduit

Responses

Response samples

200

Content type

application/json

[{"famille": "string",
"debitMontantMax": 0.1,
"debitDescendantGaranti": 0.1,
"debitDescendantMax": 0.1,
"debitMontantGaranti": 0.1,
"engagement": 0,
"zone": "string",
"idProduit": "string",
"libelle": "string",
"fas": 0.1,
"prixHt": 0.1,
"fasSurDevis": true,
"prixSurDevis": true,
"recurrent": true,
"periodicite": "string"
}
]

Suivi de la commande

Cette méthode permet de suivre l'état de la commande passée en paramètre.

path Parameters

refCommande

required

string

Référence de la commande

Responses

Response samples

200
404

Content type

application/json

[{"etatCommande": "string",
"commentaires": [{"commentaire": "string",
"contact": {"nom": "string",
"prenom": "string",
"civilite": 0,
"mail": "string",
"numTel1": "string",
"numTel2": "string",
"fonction": "string"
},
"date": "string"
}
]
}
]

Eligibilité via une adresse

permet de savoir si une adresse donnée est éligible et de connaître les offres disponibles ainsi que le coût des frais d’accès au service

Request Body schema: application/json
required

codePostal	string code postal de l’adresse à tester
numero	string numéro dans la rue
rue	string le nom de la rue sans le type de voie
typeVoie	string le type de la voie de l’adresse à tester
ville	string ville de l’adresse à tester
civilite	integer or null Enum: null 1 2 civilité de la personne demandant le test d’éligibilité. 1 pour Monsieur 2 pour Madame
nom	string or null nom de la personne demandant le test d’éligibilité
prenom	string or null prénom de la personne demandant le test d’éligibilité

Responses

Request samples

Payload

Content type

application/json

{"codePostal": "string",
"numero": "string",
"rue": "string",
"typeVoie": "string",
"ville": "string",
"civilite": null,
"nom": "string",
"prenom": "string"
}

Response samples

200

Content type

application/json

{"eligibilites": [{"famille": {"idFamille": 0,
"nom": "string",
"echeanceLivraison": 0
},
"offres": [{"idOffre": 0,
"idOffreFas": "string",
"idFasZone": 0,
"detail": {"idDetail": 0,
"nom": 0,
"libelle": "string",
"description": "string",
"prixHt": 0.1,
"prixTtc": 0.1,
"recurrent": 0,
"engagement": 0,
"prorata": 0,
"actif": 0,
"periodicite": {"idPeriode": 0,
"typePeriode": "string"
},
"tva": {"idTva": 0,
"libelle": "string",
"taux": 0.1
}
},
"gtr": {"idGtr": 0,
"type": "string",
"heure": 0
},
"debit": {"id": 0,
"debitMontant": 0.1,
"uniteMontant": "string",
"debitDescendant": 0.1,
"uniteDescendant": "string"
}
}
],
"fraisAccesService": {"idFraisAccesService": 0,
"surDevis": 0,
"detail": {"idDetail": 0,
"nom": "string",
"libelle": "string",
"description": "string",
"prixHt": 0.1,
"prixTtc": 0.1,
"recurrent": 0,
"engagement": 0,
"prorata": 0,
"actif": 0,
"surDevis": 0,
"sortIndex": 0,
"periodicite": {"idPeriode": 0,
"typePeriode": "string"
},
"tva": {"idTva": 0,
"libelle": "string",
"taux": 0.1
}
},
"intervalle": {"idIntervalle": 0,
"libelle": "string",
"min": 0,
"max": 0
},
"zone": {"idZone": 0,
"libelle": "string"
},
"idFasZone": 0,
"nomFasZone": "string"
},
"distance": 0
}
],
"adresseDemandee": "string",
"adresseTestee": "string",
"statusCode": 0,
"status": "string"
}

Eligibilité via une adresse

permet de savoir si une adresse donnée est éligible et de connaître les offres disponibles ainsi que le coût des frais d’accès au service

Request Body schema: application/json
required

codePostal	string code postal de l’adresse à tester
numero	string numéro dans la rue
rue	string le nom de la rue sans le type de voie
typeVoie	string le type de la voie de l’adresse à tester
ville	string ville de l’adresse à tester
civilite	integer or null Enum: null 1 2 civilité de la personne demandant le test d’éligibilité. 1 pour Monsieur 2 pour Madame
nom	string or null nom de la personne demandant le test d’éligibilité
prenom	string or null prénom de la personne demandant le test d’éligibilité

Responses

Request samples

Payload

Content type

application/json

{"codePostal": "string",
"numero": "string",
"rue": "string",
"typeVoie": "string",
"ville": "string",
"civilite": null,
"nom": "string",
"prenom": "string"
}

Response samples

200

Content type

application/json

{"eligibilites": [{"famille": {"idFamille": 0,
"nom": "string",
"echeanceLivraison": 0
},
"offres": [{"idOffre": 0,
"idOffreFas": "string",
"idFasZone": 0,
"detail": {"idDetail": 0,
"nom": 0,
"libelle": "string",
"description": "string",
"prixHt": 0.1,
"prixTtc": 0.1,
"recurrent": 0,
"engagement": 0,
"prorata": 0,
"actif": 0,
"periodicite": {"idPeriode": 0,
"typePeriode": "string"
},
"tva": {"idTva": 0,
"libelle": "string",
"taux": 0.1
}
},
"gtr": {"idGtr": 0,
"type": "string",
"heure": 0
},
"debit": {"id": 0,
"debitMontant": 0.1,
"uniteMontant": "string",
"debitDescendant": 0.1,
"uniteDescendant": "string"
}
}
],
"fraisAccesService": {"idFraisAccesService": 0,
"surDevis": 0,
"detail": {"idDetail": 0,
"nom": "string",
"libelle": "string",
"description": "string",
"prixHt": 0.1,
"prixTtc": 0.1,
"recurrent": 0,
"engagement": 0,
"prorata": 0,
"actif": 0,
"surDevis": 0,
"sortIndex": 0,
"periodicite": {"idPeriode": 0,
"typePeriode": "string"
},
"tva": {"idTva": 0,
"libelle": "string",
"taux": 0.1
}
},
"intervalle": {"idIntervalle": 0,
"libelle": "string",
"min": 0,
"max": 0
},
"zone": {"idZone": 0,
"libelle": "string"
},
"idFasZone": 0,
"nomFasZone": "string"
},
"distance": 0
}
],
"adresseDemandee": "string",
"adresseTestee": "string",
"statusCode": 0,
"status": "string"
}

Eligibilité via une longitude et une latitude

permet de savoir si une adresse donnée est éligible et de connaître les offres disponibles ainsi que le coût des frais d’accès au service

Request Body schema: application/json
required

lon	number <float> longitude
lat	number <float> latitude
idOffres	Array of integers liste des offres
civilite	integer or null Enum: null 1 2 civilité de la personne demandant le test d’éligibilité. 1 pour Monsieur 2 pour Madame
nom	string or null nom de la personne demandant le test d’éligibilité
prenom	string or null prénom de la personne demandant le test d’éligibilité

Responses

Request samples

Payload

Content type

application/json

{"lon": 0.1,
"lat": 0.1,
"idOffres": [0
],
"civilite": null,
"nom": "string",
"prenom": "string"
}

Response samples

200

Content type

application/json

{"eligibilites": [{"famille": {"idFamille": 0,
"nom": "string",
"echeanceLivraison": 0
},
"offres": [{"idOffre": 0,
"idOffreFas": "string",
"idFasZone": 0,
"detail": {"idDetail": 0,
"nom": 0,
"libelle": "string",
"description": "string",
"prixHt": 0.1,
"prixTtc": 0.1,
"recurrent": 0,
"engagement": 0,
"prorata": 0,
"actif": 0,
"periodicite": {"idPeriode": 0,
"typePeriode": "string"
},
"tva": {"idTva": 0,
"libelle": "string",
"taux": 0.1
}
},
"gtr": {"idGtr": 0,
"type": "string",
"heure": 0
},
"debit": {"id": 0,
"debitMontant": 0.1,
"uniteMontant": "string",
"debitDescendant": 0.1,
"uniteDescendant": "string"
}
}
],
"fraisAccesService": {"idFraisAccesService": 0,
"surDevis": 0,
"detail": {"idDetail": 0,
"nom": "string",
"libelle": "string",
"description": "string",
"prixHt": 0.1,
"prixTtc": 0.1,
"recurrent": 0,
"engagement": 0,
"prorata": 0,
"actif": 0,
"surDevis": 0,
"sortIndex": 0,
"periodicite": {"idPeriode": 0,
"typePeriode": "string"
},
"tva": {"idTva": 0,
"libelle": "string",
"taux": 0.1
}
},
"intervalle": {"idIntervalle": 0,
"libelle": "string",
"min": 0,
"max": 0
},
"zone": {"idZone": 0,
"libelle": "string"
},
"idFasZone": 0,
"nomFasZone": "string"
},
"distance": 0
}
],
"adresseDemandee": "string",
"adresseTestee": "string",
"statusCode": 0,
"status": "string"
}

Eligibilité via une longitude et une latitude

permet de savoir si une adresse donnée est éligible et de connaître les offres disponibles ainsi que le coût des frais d'accès au service

path Parameters

lon required	float Longitude
lat required	float Latitude

Responses

Response samples

200

Content type

application/json

{"eligibilites": [{"famille": {"idFamille": 0,
"nom": "string",
"echeanceLivraison": 0
},
"offres": [{"idOffre": 0,
"idOffreFas": "string",
"idFasZone": 0,
"detail": {"idDetail": 0,
"nom": 0,
"libelle": "string",
"description": "string",
"prixHt": 0.1,
"prixTtc": 0.1,
"recurrent": 0,
"engagement": 0,
"prorata": 0,
"actif": 0,
"periodicite": {"idPeriode": 0,
"typePeriode": "string"
},
"tva": {"idTva": 0,
"libelle": "string",
"taux": 0.1
}
},
"gtr": {"idGtr": 0,
"type": "string",
"heure": 0
},
"debit": {"id": 0,
"debitMontant": 0.1,
"uniteMontant": "string",
"debitDescendant": 0.1,
"uniteDescendant": "string"
}
}
],
"fraisAccesService": {"idFraisAccesService": 0,
"surDevis": 0,
"detail": {"idDetail": 0,
"nom": "string",
"libelle": "string",
"description": "string",
"prixHt": 0.1,
"prixTtc": 0.1,
"recurrent": 0,
"engagement": 0,
"prorata": 0,
"actif": 0,
"surDevis": 0,
"sortIndex": 0,
"periodicite": {"idPeriode": 0,
"typePeriode": "string"
},
"tva": {"idTva": 0,
"libelle": "string",
"taux": 0.1
}
},
"intervalle": {"idIntervalle": 0,
"libelle": "string",
"min": 0,
"max": 0
},
"zone": {"idZone": 0,
"libelle": "string"
},
"idFasZone": 0,
"nomFasZone": "string"
},
"distance": 0
}
],
"adresseDemandee": "string",
"adresseTestee": "string",
"statusCode": 0,
"status": "string"
}

Connexion

Request Body schema: application/json
required

email	string
mdp	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"mdp": "string"
}

Response samples

200

Content type

application/json

{"token": { },
"statusCode": 0,
"status": "string"
}

Prizz-Telecom Extranet API (1.0)

Obtention des contacts

Responses

Response samples

Création d'un contact

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Obtention des portes de livraison

Responses

Response samples

Souscription commande L2

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Obtention des catalogues

Responses

Response samples

Suivi de la commande

path Parameters

Responses

Response samples

Eligibilité via une adresse

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Eligibilité via une adresse

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Eligibilité via une longitude et une latitude

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Eligibilité via une longitude et une latitude

path Parameters

Responses

Response samples

Connexion

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required