GET
Retrieves information about a VEQ.
[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 number or immutable, unique identifier such as a UID, integer, etc.
The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its configured number. Unfortunately, the number can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.
Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{veq-identifier}?type={identifier|number}
Note 2: If the "identifier" enumeration is specified, the the veq-identifier should correspond to the unique identifier.
Otherwise, the resource cannot not be found.
Note 3: If the "number" enumeration is specified, then the veq-identifier should correspond to the virtual entry queue number.
Otherwise, the resource cannot not be found.
Note 4: The read will default to the "identifier" type enumeration. As a result, the {veq-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=identifier", is not required.
|
Response
PUT
Updates information about a VEQ.
[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 number or immutable, unique identifier such as a UID, integer, etc.
The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its configured number. Unfortunately, the number can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.
Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{veq-identifier}?type={identifier|number}
Note 2: If the "identifier" enumeration is specified, the the veq-identifier should correspond to the unique identifier.
Otherwise, the resource cannot not be found.
Note 3: If the "number" enumeration is specified, then the veq-identifier should correspond to the virtual entry queue number.
Otherwise, the resource cannot not be found.
Note 4: The read will default to the "identifier" type enumeration. As a result, the {veq-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=identifier", is not required.
|
Representations
Response
DELETE
Deletes information about a virtual entry queue.
[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 number or immutable, unique identifier such as a UID, integer, etc.
The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its configured number. Unfortunately, the number can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.
Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{veq-identifier}?type={identifier|number}
Note 2: If the "identifier" enumeration is specified, the the veq-identifier should correspond to the unique identifier.
Otherwise, the resource cannot not be found.
Note 3: If the "number" enumeration is specified, then the veq-identifier should correspond to the virtual entry queue number.
Otherwise, the resource cannot not be found.
Note 4: The read will default to the "identifier" type enumeration. As a result, the {veq-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=identifier", is not required.
|
Response
|