This topic describes the entity and type representations for common items that the Gift Batch API uses. To learn about how to set up your developer account and work with the SKY API, see the Getting Started guide.
A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807.
The BadRequestResponseProblemDetails entity has the following properties:
| Property | Required | Type | Description | Description | |||||
|---|---|---|---|---|---|---|---|---|---|
| type | Property is required | string string | A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". Available values:
| ||||||
| title | Property is required | string string | A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4). | ||||||
| status | Property is required | integer integer | The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. | ||||||
| detail | Property is required | string string | A human-readable explanation specific to this occurrence of the problem. | ||||||
| instance | Property is required | string string | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. | ||||||
| trace_id | Property is required | string string | A request ID that can be provided to Blackbaud Support that may help with further troubleshooting. | ||||||
| span_id | Property is required | string string | A request ID that can be provided to Blackbaud Support that may help with further troubleshooting. |
Defines fields for a batch to be added to the data store
The CreateBatch entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| batch_description | Property is required | string string | The description of the batch. | |
| batch_number | Property is required | string string | The unique ID specific to the batch. | |
| expected_batch_total | Property is required | double double | The total value of all gifts the batch is expected to contain. | |
| expected_number | Property is required | integer integer | The total number of gifts the batch is expected to contain. |
Defines fields returned when a batch is created
The CreatedBatch entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| batch_id | Property is required | string string | The immutable system record ID of the created batch. |
Represents the gift batch object
The GiftBatch entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| id | Property is required | string string | The batch identifier | |
| actual_amount | Property is required | double double | The actual batch amount | |
| batch_description | Property is required | string string | The batch description | |
| batch_number | Property is required | string string | The batch number | |
| added_by | Property is required | string string | The user who created the batch | |
| date_added | Property is required | datetime datetime | The date the batch was created. Includes an offset from UTC in ISO-8601 format: 1969-11-21T10:29:43-04:00. | |
| has_exceptions | Property is required | boolean boolean | Indicates whether the batch has exceptions | |
| approved | Property is required | boolean boolean | Indicates whether the batch is approved | |
| number_of_gifts | Property is required | integer integer | The actual number of gifts in the batch | |
| projected_amount | Property is required | double double | The projected amount | |
| projected_number_of_gifts | Property is required | integer integer | The projected number of gifts |
Represents a collection of gift batches
The GiftBatchCollection entity has the following properties:
| Property | Required | Type | Description | Description |
|---|---|---|---|---|
| count | Property is required | integer integer | The number of batch records included in the response. | |
| giftbatches | Property is required | array of giftbatch array of giftbatch | Represents the gift batch object | |
| limit | Property is required | integer integer | Limit used for the request. | |
| offset | Property is required | integer integer | Offset used for the request. |