Prescriptions

PATCH /parties/{partyId}/prescriptions/{prescriptionId}

Changed on

Creates or Updates a prescription resource under a particular party.

Request

  • Base URL
    {endpoint}
  • Auth
    API key in header Authorization

Path parameters

partyIdstring required

Id of the associated party resource.

prescriptionIdstring required

Id of the prescription resource.

Query parameters

api-versionstring required

The requested API version

Request body

partyIdstring

Party Id.

prescriptionMapIdstring

Prescription map Id.

productCodestring

Product Code.

productNamestring

Product name.

typestring

Prescription type.

measurementsobject

Measures.

idstring

Unique resource ID.

eTagstring

The ETag value to implement optimistic concurrency.

statusstring

Status of the resource.

createdDateTimestring date-time

Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.

modifiedDateTimestring date-time

Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.

sourcestring

Source of the resource.

namestring

Name to identify resource.

descriptionstring

Textual description of the resource.

createdBystring

Created by user/tenant id.

modifiedBystring

Modified by user/tenant id.

propertiesobject

A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.

Example request

{
  "createdDateTime": "2020-12-31T11:10:21Z",
  "modifiedDateTime": "2020-12-31T11:10:21Z",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Response

Success

partyIdstring

Party Id.

prescriptionMapIdstring

Prescription map Id.

productCodestring

Product Code.

productNamestring

Product name.

typestring

Prescription type.

measurementsobject

Measures.

idstring

Unique resource ID.

eTagstring

The ETag value to implement optimistic concurrency.

statusstring

Status of the resource.

createdDateTimestring date-time

Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.

modifiedDateTimestring date-time

Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.

sourcestring

Source of the resource.

namestring

Name to identify resource.

descriptionstring

Textual description of the resource.

createdBystring

Created by user/tenant id.

modifiedBystring

Modified by user/tenant id.

propertiesobject

A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.

Example response

{
  "createdDateTime": "2020-12-31T11:10:21Z",
  "modifiedDateTime": "2020-12-31T11:10:21Z",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Changes