Notification ResourceURL: /openempi-ws-rest/1.0/notifications/getNotificationCountMethodsGET Returns the count of notifications. ResponsesExampleVersion 1.0 http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/notifications/getNotificationCount Return: 2 URL: /openempi-ws-rest/1.0/notificationsParameter | Value Type | Parameter Type | R/O | Description |
---|
firstResult | Integer | Query Parameter | O | The number of notifications to skip before the first result notification | maxResults | Integer | Query Parameter | O | The maximum number of notifications that should be returned | removeRecords | Boolean | Query Parameter | O | Used to indicate that notifications retrieved will be removed |
Methods
GET Returns the list of notifications that have been defined in the system. ResponsesExampleVersion 1.0 http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/notifications Return: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <identifierUpdateEvents> <identifierUpdateEvent> <dateCreated>2013-10-15T00:00:00-04:00</dateCreated> <identifierUpdateEventId>14</identifierUpdateEventId> <postUpdateIdentifiers> <postUpdateIdentifier> <identifier>John</identifier> <identifierDomain> <dateCreated>2012-11-09T09:16:52.929-05:00</dateCreated> <identifierDomainDescription>NIST2010</identifierDomainDescription> <identifierDomainId>2450</identifierDomainId> <identifierDomainName>NIST2010</identifierDomainName> <namespaceIdentifier>NIST2010</namespaceIdentifier> <universalIdentifier>2.16.840.1.113883.3.72.5.9.1</universalIdentifier> <universalIdentifierTypeCode>ISO</universalIdentifierTypeCode> </identifierDomain> </postUpdateIdentifier> <postUpdateIdentifier> <identifier>d6cf4470-3800-11e3-a301-e069954d612d</identifier> <identifierDomain> <dateCreated>2012-02-10T13:44:24.755-05:00</dateCreated> <identifierDomainDescription>OpenEMPI Domain</identifierDomainDescription> <identifierDomainId>56</identifierDomainId> <identifierDomainName>2.16.840.1.113883.4.357</identifierDomainName> <namespaceIdentifier>2.16.840.1.113883.4.357</namespaceIdentifier> <universalIdentifier>2.16.840.1.113883.4.357</universalIdentifier> <universalIdentifierTypeCode>hl7</universalIdentifierTypeCode> </identifierDomain> </postUpdateIdentifier> </postUpdateIdentifiers> <preUpdateIdentifiers /> <source>ADD</source> <transition>JOIN</transition> </identifierUpdateEvent> <identifierUpdateEvent> <dateCreated>2013-10-18T00:00:00-04:00</dateCreated> <identifierUpdateEventId>15</identifierUpdateEventId> <postUpdateIdentifiers> <postUpdateIdentifier> <identifier>John</identifier> <identifierDomain> <dateCreated>2012-11-09T09:16:52.929-05:00</dateCreated> <identifierDomainDescription>NIST2010</identifierDomainDescription> <identifierDomainId>2450</identifierDomainId> <identifierDomainName>NIST2010</identifierDomainName> <namespaceIdentifier>NIST2010</namespaceIdentifier> <universalIdentifier>2.16.840.1.113883.3.72.5.9.1</universalIdentifier> <universalIdentifierTypeCode>ISO</universalIdentifierTypeCode> </identifierDomain> </postUpdateIdentifier> <postUpdateIdentifier> <identifier>d6cf4470-3800-11e3-a301-e069954d612d</identifier> <identifierDomain> <dateCreated>2012-02-10T13:44:24.755-05:00</dateCreated> <identifierDomainDescription>OpenEMPI Domain</identifierDomainDescription> <identifierDomainId>56</identifierDomainId> <identifierDomainName>2.16.840.1.113883.4.357</identifierDomainName> <namespaceIdentifier>2.16.840.1.113883.4.357</namespaceIdentifier> <universalIdentifier>2.16.840.1.113883.4.357</universalIdentifier> <universalIdentifierTypeCode>hl7</universalIdentifierTypeCode> </identifierDomain> </postUpdateIdentifier> </postUpdateIdentifiers> <preUpdateIdentifiers /> <source>UPDATE</source> <transition>JOIN</transition> </identifierUpdateEvent> </identifierUpdateEvents> http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/notifications?firstRecord=1&maxRecords=1 Return: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <identifierUpdateEvents> <identifierUpdateEvent> <dateCreated>2013-10-18T00:00:00-04:00</dateCreated> <identifierUpdateEventId>15</identifierUpdateEventId> <postUpdateIdentifiers> <postUpdateIdentifier> <identifier>John</identifier> <identifierDomain> <dateCreated>2012-11-09T09:16:52.929-05:00</dateCreated> <identifierDomainDescription>NIST2010</identifierDomainDescription> <identifierDomainId>2450</identifierDomainId> <identifierDomainName>NIST2010</identifierDomainName> <namespaceIdentifier>NIST2010</namespaceIdentifier> <universalIdentifier>2.16.840.1.113883.3.72.5.9.1</universalIdentifier> <universalIdentifierTypeCode>ISO</universalIdentifierTypeCode> </identifierDomain> </postUpdateIdentifier> <postUpdateIdentifier> <identifier>d6cf4470-3800-11e3-a301-e069954d612d</identifier> <identifierDomain> <dateCreated>2012-02-10T13:44:24.755-05:00</dateCreated> <identifierDomainDescription>OpenEMPI Domain</identifierDomainDescription> <identifierDomainId>56</identifierDomainId> <identifierDomainName>2.16.840.1.113883.4.357</identifierDomainName> <namespaceIdentifier>2.16.840.1.113883.4.357</namespaceIdentifier> <universalIdentifier>2.16.840.1.113883.4.357</universalIdentifier> <universalIdentifierTypeCode>hl7</universalIdentifierTypeCode> </identifierDomain> </postUpdateIdentifier> </postUpdateIdentifiers> <preUpdateIdentifiers /> <source>UPDATE</source> <transition>JOIN</transition> </identifierUpdateEvent> </identifierUpdateEvents> URL: /openempi-ws-rest/1.0/notifications/retrieveNotificationsByDateParameter | Value Type | Parameter Type | R/O | Description |
---|
date | Date | Query Parameter | R | The date is used as search criteria. The notification which date is after the date of parameter will be retrieved | removeRecords | Boolean | Query Parameter | O | Used to indicate that notifications retrieved will be removed | endDate | Date | Query Parameter | O | Limits the events retrieved to only those that occurred before the end date (starting with version 3.5.9 and 3.6.2) | source | String | Query Parameter | O | Limits the events retrieved to only those that match the specific source type specified. Valid values for the source event type include 'ADD', 'DELETE','UPDATE','LINK','UNLINK','MERGE','UNMERGE' (starting with version 3.5.9 and 3.6.2) | transition | String | Query Parameter | O | Limits the events retrieved to only those that match the specific transition type specified. Valid values for the transition type include 'JOIN' and 'LEAVE' (starting with version 3.5.9 and 3.6.2) |
Methods
GET Returns the list of notifications specified that match the query criteria date provided in the request. ResponsesExampleVersion 1.0 http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/notifications/retrieveNotificationsByDate?date=2013-10-15 Return: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <identifierUpdateEvents> <identifierUpdateEvent> <dateCreated>2013-10-18T00:00:00-04:00</dateCreated> <identifierUpdateEventId>15</identifierUpdateEventId> <postUpdateIdentifiers> <postUpdateIdentifier> <identifier>John</identifier> <identifierDomain> <dateCreated>2012-11-09T09:16:52.929-05:00</dateCreated> <identifierDomainDescription>NIST2010</identifierDomainDescription> <identifierDomainId>2450</identifierDomainId> <identifierDomainName>NIST2010</identifierDomainName> <namespaceIdentifier>NIST2010</namespaceIdentifier> <universalIdentifier>2.16.840.1.113883.3.72.5.9.1</universalIdentifier> <universalIdentifierTypeCode>ISO</universalIdentifierTypeCode> </identifierDomain> </postUpdateIdentifier> <postUpdateIdentifier> <identifier>d6cf4470-3800-11e3-a301-e069954d612d</identifier> <identifierDomain> <dateCreated>2012-02-10T13:44:24.755-05:00</dateCreated> <identifierDomainDescription>OpenEMPI Domain</identifierDomainDescription> <identifierDomainId>56</identifierDomainId> <identifierDomainName>2.16.840.1.113883.4.357</identifierDomainName> <namespaceIdentifier>2.16.840.1.113883.4.357</namespaceIdentifier> <universalIdentifier>2.16.840.1.113883.4.357</universalIdentifier> <universalIdentifierTypeCode>hl7</universalIdentifierTypeCode> </identifierDomain> </postUpdateIdentifier> </postUpdateIdentifiers> <preUpdateIdentifiers /> <source>UPDATE</source> <transition>JOIN</transition> </identifierUpdateEvent> </identifierUpdateEvents> URL(DELETE for remove): /openempi-ws-rest/1.0/notificationsDelete the notification in the database. Parameter | Value Type | Parameter Type | R/O | Description |
---|
notificationId | Long | Path Parameter | R | The unique identifier of the notification |
MethodsDELETE Returns no content if delete successfully. Responses200 - 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 cannot find the notification to be deleted by notificationId - 409 - Returned if there is some conflict in the system
ExampleVersion 1.0 http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/notifications/14 Return: No content if delete successfully |