RESTful Interface Design for Entity Version

Entity Domain Resource

2 min read

On this page
  1. URL: /openempi-ws-rest/1.0/entities
  2. Methods
  3. Responses
  4. Example
  5. URL: /openempi-ws-rest/1.0/entities/${entityId}
  6.  Parameters
  7. Methods
  8. Responses
  9. Example
  10. URL: /openempi-ws-rest/1.0/entity-attributes/${entityId}
  11. Parameters
  12. Methods
  13. Responses
  14. Example

URL: /openempi-ws-rest/1.0/entities

Methods

GET

Returns the complete list of entity types 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

http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/entities

Return:

   

    

        stringfamilyName

        stringgivenName

        datedateOfBirth

        stringgender

        stringaddress1

        stringcity

        stringstate

        stringcountry

        stringpostalCode

    

    Updated the description of the entity

    7650

    person

   

URL: /openempi-ws-rest/1.0/entities/{entityId}

 Parameters

| Parameter

|

Value Type

|

Parameter Type

|

R/O

|

Description

| | --- | --- | --- | --- | --- | |

entityId

|

Integer

|

Path Parameter

| R |

The unique identifier of the entity of interest

|

Methods

GET

Returns detailed information about the entity identified by the parameter entityId.

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

Entity id is 7650

http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/entities/7650

Return:

    

        stringfamilyName

        stringgivenName

        datedateOfBirth

        stringgender

        stringaddress1

        stringcity

        stringstate

        stringcountry

        stringpostalCode

    

    Updated the description of the entity

    7650

    person

URL: /openempi-ws-rest/1.0/entity-attributes/{entityId}

Parameters

| Parameter

|

Value Type

|

Parameter Type

|

R/O

|

Description

| | --- | --- | --- | --- | --- | |

entityId

|

Integer

|

Path Parameter

| R |

The unique identifier of the entity of interest

|

Methods

GET

Returns the list of attributes associated with the entity identified by the parameter entityId.

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

Entity id is 7650.

http://localhost:8080/openempi-admin/openempi-ws-rest/1.0/entity-attributes/7650

Return:

    stringfamilyName

    stringgivenName

    datedateOfBirth

    stringgender

    stringaddress1

    stringcity

    stringstate

    stringcountry

    stringpostalCode

Up to Entity API Documentation