Patch PBX

Patch PBX #

Met à jour un ensemble spécifique de propriétés d'un PbxConnectionProfile. Cette commande utilise le JSON Format du correctif pour toute modification.

PATCH /v1.0/clients/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}

Exemple 1 #

Cette demande met à jour le nom du PbxConnectionProfile.

Demander # 

PATCH <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}> HTTP/1.1
Type de contenu : application/json
accept-charges : true
Autorisation : Porteur {TOKEN}
Connexion : keep-alive
[ {
		« op » : « remplacer »,
		« path » : « /nom »,
		« value » : « Mon nouveau nom »
	}
][{
		"op": "replace",
		"path": "/name",
		"value": "My New Name"
	}
]

Réponse # 

HTTP/1.1 200 OK
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
Contexte-requête : appId=cid-v1 :d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	« status » : « succès »,
	« timestamp » : « 2019-11-29T15:16:54.2586208Z »
}

Exemple 2 #

Cette demande activera le Pbx. Cela entraînera l'établissement d'une connexion au Pbx et commencera à collecter les données d'événement.

Demander # 

PATCH /api/v1.0/customers/{TENANT_ID}/pbxs/{PBX_ID} HTTP/1.1
Type de contenu : application/json
accept-charges : true
Autorisation : Porteur {TOKEN}
Connexion : keep-alive
[ {
		« op » : « remplacer »,
		« path » : « /enabled »,
		« value » : « vrai »
	}
][{
		"op": "replace",
		"path": "/enabled",
		"value": "true"
	}
]

Réponse # 

HTTP/1.1 200 OK
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
Contexte-requête : appId=cid-v1 :d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	« status » : « succès »,
	« timestamp » : « 2019-11-29T15:16:54.2586208Z »
}

Erreurs #

Non autorisée #

Lorsque le jeton n'est pas fourni, qu'il n'est pas valide ou qu'il a expiré 

HTTP/1.1 401 Non autorisé

Mauvaise demande (1) #

Lorsque l'ID de locataire fourni n'est pas au format correct 

HTTP/1.1 400 Requête incorrecte
Date : Thu, 06 Feb 2020 12:45:27 GMT
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : 149
{
	« error » :400,
	« message » :"La valeur '<tenant id>' n'est pas valide.",
	« status » :"erreur »,
	« timestamp » :"2020-02-06T12:45:27.5903465Z »
}

Mauvaise demande (2) #

Lors de la tentative de correction d'une propriété non valide. 

HTTP/1.1 400 Requête incorrecte
Date : Thu, 06 Feb 2020 12:45:27 GMT
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : 149
{
	« error » : 400,
	« message » : « L'emplacement cible spécifié par segment de chemin '<invalid property>' n'a pas été trouvé.",
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:45:27.5903465Z »
}

Introuvable #

Lorsqu'il n'y a pas de clients qui ont un ID de locataire ou un Pbx correspondant avec l'ID 

HTTP/1.1 404 Introuvable
Date : Thu, 06 Feb 2020 12:46:58 GMT
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : 95
{
	« error » :404,
	« message » :"Introuvable »,
	« status » :"erreur »,
	« timestamp » :"2020-02-06T12:46:58.7669535Z »
}