POST api/patients/{patientId}/actions?createDate={createDate}

Creates a new action. The newly created action is returned to the App to work with i.e. Must have a valid Authorization header. NOTE : API Version 1.1 The API Version 1.0 of this method does not have parameter CreateDate

Request Information

URI Parameters

NameDescriptionTypeAdditional information
patientId

The patient id

 integer

Required
createDate

OPTIONAL : Used to set the CreateDate for the action. If empty, the current time will be used.

 string

Required

Body Parameters

The action to be created and saved.

Action
NameDescriptionTypeAdditional 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.

Request Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "ActionGUID": "efa3c910-b17d-40ed-ac3d-3c164461a152",
  "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": "12d06f2a-3c95-4ebd-b463-5581986f445a",
  "UserGUID": "c78c0934-3f2b-445b-89c2-aa0804cf4250",
  "PatientGUID": "fcfda516-ea88-44e1-9269-e562acc34f3d"
}

application/xml, text/xml

Sample: 
<Action xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Himsa.Noah.Public.Model">
  <PatientGUID>fcfda516-ea88-44e1-9269-e562acc34f3d</PatientGUID>
  <ActionGUID>efa3c910-b17d-40ed-ac3d-3c164461a152</ActionGUID>
  <ActionGroup>sample string 10</ActionGroup>
  <ActionGroupGUID>12d06f2a-3c95-4ebd-b463-5581986f445a</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>c78c0934-3f2b-445b-89c2-aa0804cf4250</UserGUID>
  <UserInitials>sample string 13</UserInitials>
</Action>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The newly action created action

Action
NameDescriptionTypeAdditional 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

Sample: 
{
  "Id": 1,
  "ActionGUID": "4d4e9e31-12ab-42bd-8a95-67d141de2cbe",
  "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": "a8bdaaa9-fcea-45d8-b7c9-8c62053be691",
  "UserGUID": "29cc0b6f-3586-4ef3-9c88-2eff8cb11603",
  "PatientGUID": "6bd46c8c-bab5-4f8a-8433-7f298101854d"
}

application/xml, text/xml

Sample: 
<Action xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Himsa.Noah.Public.Model">
  <PatientGUID>6bd46c8c-bab5-4f8a-8433-7f298101854d</PatientGUID>
  <ActionGUID>4d4e9e31-12ab-42bd-8a95-67d141de2cbe</ActionGUID>
  <ActionGroup>sample string 10</ActionGroup>
  <ActionGroupGUID>a8bdaaa9-fcea-45d8-b7c9-8c62053be691</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>29cc0b6f-3586-4ef3-9c88-2eff8cb11603</UserGUID>
  <UserInitials>sample string 13</UserInitials>
</Action>