CampusAPI Acknowledgement Services API documentation version 0.1.0
Based on OSID version 3.0.0
https://base.url
Overview
The Acknowledgement service package defines and relates credits such as authors or creators to other entities.
This package includes the following entities:
Credits
Credits are relationships between what is being credited and to what the credit applies. The entity being credited is represented by a Resource. This service does not define the entity to which the credit applies and instead references an Id external to this service. The Id is a reference to an entity managed outside this service.
Resource is an abstract interface used for a variety of purposes including people. In the Acknowledgement service this has a very abstract feel whose primary focus is to manage the relationships.
The genus Type can be used to describe the nature of the relationship, such as a writer or photographer. The entity may be extended based on Type to capture additional data related to the relatonship itself.
Credits are mapped to Billings for organization. Billings can be managed hierarchically to federate multiple collections of Credits.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this credit, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this credit, provided by system. | string(uri) |
| displayName | The name of this credit for display. | string |
| description | The description of this credit. | string |
| genusTypeId (read‑only) | Id of the immutable type of this credit. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this credit. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| startDate | The starting date of this credit. | string(date‑time) |
| endDate | The ending date of this credit. | string(date‑time) |
| endReasonId | The reason this credit ended. References a process.State object. | string(osid‑id) |
| referenceId (read‑only) | The reference associated with this credit. References an id.Id object. | string(osid‑id) |
| resourceId (read‑only) | The resource associated with this credit. References a resource.Resource object. | string(osid‑id) |
Billings
Credits are mapped to Billings for organization. Billings can be managed hierarchically to federate multiple collections of Credits.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this billing, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this billing, provided by system. | string(uri) |
| displayName | The name of this billing for display. | string |
| description | The description of this billing. | string |
| genusTypeId (read‑only) | Id of the immutable type of this billing. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this billing. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| providerId | The provider of this billing. References a resource.Resource object. | string(osid‑id) |
| brandingIds | The branding of this billing. References repository.Asset objects. | string(osid‑id)[] |
| license | The licensing that applies to this billing. | string |
License
CampusAPI REST Definitions © 2025 by DXtera Institute - licensed under CC BY-ND 4.0 Based on the Open Service Interface Definitions: http://osid.org
/acknowledgement/credits
Collection of Credits in a system, federation of systems, or in a default Billing.
get
Get all Credits in the system or default Billing.
post
Create a new Credit in the default Billing.
get /acknowledgement/credits
Get all Credits in the system or default Billing.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - expand: (string)
Expand object or type for named attribute: "genusType", "recordType", "endReason", "reference", "resource", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.
Example:
all - keyword: (string)
The match string for keyword query
Example:
Hello%20World - displayName: (string)
The match string for displayName query
Example:
Hello%20World - description: (string)
The match string for description query
Example:
Hello%20World - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleCreditType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleCreditType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleCreditType%40campusapi.org - fromDate: (string)
Get all credits from this date inclusive. Use with toDate to define date range query.
Example:
2020-10-03 - toDate: (string)
Get all credits up to this date inclusive. Use with fromDate to define date range query.
Example:
2020-12-18 - referenceId: (string)
the id string to match a reference.
Example:
resource.Resource%3A432%40base.url - resourceId: (string)
the id string to match a resource.
Example:
resource.Resource%3A384%40base.url - billingId: (string)
The id string to match a billing
Example:
acknowledgement.Billing%3A8374%40base.url
HTTP status code 200
Headers
- x-total-count: required(number)
The total count of records currently available
Example:
152803
Body
Media type: application/json
Type: any
Example:
[
{
"id": "acknowledgement.Credit:579@base.url",
"uri": "http://base.url/open/campusapi/acknowledgement/credit/acknowledgement.Credit%3A579%40base.url",
"displayName": "Display Name of this Credit",
"description": "The description of this Credit",
"genusTypeId": "type.Type:defaultCreditType@base.url",
"recordTypeIds": [ "type.Type:exampleCreditRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:579@base.url",
"referenceId": "id.Id:2626@base.url",
"resourceId": "resource.Resource:7302@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /acknowledgement/credits
Create a new Credit in the default Billing.
Query Parameters
- billingId: (string)
specify in which billing to create this credit
Example:
acknowledgement.Billing%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Credit",
"type": "object",
"required": ["referenceId", "resourceId"],
"properties": {
"id": {
"description": "The unique id of this credit. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this credit. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this credit for display.",
"type": "string"
},
"description": {
"description": "The description of this credit.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this credit. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this credit. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"startDate": {
"description": "The starting date of this credit.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this credit.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this credit ended.",
"type": "string",
"format": "osid-id"
},
"referenceId": {
"description": "The reference associated with this credit.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"resourceId": {
"description": "The resource associated with this credit.",
"type": "string",
"format": "osid-id",
"readOnly": true
}
}
}Example:
{
"displayName": "Display Name of this Credit",
"description": "The description of this Credit",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:6471@base.url",
"referenceId": "id.Id:9435@base.url",
"resourceId": "resource.Resource:5264@base.url"
}
Query the collection of Credits in a system, federation of systems, or in a default billing by posting a Query object.
post
Submit a query using a CreditQuery object.
post /acknowledgement/credits/credit-query
Submit a query using a CreditQuery object.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - expand: (string)
Expand object or type for named attribute: "genusType", "recordType", "endReason", "reference", "resource", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.
Example:
all
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CreditQuery",
"type": "object",
"properties": {
"matchIds": {
"description": "List of Ids to match. Boolean OR performed among multiple Ids.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchKeywords": {
"description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
"type": "array",
"items": {
"type": "object",
"properties": {
"keyword": {
"description": "keyword to match",
"type": "string"
},
"stringMatchType": {
"description": "the string match type",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchDisplayNames": {
"description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
"type": "array",
"items": {
"type": "object",
"properties": {
"displayName": {
"description": "displayName to match",
"type": "string"
},
"stringMatchType": {
"description": "the string match type",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchDescriptions": {
"description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"description": "description to match",
"type": "string"
},
"stringMatchType": {
"description": "the string match type",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchGenusTypeIds": {
"description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
"type": "array",
"items": {
"type": "object",
"properties": {
"genusTypeid": {
"description": "genus type id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchRecordTypeIds": {
"description": "List of record type ids to match. Boolean OR performed among multiple ids.",
"type": "array",
"items": {
"type": "object",
"properties": {
"genusTypeid": {
"description": "record type id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchSubjectIds": {
"description": "List of Ids to match an object with a relationships to the given subjects.",
"type": "array",
"items": {
"type": "object",
"properties": {
"sponsorId": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchJournalEntryIds": {
"description": "List of Ids match objects that have the given journal entries.",
"type": "array",
"items": {
"type": "object",
"properties": {
"sponsorId": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"journalEntryQueries": {
"description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
"type": "array",
"items": {
"type": "journal-entry-query"
}
},
"matchEffective": {
"description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
"type": "boolean"
},
"matchStartDate": {
"description": "Matches temporals whose start date falls in between the given dates inclusive.",
"type": "object",
"properties": {
"start": {
"description": "start of date range",
"type": "string",
"format": "date-time"
},
"end": {
"description": "end of date range",
"type": "string",
"format": "date-time"
},
"match": {
"description": "true if a positive match, false for negative match",
"type": "boolean"
}
}
},
"matchEndDate": {
"description": "Matches temporals whose end date falls in between the given dates inclusive.",
"type": "object",
"properties": {
"start": {
"description": "start of date range",
"type": "string",
"format": "date-time"
},
"end": {
"description": "end of date range",
"type": "string",
"format": "date-time"
},
"match": {
"description": "true if a positive match, false for negative match",
"type": "boolean"
}
}
},
"matchEndReasonIds": {
"description": "List of end reason Id's to match.",
"type": "array",
"items": {
"type": "object",
"properties": {
"stateId": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"endReasonQueries": {
"description": "process.StateQueries to match end reason state. Each query performs a boolean OR.",
"type": "array",
"items": {
"type": "resource-query"
}
},
"matchAnyEndReason": {
"description": "Match end reasons with any value. true to match Credits with any end reason, false to match Credits with no end reason",
"type": "boolean"
},
"matchReferenceIds": {
"description": "List of reference Ids for this query to match credit that have a related reference.",
"type": "array",
"items": {
"type": "object",
"properties": {
"ruleId": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchResourceIds": {
"description": "List of resource Ids for this query to match credit that have a related resource.",
"type": "array",
"items": {
"type": "object",
"properties": {
"ruleId": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"resourceQueries": {
"description": "ResourceQueries to match the resource. Each query performs a boolean OR.",
"type": "array",
"items": {
"type": "resource-query"
}
},
"matchBillingIds": {
"description": "List of Billing Id's to match.",
"type": "array",
"items": {
"type": "object",
"properties": {
"billingId": {
"description": "Billing id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"billingQueries": {
"description": "BillingQueries to match Billing. Each query performs a boolean OR.",
"type": "array",
"items": {
"type": "billing-query"
}
}
}
}Example:
{
"matchDisplayNames": [
{
"displayName": "string to exclude",
"match": false
}
]
}HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "acknowledgement.Credit:579@base.url",
"uri": "http://base.url/open/campusapi/acknowledgement/credit/acknowledgement.Credit%3A579%40base.url",
"displayName": "Display Name of this Credit",
"description": "The description of this Credit",
"genusTypeId": "type.Type:defaultCreditType@base.url",
"recordTypeIds": [ "type.Type:exampleCreditRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:579@base.url",
"referenceId": "id.Id:2626@base.url",
"resourceId": "resource.Resource:7302@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post
Create multiple new CreditBatch in the default Billing.
post /acknowledgement/credits/credit-batch
Create multiple new CreditBatch in the default Billing.
Query Parameters
- billingId: (string)
specify in which billing to create this credit
Example:
acknowledgement.Billing%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CreditBatch",
"type": "array",
"Items": {
"type": "credit"
}
}Example:
[
{
"displayName": "Display Name of this Credit",
"description": "The description of this Credit",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:3615@base.url"
},
{
"...": "..."
}
]
Entity representing a Credit form metadata.
get
Get form metadata for creating a new Credit.
get /acknowledgement/credits/metadata
Get form metadata for creating a new Credit.
Query Parameters
- referenceId: required(string)
the reference of this metadatum.
Example:
resource.Resource%3A432%40base.url - resourceId: required(string)
the resource of this metadatum.
Example:
resource.Resource%3A384%40base.url - genusType: (string)
specify a particular credit type to create
Example:
type.Type%3AexampleCreditType%40dxtera.org - recordType: (array of )
specify support for one or more credit record types
Example:
[ "type.Type%3AexampleCreditRecordType%40campusapi.org", "..." ] - billingId: (string)
specify in which billing to create this credit
Example:
acknowledgement.Billing%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Credit",
"type": "object",
"required": ["referenceId", "resourceId"],
"properties": {
"id": {
"description": "The unique id of this credit, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this credit, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this credit for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Credit.Credit:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this credit",
"linked": false
},
"description": {
"description": "The description of this credit.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Credit.Credit:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this credit",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this credit. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this credit. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"startDate": {
"description": "The starting date of this credit.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Credit.Credit:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this credit",
"linked": false
},
"endDate": {
"description": "The ending date of this credit.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Credit.Credit:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this credit",
"linked": false
},
"endReasonId": {
"description": "The reason this credit ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Credit.Credit:endReason@base.url",
"existingValue": "process.State:1860@base.url",
"elementLabel": "End Reason",
"instructions": "Select the reason this credit ended",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a Credit
get
Get a particular Credit given its id.
put
Update a particular Credit given its id.
delete
Delete a particular Credit given its id.
get /acknowledgement/credits/{creditId}
Get a particular Credit given its id.
URI Parameters
- creditId: required(string)
Query Parameters
- expand: (string)
Expand object or type for named attribute: "genusType", "recordType", "endReason", "reference", "resource", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.
Example:
all
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "acknowledgement.Credit:579@base.url",
"uri": "http://base.url/open/campusapi/acknowledgement/credit/acknowledgement.Credit%3A579%40base.url",
"displayName": "Display Name of this Credit",
"description": "The description of this Credit",
"genusTypeId": "type.Type:defaultCreditType@base.url",
"recordTypeIds": [ "type.Type:exampleCreditRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:579@base.url",
"referenceId": "id.Id:2626@base.url",
"resourceId": "resource.Resource:7302@base.url"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "Credit not found" }
put /acknowledgement/credits/{creditId}
Update a particular Credit given its id.
URI Parameters
- creditId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CreditItem",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this credit. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this credit. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this credit for display.",
"type": "string"
},
"description": {
"description": "The description of this credit.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this credit. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this credit. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"startDate": {
"description": "The starting date of this credit.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this credit.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this credit ended.",
"type": "string",
"format": "osid-id"
},
"referenceId": {
"description": "The reference associated with this credit.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"resourceId": {
"description": "The resource associated with this credit.",
"type": "string",
"format": "osid-id",
"readOnly": true
}
}
}Example:
{
"displayName": "Display Name of this Credit",
"description": "The description of this Credit",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:2060@base.url"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The Credit has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "Credit not found" }
delete /acknowledgement/credits/{creditId}
Delete a particular Credit given its id.
URI Parameters
- creditId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The Credit has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "Credit not found" }
Entity representing a Credit form metadata for update
get
Get form metadata for updating an existing Credit.
get /acknowledgement/credits/{creditId}/metadata
Get form metadata for updating an existing Credit.
URI Parameters
- creditId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Credit",
"type": "object",
"required": ["referenceId", "resourceId"],
"properties": {
"id": {
"description": "The unique id of this credit, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this credit, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this credit for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Credit.Credit:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this credit",
"linked": false
},
"description": {
"description": "The description of this credit.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Credit.Credit:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this credit",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this credit. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this credit. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"startDate": {
"description": "The starting date of this credit.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Credit.Credit:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this credit",
"linked": false
},
"endDate": {
"description": "The ending date of this credit.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Credit.Credit:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this credit",
"linked": false
},
"endReasonId": {
"description": "The reason this credit ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Credit.Credit:endReason@base.url",
"existingValue": "process.State:1860@base.url",
"elementLabel": "End Reason",
"instructions": "Select the reason this credit ended",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "credit not found" }
/acknowledgement/billings
Collection of Billings in a system or federation of systems.
get
Get all Billings.
post
Create a new Billing.
get /acknowledgement/billings
Get all Billings.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - expand: (string)
Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.
Example:
all - keyword: (string)
The match string for keyword query
Example:
Hello%20World - displayName: (string)
The match string for displayName query
Example:
Hello%20World - description: (string)
The match string for description query
Example:
Hello%20World - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleBillingType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleBillingType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleBillingType%40campusapi.org - providerId: (string)
Id string to match provider.
Example:
resource.Resource%3A3007%40demo.dxtera.org - creditId: (string)
Get billings mapped to this credit.
Example:
acknowledgement.Credit%3A630%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "acknowledgement.Billing:5085@base.url",
"uri": "http://base.url/open/campusapi/acknowledgement/billing/acknowledgement.Billing%3A5085%40base.url",
"displayName": "Display Name of this Billing",
"description": "The description of this Billing",
"genusTypeId": "type.Type:defaultBillingType@base.url",
"recordTypeIds": [ "type.Type:exampleBillingRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Billing@base.url",
"license": "The license that applies to this Billing"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /acknowledgement/billings
Create a new Billing.
Query Parameters
- genusType: (string)
specify a particular billing type to create
Example:
type.Type%3AexampleBillingType%40dxtera.org - recordType: (array of )
specify support for one or more billing record types
Example:
[ "type.Type%3AexampleBillingRecordType%40campusapi.org", "..." ]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Billing",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this billing. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this billing. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this billing for display.",
"type": "string"
},
"description": {
"description": "The description of this billing.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this billing. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this billing. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this billing.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this billing. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this billing.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this Billing",
"description": "The description of this Billing",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Billing@base.url",
"license": "The license that applies to this Billing"
}
Query the collection of Billings in a system, federation of systems, or in a default billing by posting a Query object.
post
Submit a query using a BillingQuery object.
post /acknowledgement/billings/billing-query
Submit a query using a BillingQuery object.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - expand: (string)
Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.
Example:
all
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "BillingQuery",
"type": "object",
"properties": {
"matchIds": {
"description": "List of Ids to match. Boolean OR performed among multiple Ids.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchKeywords": {
"description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
"type": "array",
"items": {
"type": "object",
"properties": {
"keyword": {
"description": "keyword to match",
"type": "string"
},
"stringMatchType": {
"description": "the string match type",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchDisplayNames": {
"description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
"type": "array",
"items": {
"type": "object",
"properties": {
"displayName": {
"description": "displayName to match",
"type": "string"
},
"stringMatchType": {
"description": "the string match type",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchDescriptions": {
"description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"description": "description to match",
"type": "string"
},
"stringMatchType": {
"description": "the string match type",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchGenusTypeIds": {
"description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
"type": "array",
"items": {
"type": "object",
"properties": {
"genusTypeid": {
"description": "genus type id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchRecordTypeIds": {
"description": "List of record type ids to match. Boolean OR performed among multiple ids.",
"type": "array",
"items": {
"type": "object",
"properties": {
"genusTypeid": {
"description": "record type id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchSubjectIds": {
"description": "List of Ids to match an object with a relationships to the given subjects.",
"type": "array",
"items": {
"type": "object",
"properties": {
"sponsorId": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchJournalEntryIds": {
"description": "List of Ids match objects that have the given journal entries.",
"type": "array",
"items": {
"type": "object",
"properties": {
"sponsorId": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"journalEntryQueries": {
"description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
"type": "array",
"items": {
"type": "journal-entry-query"
}
},
"matchProviderIds": {
"description": "List of provider Ids to match.",
"type": "array",
"items": {
"type": "object",
"properties": {
"stateId": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"providerQueries": {
"description": "providerQueries to match the provider. Each query performs a boolean OR.",
"type": "array",
"items": {
"type": "resource-query"
}
},
"matchAnyProvider": {
"description": "Match providers with any value. true to match Billing with any provider, false to match Billing with no provider",
"type": "boolean"
},
"matchBrandingIds": {
"description": "List of branding asset Ids to match.",
"type": "array",
"items": {
"type": "object",
"properties": {
"stateId": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"brandingQueries": {
"description": "repository.AssetQueries to match the branding. Each query performs a boolean OR.",
"type": "array",
"items": {
"type": "asset-query"
}
},
"matchAnyBranding": {
"description": "Match brandingss with any value. true to match Billing with any branding, false to match Billing with no branding",
"type": "boolean"
},
"matchlicenses": {
"description": "List of license strings to match. Boolean OR performed among multiple descriptions.",
"type": "array",
"items": {
"type": "object",
"properties": {
"license": {
"description": "license to match",
"type": "string"
},
"stringMatchType": {
"description": "the string match type",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchBillingIds": {
"description": "List of Billing Id's to match.",
"type": "array",
"items": {
"type": "object",
"properties": {
"billingId": {
"description": "Billing id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"billingQueries": {
"description": "BillingQueries to match Billing. Each query performs a boolean OR.",
"type": "array",
"items": {
"type": "billing-query"
}
}
}
}Example:
{
"matchDisplayNames": [
{
"displayName": "string to exclude",
"match": false
}
]
}HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "acknowledgement.Billing:5085@base.url",
"uri": "http://base.url/open/campusapi/acknowledgement/billing/acknowledgement.Billing%3A5085%40base.url",
"displayName": "Display Name of this Billing",
"description": "The description of this Billing",
"genusTypeId": "type.Type:defaultBillingType@base.url",
"recordTypeIds": [ "type.Type:exampleBillingRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Billing@base.url",
"license": "The license that applies to this Billing"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a Billing form metadata.
get
Get form metadata for creating a new Billing.
get /acknowledgement/billings/metadata
Get form metadata for creating a new Billing.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Billing",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this billing, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this billing, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this billing for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Billing.Billing:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this billing",
"linked": false
},
"description": {
"description": "The description of this billing.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Billing.Billing:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this billing",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this billing. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this billing. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this billing.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Billing.Billing:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this billing",
"linked": false
},
"brandingIds": {
"description": "The branding of this billing. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Billing.Billing:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this billing",
"linked": false
},
"license": {
"description": "The licensing that applies to this billing.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Billing.Billing:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this billing",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
The root Billings in the Billing hierarchy. A node with no parents is an orphan. While all Billing Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
get
Get all root root-billings
get /acknowledgement/billings/root-billings
Get all root root-billings
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - expand: (string)
Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.
Example:
all
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "acknowledgement.Billing:5085@base.url",
"uri": "http://base.url/open/campusapi/acknowledgement/billing/acknowledgement.Billing%3A5085%40base.url",
"displayName": "Display Name of this Billing",
"description": "The description of this Billing",
"genusTypeId": "type.Type:defaultBillingType@base.url",
"recordTypeIds": [ "type.Type:exampleBillingRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Billing@base.url",
"license": "The license that applies to this Billing"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given Billing as a root in the Billing hierarchy
delete
Remove the given Billing as a root in the Billing hierarchy.
put /acknowledgement/billings/root-billings/{billingId}
Add the given Billing as a root in the Billing hierarchy
URI Parameters
- billingId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The Billing has been added as a root" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "Billing not found" }
delete /acknowledgement/billings/root-billings/{billingId}
Remove the given Billing as a root in the Billing hierarchy.
URI Parameters
- billingId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The Billing has been removed as a root from the hierarchy" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "Billing not found" }
get
Get parent Billings for the given Billing in the hierarchy.
get /acknowledgement/billings/root-billings/parents
Get parent Billings for the given Billing in the hierarchy.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - expand: (string)
Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.
Example:
all
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "acknowledgement.Billing:5085@base.url",
"uri": "http://base.url/open/campusapi/acknowledgement/billing/acknowledgement.Billing%3A5085%40base.url",
"displayName": "Display Name of this Billing",
"description": "The description of this Billing",
"genusTypeId": "type.Type:defaultBillingType@base.url",
"recordTypeIds": [ "type.Type:exampleBillingRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Billing@base.url",
"license": "The license that applies to this Billing"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
get
Get child Billings for the given Billing in the hierarchy.
get /acknowledgement/billings/root-billings/children
Get child Billings for the given Billing in the hierarchy.
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - expand: (string)
Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.
Example:
all
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "acknowledgement.Billing:5085@base.url",
"uri": "http://base.url/open/campusapi/acknowledgement/billing/acknowledgement.Billing%3A5085%40base.url",
"displayName": "Display Name of this Billing",
"description": "The description of this Billing",
"genusTypeId": "type.Type:defaultBillingType@base.url",
"recordTypeIds": [ "type.Type:exampleBillingRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Billing@base.url",
"license": "The license that applies to this Billing"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add Billing as child of the given Billing in the hierarchy.
delete
Remove the given Billing as a child of the given Billing in the hierarchy.
put /acknowledgement/billings/root-billings/children/{childId}
Add Billing as child of the given Billing in the hierarchy.
URI Parameters
- childId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The child Billing has been added to the hierarchy" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "billing not found" }
delete /acknowledgement/billings/root-billings/children/{childId}
Remove the given Billing as a child of the given Billing in the hierarchy.
Entity representing a Billing
get
Get a particular Billing given its id.
put
Update a particular Billing given its id.
delete
Delete a particular Billing given its id.
get /acknowledgement/billings/{billingId}
Get a particular Billing given its id.
URI Parameters
- billingId: required(string)
Query Parameters
- expand: (string)
Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.
Example:
all
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "acknowledgement.Billing:5085@base.url",
"uri": "http://base.url/open/campusapi/acknowledgement/billing/acknowledgement.Billing%3A5085%40base.url",
"displayName": "Display Name of this Billing",
"description": "The description of this Billing",
"genusTypeId": "type.Type:defaultBillingType@base.url",
"recordTypeIds": [ "type.Type:exampleBillingRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Billing@base.url",
"license": "The license that applies to this Billing"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "Billing not found" }
put /acknowledgement/billings/{billingId}
Update a particular Billing given its id.
URI Parameters
- billingId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "BillingItem",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this billing. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this billing. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this billing for display.",
"type": "string"
},
"description": {
"description": "The description of this billing.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this billing. Default type set by system unless specified in query parameter.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this billing. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this billing.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this billing. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this billing.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this Billing",
"description": "The description of this Billing",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Billing@base.url",
"license": "The license that applies to this Billing"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The Billing has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "Billing not found" }
delete /acknowledgement/billings/{billingId}
Delete a particular Billing given its id.
URI Parameters
- billingId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The Billing has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "Billing not found" }
Entity representing a Billing form metadata for update
get
Get form metadata for updating an existing Billing.
get /acknowledgement/billings/{billingId}/metadata
Get form metadata for updating an existing Billing.
URI Parameters
- billingId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Billing",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this billing, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this billing, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this billing for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Billing.Billing:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this billing",
"linked": false
},
"description": {
"description": "The description of this billing.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Billing.Billing:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this billing",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this billing. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this billing. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
},
"readOnly": true
},
"providerId": {
"description": "The provider of this billing.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Billing.Billing:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this billing",
"linked": false
},
"brandingIds": {
"description": "The branding of this billing. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Billing.Billing:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this billing",
"linked": false
},
"license": {
"description": "The licensing that applies to this billing.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Billing.Billing:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this billing",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "billing not found" }
get
Get all Credits in this Billing
get /acknowledgement/billings/{billingId}/credits
Get all Credits in this Billing
URI Parameters
- billingId: required(string)
Query Parameters
- offset: (integer - default: 0)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - expand: (string)
Expand object or type for named attribute: "genusType", "recordType", "endReason", "reference", "resource", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.
Example:
all - keyword: (string)
The match string for keyword query
Example:
Hello%20World - displayName: (string)
The match string for displayName query
Example:
Hello%20World - description: (string)
The match string for description query
Example:
Hello%20World - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleCreditType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleCreditType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleCreditType%40campusapi.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "acknowledgement.Credit:579@base.url",
"uri": "http://base.url/open/campusapi/acknowledgement/credit/acknowledgement.Credit%3A579%40base.url",
"displayName": "Display Name of this Credit",
"description": "The description of this Credit",
"genusTypeId": "type.Type:defaultCreditType@base.url",
"recordTypeIds": [ "type.Type:exampleCreditRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:579@base.url",
"referenceId": "id.Id:2626@base.url",
"resourceId": "resource.Resource:7302@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given Credit to this Billing
delete
Remove the given Credit from the Billing.
put /acknowledgement/billings/{billingId}/credits/{creditId}
Add the given Credit to this Billing
URI Parameters
- billingId: required(string)
- creditId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "Credit has been added to Billing" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "Credit not found" }
delete /acknowledgement/billings/{billingId}/credits/{creditId}
Remove the given Credit from the Billing.
URI Parameters
- billingId: required(string)
- creditId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "Credit has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "Credit not found" }
Define and inspect the CreditQuery related to a "smart" Billing. A smart Billing is a dynamic Billing whose cataloged objects are defined through queries.
post
Apply the provided CreditQuery to this Billing to create a dynamic smart Billing
get
Get the CreditQuery associated with this smart Billing.
post /acknowledgement/billings/{billingId}/credit-query
Apply the provided CreditQuery to this Billing to create a dynamic smart Billing
URI Parameters
- billingId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CreditQuery",
"type": "object",
"properties": {
"matchIds": {
"description": "List of Ids to match. Boolean OR performed among multiple Ids.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchKeywords": {
"description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
"type": "array",
"items": {
"type": "object",
"properties": {
"keyword": {
"description": "keyword to match",
"type": "string"
},
"stringMatchType": {
"description": "the string match type",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchDisplayNames": {
"description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
"type": "array",
"items": {
"type": "object",
"properties": {
"displayName": {
"description": "displayName to match",
"type": "string"
},
"stringMatchType": {
"description": "the string match type",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchDescriptions": {
"description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"description": "description to match",
"type": "string"
},
"stringMatchType": {
"description": "the string match type",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchGenusTypeIds": {
"description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
"type": "array",
"items": {
"type": "object",
"properties": {
"genusTypeid": {
"description": "genus type id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchRecordTypeIds": {
"description": "List of record type ids to match. Boolean OR performed among multiple ids.",
"type": "array",
"items": {
"type": "object",
"properties": {
"genusTypeid": {
"description": "record type id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchSubjectIds": {
"description": "List of Ids to match an object with a relationships to the given subjects.",
"type": "array",
"items": {
"type": "object",
"properties": {
"sponsorId": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchJournalEntryIds": {
"description": "List of Ids match objects that have the given journal entries.",
"type": "array",
"items": {
"type": "object",
"properties": {
"sponsorId": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"journalEntryQueries": {
"description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
"type": "array",
"items": {
"type": "journal-entry-query"
}
},
"matchEffective": {
"description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
"type": "boolean"
},
"matchStartDate": {
"description": "Matches temporals whose start date falls in between the given dates inclusive.",
"type": "object",
"properties": {
"start": {
"description": "start of date range",
"type": "string",
"format": "date-time"
},
"end": {
"description": "end of date range",
"type": "string",
"format": "date-time"
},
"match": {
"description": "true if a positive match, false for negative match",
"type": "boolean"
}
}
},
"matchEndDate": {
"description": "Matches temporals whose end date falls in between the given dates inclusive.",
"type": "object",
"properties": {
"start": {
"description": "start of date range",
"type": "string",
"format": "date-time"
},
"end": {
"description": "end of date range",
"type": "string",
"format": "date-time"
},
"match": {
"description": "true if a positive match, false for negative match",
"type": "boolean"
}
}
},
"matchEndReasonIds": {
"description": "List of end reason Id's to match.",
"type": "array",
"items": {
"type": "object",
"properties": {
"stateId": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"endReasonQueries": {
"description": "process.StateQueries to match end reason state. Each query performs a boolean OR.",
"type": "array",
"items": {
"type": "resource-query"
}
},
"matchAnyEndReason": {
"description": "Match end reasons with any value. true to match Credits with any end reason, false to match Credits with no end reason",
"type": "boolean"
},
"matchReferenceIds": {
"description": "List of reference Ids for this query to match credit that have a related reference.",
"type": "array",
"items": {
"type": "object",
"properties": {
"ruleId": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"matchResourceIds": {
"description": "List of resource Ids for this query to match credit that have a related resource.",
"type": "array",
"items": {
"type": "object",
"properties": {
"ruleId": {
"description": "id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"resourceQueries": {
"description": "ResourceQueries to match the resource. Each query performs a boolean OR.",
"type": "array",
"items": {
"type": "resource-query"
}
},
"matchBillingIds": {
"description": "List of Billing Id's to match.",
"type": "array",
"items": {
"type": "object",
"properties": {
"billingId": {
"description": "Billing id to match",
"type": "string",
"format": "osid-id"
},
"match": {
"description": "true for a positive match, false for a negative match",
"type": "boolean"
}
}
}
},
"billingQueries": {
"description": "BillingQueries to match Billing. Each query performs a boolean OR.",
"type": "array",
"items": {
"type": "billing-query"
}
}
}
}Example:
{
"matchDisplayNames": [
{
"displayName": "string to exclude",
"match": false
}
]
}get /acknowledgement/billings/{billingId}/credit-query
Get the CreditQuery associated with this smart Billing.
URI Parameters
- billingId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"matchDisplayNames": [
{
"displayName": "string to exclude",
"match": false
}
]
}HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "Billing not found" }