Examples

POST /api/v2/premium-service-notes
{
  "data": {
    "type": "premium-service-notes",
    "attributes": {
      "note": "String",
      "created-at": null,
      "updated-at": null,
      "is-read": null
    },
    "relationships": {
      "premium-service-request": {
        "data": {
          "type": "premium-service-requests",
          "id": 52
        }
      }
    }
  }
}
201
{
  "data": {
    "id": "13",
    "type": "premium-service-notes",
    "links": {
      "self": "http://test.host/api/v2/premium-service-notes/13"
    },
    "attributes": {
      "note": "String",
      "created-at": "2018-01-24T09:59:45.564+08:00",
      "updated-at": "2018-01-24T09:59:45.564+08:00",
      "is-read": true
    },
    "relationships": {
      "premium-service-request": {
        "links": {
          "self": "http://test.host/api/v2/premium-service-notes/13/relationships/premium-service-request",
          "related": "http://test.host/api/v2/premium-service-notes/13/premium-service-request"
        }
      },
      "account": {
        "links": {
          "self": "http://test.host/api/v2/premium-service-notes/13/relationships/account",
          "related": "http://test.host/api/v2/premium-service-notes/13/account"
        }
      }
    }
  }
}

Params

Param name Description
data
required

Premium Service Request Note information

Validations:

  • Must be a Hash

data[type]
required

Validations:

data[attributes]
required

Validations:

  • Must be a Hash

data[attributes][note]
required

Notes related to the premium service request

Validations:

  • Must be a String

data[relationships]
required

Validations:

  • Must be a Hash

data[relationships][premium_service_request]
required

Validations:

  • Must be a Hash

data[relationships][premium_service_request][data]
required

Validations:

  • Must be a Hash

data[relationships][premium_service_request][data][type]
required

Should be `PremiumServiceRequest`

Validations:

  • Must be a String

data[relationships][premium_service_request][data][id]
required

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.