Vertical Service Cdes

[tags: DMA]

Resource Root

https://localhost:8443/api/rest/vertical-service-codes

Summary

Resources	Methods
https://localhost:8443/api/rest/vertical-service-codes	GET Retrieves a list of vertical service codes configured in system.
https://localhost:8443/api/rest/vertical-service-codes/{vertical-service-code-identifier}	GET Retrieves information about a vertical service code. PUT Updates a vertical service code.

Resources

https://localhost:8443/api/rest/vertical-service-codes

Methods

GET

Retrieves a list of vertical service codes configured in system.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-vertical-service-code-list+xml application/vnd.plcm.plcm-vertical-service-code-list+json	Vertical Service Codes retrieved successfully.
304		Vertical Serivce Codes information has not changed since the last search. Note: The API client must provide the "plcm-vertical-service-code-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-vertical-service-code-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 vertical service codes 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.

https://localhost:8443/api/rest/vertical-service-codes/{vertical-service-code-identifier}

Template Parameters

Name	Type	Description
vertical-service-code-identifier	xs:string	Unique identifier of the vertical service code resource.

Methods

GET

Retrieves information about a vertical service code.
[tags: DMA]

Request

Response

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

PUT

Updates a vertical service code.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-vertical-service-code+xml

application/vnd.plcm.plcm-vertical-service-code+json

Response

Status	Representation	Description
204		Vertical service code was successfully updated.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	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	Code 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 vertical service code was not found.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	code not valid.
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	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 vertical service code resource has been changed on the server. Note: The response will contain the ETag value and link that reflects the server's vertical service code 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-vertical-service-code.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-vertical-service-code.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.