New Service Contract Description Template
- Patrick Schmitz (Unlicensed)
- Tom Jones
Owned by Patrick Schmitz (Unlicensed)
E.g.: CollectionObject Service
Unable to render {include} The included page could not be found.
Note:
Use this template to create new Service Description pages. Note that you must copy the wiki source, and may have to much of your editing in the wiki source as well. Formatting, ID attributes and class attributes are essential to the functioning of the workflow.
On this page, we use a stripped down CollectionObject example to indicate some of the kinds of things that go where.
See these notes on what a service description should contain.
| ServiceName | |
| "Dev" or version number | Release Notes/History |
| If there is another service (e.g., from KSS) upon which this is based, please document and link to that here. | |
| List major dependencies of this service -e.g., other services, message entities, authentication tokes, etc. | |
Error rendering macro 'excerpt-include' : No link could be created for 'collectionspace:New Service Description and Assumptions Page'.
References
New Service Description and Assumptions
New Service Entity Diagrams
Operations
Unable to render {include} The included page could not be found.
Setup
Dictionary Operations
Links to the methods defined below, by name, e.g.:
#getObjectTypes
Search Operations
Links to the methods defined below, by name, e.g.:
#getSearchTypes
Domain Operations
Links to the methods defined below, by name, e.g.:
#getCollObject
Read
Links to the methods defined below, by name, e.g.:
#validateCollObject
Search
Links to the methods defined below, by name, e.g.:
#searchForResults
Maintenance
Links to the methods defined below, by name, e.g.:
#createCollObject
#updateCollObject
#deleteCollObject
Setup
| getObjectTypes | ||
| Retrieves the list of object type identifiers known by this service. Example: fooInfo. | ||
| None | None | No parameters |
| /wiki/spaces/collectionspace/pages/666274931 | list of object type identifiers | |
| OPERATION_FAILED | unable to complete request | |
| getSearchTypes | ||
| Retrieves the list of search types known by this service. | ||
| None | None | No Parameters |
| /wiki/spaces/collectionspace/pages/666274914 | list of search type information | |
| OPERATION_FAILED | unable to complete request | |
| getCollObject | ||
| Retrieves the information for a CollectionObject. | ||
| collObjId | collObjId | identifier for collection object to be retrieved |
| collObjInfo | details of the collection object for this id | |
| DOES_NOT_EXIST | collObj not found | |
| INVALID_PARAMETER | invalid collObjKey | |
| MISSING_PARAMETER | missing collObjKey | |
| OPERATION_FAILED | unable to complete request | |
Read
| validateCollObject | ||
| Validates a collection object. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object... | ||
| validationTypeKey | validationType | identifier of the extent of validation |
| collObjInfo | collObjInfo | collection object information to be tested. |
| validationResultList | results from performing the validation | |
| DOES_NOT_EXIST | validationTypeKey not found | |
| INVALID_PARAMETER | invalid validationTypeKey, collObjInfo | |
| MISSING_PARAMETER | missing validationTypeKey, collObjInfo | |
| OPERATION_FAILED | unable to complete request | |
Search
| searchForResults | ||
| Retrieves results in tabular form for the specified parameters. | ||
| /wiki/spaces/collectionspace/pages/666275028 | searchTypeKey | search identifier |
| /wiki/spaces/collectionspace/pages/666275094 | queryParamValues | list of values for search parameters |
| /wiki/spaces/collectionspace/pages/666275096 | list of results from the query | |
| DOES_NOT_EXIST | specified search type not found | |
| INVALID_PARAMETER | invalid searchTypeKey, queryParamValueList | |
| MISSING_PARAMETER | searchTypeKey, queryParamValueList not specified | |
| OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | |
Maintenance
| createCollObject | ||
| Creates a new collection object | ||
| collObjTypeKey | collObjTypeKey | Unique identifier for a collection object type. |
| collObjInfo | collObjInfo | information about the collection object to be created |
| collObjInfo | newly created collection object information | |
| ALREADY_EXISTS | collObj already exists | |
| DATA_VALIDATION_ERROR | one or more values invalid for this operation | |
| INVALID_PARAMETER | invalid collObjInfo | |
| MISSING_PARAMETER | missing collObjInfo | |
| OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | |
| updateCollObject | ||
| Updates an existing collection object | ||
| collObjId | collObjId | identifier for collection object to be updated |
| collObjInfo | collObjInfo | information about the collection object to be updated |
| collObjInfo | updated collection object information | |
| DATA_VALIDATION_ERROR | one or more values invalid for this operation | |
| DOES_NOT_EXIST | collObjId not found | |
| INVALID_PARAMETER | invalid collObjInfo, orgID | |
| MISSING_PARAMETER | missing collObjInfo, collObjID | |
| OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | |
| VERSION_MISMATCH | action was attempted on an out of date version. | |
| deleteCollObject | ||
| Deletes an existing collection object. | ||
| collObjId | collObjId | identifier for org to be deleted |
| /wiki/spaces/collectionspace/pages/666275040 | status of the operation (success or failure) | |
| DOES_NOT_EXIST | collObjId not found | |
| INVALID_PARAMETER | invalid collObjId | |
| MISSING_PARAMETER | missing collObjId | |
| OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | |