Simplified ISDN Gateway Prefixes



[tags: DMA,RPRM]

Resource Root

https://localhost:8443/api/rest/simplified-gateway-prefixes

Summary


Resources Methods
https://localhost:8443/api/rest/simplified-gateway-prefixes

GET  Retrieves a list of prefix-driven simplified ISDN gateway dialing service configured in system.

POST  Creates a simplified ISDN gateway dialing service in the system.

https://localhost:8443/api/rest/simplified-gateway-prefixes/{prefix-service-identifier}

GET  Retrieves information about a simplified isdn gateway prefix service.

PUT  Updates a simplified ISDN gateway prefix service.

DELETE  Deletes a simplified ISDN gateway prefix service resource on DMA.

Resources


https://localhost:8443/api/rest/simplified-gateway-prefixes


Methods

GET


Retrieves a list of prefix-driven simplified ISDN gateway dialing service configured in system.
[tags: DMA,RPRM]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-simplified-gateway-prefixes-list+xml
application/vnd.plcm.plcm-simplified-gateway-prefixes-list+json
Simplified ISDN gateway dialing services retrieved successfully.
304
Prefix Service information has not changed since the last search.

Note: The API client must provide the "plcm-simplified-gateway-prefixes-list"
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.

The "plcm-simplified-gateway-prefixes-list" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
prefix services on the server.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA role required: administrator
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.

POST


Creates a simplified ISDN gateway dialing service in the system.
[tags: DMA,RPRM]

Request

Representations

application/vnd.plcm.plcm-simplified-gateway-prefixes+xml
application/vnd.plcm.plcm-simplified-gateway-prefixes+json

Response

Status Representation Description
201 Simplified ISDN gateway dialing service created successfully.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Service Name is null.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Service Enabled flag is null.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
dialing-prefix is null.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
use-all-isdn-gateways flag is null.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA role required: administrator
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
dialing-prefix is not valid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
use-all-isdn-gateways is false and selected-isdn-gateways is null/empty.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
selected isdn gateway is not a valid gateway.

https://localhost:8443/api/rest/simplified-gateway-prefixes/{prefix-service-identifier}


Template Parameters

Name Type Description
prefix-service-identifier xs:string Unique identifier of the simplified ISDN gateway prefix service resource.

Methods

GET


Retrieves information about a simplified isdn gateway prefix service.
[tags: DMA,RPRM]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
configured name or immutable, unique identifier such as a ID.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its configured name.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{prefix-service-identifier}?type={identifier|name}
Note 2: If the "identifier" enumeration is specified, the prefix-service-identifier should correspond to the unique identifier.
Otherwise, the resource cannot not be found.
Note 3: If the "name" enumeration is specified, then the prefix-service-identifier should correspond to the service name.
Otherwise, the resource cannot not be found.
Note 4: The read will default to the "identifier" type enumeration. As a result, the {prefix-service-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=identifier", is not required.

Response

Status Representation Description
200 application/vnd.plcm.plcm-simplified-gateway-prefixes+xml
application/vnd.plcm.plcm-simplified-gateway-prefixes+json
prefix service information successfully retrieved.
304
Prefix Service information has not changed since the last retrieval.
Note: The API client must provide the "plcm-simplified-gateway-prefixes" 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 single gateway service retrieval in the "If-None-Match" header, then
the HTTP response will contain the prefix service representation in the message body.

The "plcm-simplified-gateway-prefixes" ETag can be accessed from the initial retrieval result's HTTP
response header.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA role required: administrator
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 simplified ISDN gateway prefix service was not found.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid resource identifier type. Valid types are: [identifier,name]

PUT


Updates a simplified ISDN gateway prefix service.
[tags: DMA,RPRM]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
configured name or immutable, unique identifier such as a ID.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its configured name.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{prefix-service-identifier}?type={identifier|name}
Note 2: If the "identifier" enumeration is specified, the prefix-service-identifier should correspond to the unique identifier.
Otherwise, the resource cannot not be found.
Note 3: If the "name" enumeration is specified, then the prefix-service-identifier should correspond to the service name.
Otherwise, the resource cannot not be found.
Note 4: The read will default to the "identifier" type enumeration. As a result, the {prefix-service-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=identifier", is not required.

Representations

application/vnd.plcm.plcm-simplified-gateway-prefixes+xml
application/vnd.plcm.plcm-simplified-gateway-prefixes+json

Response

Status Representation Description
204 Simplified ISDN gateway prefix service was successfully updated.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Service Name is null.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Service Enabled flag is null.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
dialing-prefix is null.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
use-all-isdn-gateways flag is null.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA role required: administrator
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 gateway prefix service was not found.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
dialing-prefix is not valid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
use-all-isdn-gateways is false and selected-isdn-gateways is null/empty.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
selected isdn gateway is not a valid gateway.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
service identifier does not match the identifier associated with the resource.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
identifier in the URL does not match the identifier in the request body.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The gateway prefix service with provided name already exists.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid resource identifier type. Valid types are: [identifier,name]
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The request contained ETags in both the header and the body and they do not match.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The simplified ISDN gateway prefix service resource has been changed on the server.

Note: The response will contain the ETag value and link that reflects
the server's prefix service resource in the HTTP response header.

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-simplified-gateway-prefixes.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-simplified-gateway-prefixes.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.

DELETE


Deletes a simplified ISDN gateway prefix service resource on DMA.
[tags: DMA,RPRM]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
configured name or immutable, unique identifier such as a ID.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its configured name.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{prefix-service-identifier}?type={identifier|name}
Note 2: If the "identifier" enumeration is specified, the prefix-service-identifier should correspond to the unique identifier.
Otherwise, the resource cannot not be found.
Note 3: If the "name" enumeration is specified, then the prefix-service-identifier should correspond to the service name.
Otherwise, the resource cannot not be found.
Note 4: The read will default to the "identifier" type enumeration. As a result, the {prefix-service-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=identifier", is not required.

Response

Status Representation Description
204 simplified ISDN gateway prefix service resource was successfully deleted
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA role required: administrator
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 gateway prefix service was not found.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid resource identifier type. Valid types are: [identifier,name]