Entity Domain Resource

Entity Domain Resource

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:

<entities>

    <entity>

    <attributes>

        <attribute><datatype><name>string</name></datatype><name>familyName</name></attribute>

        <attribute><datatype><name>string</name></datatype><name>givenName</name></attribute>

        <attribute><datatype><name>date</name></datatype><name>dateOfBirth</name></attribute>

        <attribute><datatype><name>string</name></datatype><name>gender</name></attribute>

        <attribute><datatype><name>string</name></datatype><name>address1</name></attribute>

        <attribute><datatype><name>string</name></datatype><name>city</name></attribute>

        <attribute><datatype><name>string</name></datatype><name>state</name></attribute>

        <attribute><datatype><name>string</name></datatype><name>country</name></attribute>

        <attribute><datatype><name>string</name></datatype><name>postalCode</name></attribute>

    </attributes>

    <description>Updated the description of the entity</description>

    <entityVersionId>7650</entityVersionId>

    <name>person</name>

    </entity>

</entities>

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

 Parameters

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:

<entity>

    <attributes>

        <attribute><datatype><name>string</name></datatype><name>familyName</name></attribute>

        <attribute><datatype><name>string</name></datatype><name>givenName</name></attribute>

        <attribute><datatype><name>date</name></datatype><name>dateOfBirth</name></attribute>

        <attribute><datatype><name>string</name></datatype><name>gender</name></attribute>

        <attribute><datatype><name>string</name></datatype><name>address1</name></attribute>

        <attribute><datatype><name>string</name></datatype><name>city</name></attribute>

        <attribute><datatype><name>string</name></datatype><name>state</name></attribute>

        <attribute><datatype><name>string</name></datatype><name>country</name></attribute>

        <attribute><datatype><name>string</name></datatype><name>postalCode</name></attribute>

    </attributes>

    <description>Updated the description of the entity</description>

    <entityVersionId>7650</entityVersionId>

    <name>person</name>

</entity>

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