 | IHdsiServiceContract Interface |
Health Data Services Interface (HDSI)
Namespace: SanteDB.Rest.HDSI
Assembly: SanteDB.Rest.HDSI (in SanteDB.Rest.HDSI.dll) Version: 2.2.1
SyntaxThe IHdsiServiceContract type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AssociationCreate |
Assigns the child object as a child (or link) of the parent
|
| AssociationGet(String, String, String) |
Performs a linked or chained search on a sub-property
|
| AssociationGet(String, String, String, String) |
Performs a linked or chained search on a sub-property
|
| AssociationRemove(String, String, String) |
Removes a child resource instance from the parent container
|
| AssociationRemove(String, String, String, String) |
Removes a child resource instance from the parent container
|
| AssociationSearch(String, String) |
Performs a linked or chained search on a sub-property
|
| AssociationSearch(String, String, String) |
Performs a linked or chained search on a sub-property
|
| CheckIn |
Releases an edit lock on the specified object
|
| CheckOut |
Acquires an edit lock on the specified object
|
| Copy |
Downloads a copy of the specified resource and all dependent objects for the dCDR
|
| Create |
Creates the resource. If the resource already exists, then a 409 is thrown
|
| CreateUpdate |
Creates or updates a resource. That is, creates the resource if it does not exist, or updates it if it does
|
| Delete |
Deletes the specified resource from the server
|
| Get |
Retrieves the current version of the specified resource
|
| GetBarcode |
Gets the specified barcode for the resource
|
| GetPointer |
Gets the digitally signed pointer (in JWS format) for the resource
|
| GetSchema |
Get the schema of the HDSI API for use in code generation frameworks
|
| GetVersion |
Retrieves a specific version of the specified resource
|
| Head |
Retrieves only the metadata of the specified resource
|
| HeadSearch |
Perform a search (query) and return only the headers
|
| History |
Gets a complete history of all changes made to the specified resource
|
| InvokeMethod(String, String, ParameterCollection) |
Invokes the specified operation
|
| InvokeMethod(String, String, String, ParameterCollection) |
Invokes the specified operation
|
| Options |
Returns a service capability statement of the HDSI
|
| Patch |
Updates the specified resource according to the instructions in the PATCH file
|
| Ping |
Performs a minimal PING request to test service uptime
|
| ResolvePointer |
Resolve a code to a resource by posting a form-encoded search to the API
|
| ResourceOptions |
Returns specific options for a single resource
|
| Search |
Perform a search (query) for resourceType matching the HTTP query parameters provided
|
| Time |
Gets the current server time from the API allowing for time synchronization
|
| Touch |
Touch the resource (update its timestamp) without modifying the resource itself
|
| Update |
Updates the specified resource. If the resource does not exist than a 404 is thrown, if there is a conflict (such a mismatch of data) a 409 is thrown
|
RemarksThis contract represents necessary REST functions to interact with the SanteDB CDR
See Also