pcc-gateway

[tags: DMA,RPRM]

Resource Root

https://localhost:8443/api/rest/pcc-gateway

Summary

Resources	Methods
https://localhost:8443/api/rest/pcc-gateway
https://localhost:8443/api/rest/pcc-gateway/pcc-gateway-status	GET Retrieves pcc gateway status.
https://localhost:8443/api/rest/pcc-gateway/{pcc-gateway-identifier}	DELETE Terminates a pcc gateway on DMA.

Resources

https://localhost:8443/api/rest/pcc-gateway

https://localhost:8443/api/rest/pcc-gateway/pcc-gateway-status

Methods

GET

Retrieves pcc gateway status.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-pcc-gateway-status+xml application/vnd.plcm.plcm-pcc-gateway-status+json	Information successfully retrieved
304		pcc gateway status information has not changed since the last search. Note: The API client must provide the "plcm-pcc-gateway-status" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator

https://localhost:8443/api/rest/pcc-gateway/{pcc-gateway-identifier}

Template Parameters

Name	Type	Description
pcc-gateway-identifier	xs:string	Unique identifier of the pcc gateway resource.

Methods

DELETE

Terminates a pcc gateway on DMA.
[tags: DMA]

Request

Response

Status	Representation	Description
204		Pcc Gateway was successfully terminated
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The Pcc Gateway was not found.