GET api/patients/{patientid}/sessions/{sessionid}/actions/{actionid}?format={format}
Retrieves a specific action. Must have a valid Authorization header. If public data are to be converted before it's returned then specify the wanted format in the format parameter. If left empty (null) no conversion will be made. If there is no converter available the a response code 400 are returned together with an Extended error info code 60213.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| patientid |
The patient id |
integer |
Required |
| sessionid |
The session id |
integer |
Required |
| actionid |
The action id |
integer |
Required |
| format |
Wanted data format. |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
The action for the specific actionid. With Public and Private Data.
Action| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Get the ID of the Action. Controlled by Noah. Set 0 when calling NewAction. |
integer |
None. |
| ActionGUID |
Get the GUID of the Action. |
globally unique identifier |
None. |
| SessionID |
Get the session ID that the action belongs to. Controlled by Noah. Set 0 when calling NewAction. |
integer |
None. |
| CreateDate |
Get the date of creation. (Format : yyyy-MM-ddTHH:mm:ssZ). Controlled by Noah |
string |
None. |
| ModuleID |
The ID of the module that created the Action. (Is composed as Hi word ManufactuerID and low word ModuleID). |
integer |
None. |
| Description |
The Modules description of the Action (min. 1, max. 64 characters). |
string |
None. |
| DataTypeCode |
The DataType of the Action. |
integer |
None. |
| DataFmtStd |
The Standard format for the Public Data. |
integer |
None. |
| DataFmtExt |
A module specific value. (Could be format of private data). |
integer |
None. |
| ActionGroup |
The datetime of the ActionGroup that the action belongs to. (Format yyyy-MM-ddTHH:mm:ssZ) (Empty string is no actiongroup). |
string |
None. |
| DeviceType |
DeviceType of the action. |
integer |
None. |
| LastModifiedDate |
The date when the action was last modified. (Format : yyyy-MM-ddTHH:mm:ssZ). Controlled by Noah |
string |
None. |
| UserInitials |
UserInitials of the user that created the action. (max 3 characters) ??? if not found. Controlled by Noah. |
string |
None. |
| ActionReferences |
Action references. |
Collection of integer |
None. |
| PublicData |
PublicData. Content only returned in GetAction. Otherwise this wil be null. When using New or Put Action to add the following rules apply. If publicData is null nothing are done to the public data in the database. If publicData is byte[0] the public data will be deleted from the database. else publicData are put to the database. |
Collection of byte |
None. |
| PrivateData |
PrivateData. Content only returned in GetAction. Otherwise this wil be null. When using New or Put Action to add the following rules apply. If PrivateData is null nothing are done to the public data in the database. If PrivateData is byte[0] the public data will be deleted from the database. else PrivateData are put to the database. |
Collection of byte |
None. |
| ActionGroupGUID |
ActionGroupGUID. The Guid is a unique identification of group of actions. Controlled by Noah. |
globally unique identifier |
None. |
| UserGUID |
UserGUID. The Guid is a unique identification of a user. Controlled by Noah. |
globally unique identifier |
None. |
| PatientGUID |
Patient Guid. The guid is a unique identification of the object/record in the database together with a patient id.. Controlled by Noah. When calling NewAction and UpdateAction this value must be set from the Patient object received from Noah when selecting a patient. In the following work flow patient data is not necessary to copy. Call GetAction edit the action and Update the action. |
globally unique identifier |
None. |
Response Formats
application/json, text/json
{
"Id": 1,
"ActionGUID": "3a366044-acce-4673-a788-5b6d581926c3",
"SessionID": 3,
"CreateDate": "sample string 4",
"ModuleID": 5,
"Description": "sample string 6",
"DataTypeCode": 7,
"DataFmtStd": 8,
"DataFmtExt": 9,
"ActionGroup": "sample string 10",
"DeviceType": 11,
"LastModifiedDate": "sample string 12",
"UserInitials": "sample string 13",
"ActionReferences": [
1,
2
],
"PublicData": "QEA=",
"PrivateData": "QEA=",
"ActionGroupGUID": "cfe18a7b-9951-4c03-993b-548aafe85a94",
"UserGUID": "9ea77fc4-d29e-4c7c-a8f4-77db3da886bf",
"PatientGUID": "3c4e0b43-ab2c-432c-820e-87ed1e49e42d"
}
application/xml, text/xml
<Action xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Himsa.Noah.Public.Model">
<PatientGUID>3c4e0b43-ab2c-432c-820e-87ed1e49e42d</PatientGUID>
<ActionGUID>3a366044-acce-4673-a788-5b6d581926c3</ActionGUID>
<ActionGroup>sample string 10</ActionGroup>
<ActionGroupGUID>cfe18a7b-9951-4c03-993b-548aafe85a94</ActionGroupGUID>
<ActionReferences xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</ActionReferences>
<CreateDate>sample string 4</CreateDate>
<DataFmtExt>9</DataFmtExt>
<DataFmtStd>8</DataFmtStd>
<DataTypeCode>7</DataTypeCode>
<Description>sample string 6</Description>
<DeviceType>11</DeviceType>
<Id>1</Id>
<LastModifiedDate>sample string 12</LastModifiedDate>
<ModuleID>5</ModuleID>
<PrivateData>QEA=</PrivateData>
<PublicData>QEA=</PublicData>
<SessionID>3</SessionID>
<UserGUID>9ea77fc4-d29e-4c7c-a8f4-77db3da886bf</UserGUID>
<UserInitials>sample string 13</UserInitials>
</Action>