Designing a request payload

The basic structure for a request payload that creates a single resource is:

{
  "data": {
    "attributes": {
      <field/value pairs are specified here>
    }
  }
}

For example, this request payload could be used to create a note:

{
  "data": {
    "attributes": {
      "subject": "Main contact vacation",
      "body": "Rodney is on vacation in June. Direct urgent questions to Sarah Jackson.",
      "confidential": false,
      "topic": {
        "code": "general"
      }
    }
  }
}

In some situations, you can create an object using an "empty body" (a body that specifies no values). An object created in this way will contain only default values. In these situations, the payload has an empty attributes section:

{
  "data": {
    "attributes": {
    }
  }
}

For most types of business objects, there are a set of fields that you must specify when creating that type of object. For example:

• To create an activity, the only required field is activityPattern.
• To create a document, the required fields are name, status, and type.
• To create a note, the only required field is body.

It is typically not possible to determine the minimum required fields from the API definition. This is because the minimum required fields are often enforced not by Cloud API but rather by PolicyCenter. The easiest way to determine the minimum required fields is to refer to this documentation. For example:

• The minimum required fields for activities are documented in Activities.
• The minimum required fields for activities are documented in Documents.
• The minimum required fields for activities are documented in Notes.

The documentation also provides examples for how to create various types of business objects and information on any requirements or behaviors unique to that type of object.

Scalar values follow these patterns:

For scalars, the formats for values are the same for request payloads and response payloads. For a given field, you can use its format in a response payload as a model for how to build a request payload.

InsuranceSuite includes several datatypes where multiple values are stored as a unit. This includes the following:

• Typekey (containing a code and a name)
• MonetaryAmount and CurrencyAmount (containing a currency and an amount)
• SpatialPoint (containing a longitude coordinate and a latitude coordinate)

"assignmentStatus": {
  "code": "assigned",
  "name": "Assigned"
}

"field": {
  "code": "value"
}

"priority": {
  "code": "urgent"
}

"field": {
  "amount": "amountValue",
  "currency": "currencyCode"
}

"transactionAmount": {
  "amount": "500.00",
  "currency": "usd"
}

"field": {
  "longitude": "coordinateValue",
  "latitude": "coordinateValue"
}

"coordinates": {
  "longitude": "-122.26842",
  "latitude": "37.55496"
}

To set the value of a field to null, use the following syntax:

To set the value of an object to null, specify the null at the object field level. For example, a user can optionally have a home phone number. The following explicitly states that the home phone number is null:

"homePhone": null

To set a typekey to null, specify the null at the typekey field level. (Do not specify the null at the code level.) For example, the following sets a document's language field to null:

"language": null

To set a monetary amount, currency amount, or spatial point to null, specify the null at the field level. (Do not specify the null at the amount, currency, longitude, or latitude level.) For example, the following sets a transactionAmount field to null:

"transactionAmount": null