URL: /openempi-ws-rest/1.0/identifier-domains
Methods
GET
Returns the complete list of identifier domains that have been defined in the system.
Responses
-
200 - application/json - Returns a JSON representation of the response based on the Accept header
-
200 - application/xml - Returns an XML representation of the response based on the Accept header
-
404 - Returned if there are no entities defined in the system
Example
Version 1.0
http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/identifier-domains
Return:
URL: /openempi-ws-rest/1.0/identifier-domains/{identifierDomainId}
Parameters
| Parameter
|
Value Type
|
Parameter Type
|
R/O
|
Description
| | --- | --- | --- | --- | --- | |
identifierDomainId
|
Integer
|
Path Parameter
| R |
The unique identifier of the identifier domain of interest
|
Methods
GET
Returns detailed information about the identifier domain identified by the parameter identifierDomainId
Responses
-
200 - application/json - Returns a JSON representation of the response based on the Accept header
-
200 - application/xml - Returns an XML representation of the response based on the Accept header
-
404 - Returned if there is no entity known in the system with that entityId
Example
Version 1.0
Identifier domain id is 2750.
http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/identifier-domains/2750
Return:
URL(POST for add): /openempi-ws-rest/1.0/identifier-domains
Parameters
| Parameter
|
Value Type
|
Parameter Type
|
R/O
|
Description
| | --- | --- | --- | --- | --- | | identifierDomain | IdentifierDomain | Body | R | An IdentifierDomain object |
Methods
POST
Returns the newly added IdentifierDomain.
Responses
-
200 - application/json - Returns a JSON representation of the response based on the Accept header
-
200 - application/xml - Returns an XML representation of the response based on the Accept header
-
400 - Returned if there is a bad request.
-
409 - Returned if there is a record conflict in the system.
Example
Version 1.0
POST
http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/identifier-domains
Content-Type: application/xml
Body:
Return:
Content-Type: application/json
Body:
{ “dateCreated” : “2013-10-08”, “identifierDomainDescription” : “Test”, “identifierDomainName” : “Test-Domaon”, “namespaceIdentifier” : “Test-Domaon”, “universalIdentifier” : "", “universalIdentifierTypeCode” : "" }
Return:
{ “dateCreated” : “2013-10-08T13:17:21.881-04:00”, “identifierDomainDescription” : “Test”, “identifierDomainId” : “139”, “identifierDomainName” : “Test-Domaon”, “namespaceIdentifier” : “Test-Domaon”, “universalIdentifier” : "", “universalIdentifierTypeCode” : "" }
URL(PUT for update): /openempi-ws-rest/1.0/identifier-domains
Parameters
| Parameter
|
Value Type
|
Parameter Type
|
R/O
|
Description
| | --- | --- | --- | --- | --- | | identifierDomain | IdentifierDomain | Body | R | An IdentifierDomain object |
Methods
PUT
Returns the updated IdentifierDomain.
Responses
-
200 - application/json - Returns a JSON representation of the response based on the Accept header
-
200 - application/xml - Returns an XML representation of the response based on the Accept header
-
400 - Returned if there is a bad request.
-
409 - Returned if there is a record conflict in the system.
Example
Version 1.0
PUT
http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/identifier-domains
Content-Type: application/xml
Body:
Return:
Content-Type: application/json
Body:
{ “dateCreated” : “2013-10-08T13:17:21.881-04:00”, “identifierDomainDescription” : “Update”, “identifierDomainId” : “139”, “identifierDomainName” : “Update-Domaon”, “namespaceIdentifier” : “Update-Domaon”, “universalIdentifier” : "", “universalIdentifierTypeCode” : "" }
Return:
{ “dateCreated” : “2013-10-08T13:57:21.881-04:00”, “identifierDomainDescription” : “Update”, “identifierDomainId” : “139”, “identifierDomainName” : “Update-Domaon”, “namespaceIdentifier” : “Update-Domaon”, “universalIdentifier” : "", “universalIdentifierTypeCode” : "" }