Examples

PATCH /api/v2/premium-service-notes/16
{
  "data": {
    "id": "16",
    "type": "premium-service-notes",
    "attributes": {
      "note": "String",
      "created-at": "2018-01-24 09:59:47 +0800",
      "updated-at": "2018-01-24 09:59:47 +0800",
      "is-read": true
    },
    "relationships": {
      "account": {
        "data": {
          "type": "accounts",
          "id": 156
        }
      }
    }
  }
}
404
{
  "errors": [
    {
      "title": "Record not found",
      "detail": "The record identified by 16 could not be found.",
      "code": "404",
      "status": "404"
    }
  ]
}

Params

Param name Description
data
required

Premium Service Request Note information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][note]
optional

Notes related to the premium service request

Validations:

  • Must be a String

data[relationships]
optional

Validations:

  • Must be a Hash

data[relationships][premium_service_request]
optional

Validations:

  • Must be a Hash

data[relationships][premium_service_request][data]
optional

Validations:

  • Must be a Hash

data[relationships][premium_service_request][data][type]
optional

Should be `PremiumServiceRequest`

Validations:

  • Must be a String

data[relationships][premium_service_request][data][id]
optional

PremiumServiceRequest ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.