Cliente Patch #

Atualiza um conjunto específico de propriedades de um Cliente. Isso usa o JSON Formato de patch para quaisquer alterações.

PATCH /v1.0/clientes/{CUSTOMER_TENANT_ID}

Exemplo #

Esta solicitação atualizará a chave de api do PBX e habilitá-lo.

Solicitar #

PATCH <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/> HTTP/1.1
Tipo de conteúdo: application/json
Aceitação-Encargos: Verdadeiro
Autorização: Portador {TOKEN}
Conexão: keep-alive
[ {
		"op": "substituir",
		"caminho": "/enabled",
		"valor": falso
	}, {
		"op": "substituir",
		"caminho": "/pbxConnectionProfile/apiKey",
		"valor": "newapikey"
	}
][{
		"op": "replace",
		"path": "/enabled",
		"value": false
	}, {
		"op": "replace",
		"path": "/pbxConnectionProfile/apiKey",
		"value": "newapikey"
	}
]

Resposta #

HTTP/1.1 200 OK
Tipo de conteúdo: application/json; charset=utf-8
Conteúdo-Comprimento: xx
Contexto-solicitação: appId=cid-v1:d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	"status": "sucesso",
	"carimbo de data/hora": "2019-11-29T15:16:54.2586208Z"
}

Erros #

Não autorizado #

Quando o token não é fornecido, inválido ou expirado

HTTP/1.1 401 Não autorizado

Mau pedido (1) #

Quando o ID do locatário fornecido não estiver no formato correto

HTTP/1.1 400 Solicitação incorreta
Data: Thu, 06 Feb 2020 12:45:27 GMT
Tipo de conteúdo: application/json; charset=utf-8
Comprimento do conteúdo: 149
{
	"erro": 400,
	"message": "O valor '<tenant id>' não é válido.",
	"status": "erro",
	"carimbo de data/hora": "2020-02-06T12:45:27.5903465Z"
}

Mau pedido (2) #

Ao tentar corrigir uma propriedade inválida.

HTTP/1.1 400 Solicitação incorreta
Data: Thu, 06 Feb 2020 12:45:27 GMT
Tipo de conteúdo: application/json; charset=utf-8
Comprimento do conteúdo: 149
{
	"erro": 400,
	"message": "O local de destino especificado pelo segmento de caminho '<invalid property>' não foi encontrado.",
	"status": "erro",
	"carimbo de data/hora": "2020-02-06T12:45:27.5903465Z"
}

Não encontrado #

Quando não há Clientes que tenham um ID de locatário correspondente

HTTP/1.1 404 Não encontrado
Data: Thu, 06 Feb 2020 12:46:58 GMT
Tipo de conteúdo: application/json; charset=utf-8
Comprimento do conteúdo: 95
{
	"erro": 404,
	"message": "Não encontrado",
	"status": "erro",
	"carimbo de data/hora": "2020-02-06T12:46:58.7669535Z"
}