TAG LINE
SMALL TITLE

Term

(API Version v2)


What can you do with Term?


Properties

Property Details
id
"id": 14
Type: Number
This is the unique numeric identifier for the Term
ownerId
"ownerId": 13
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
isActive
"isActive": true
Type: Boolean
frequency
"frequency": 12
Type: Number
frequencyTypeId
"frequencyTypeId": 25
Type: Number
Unique identifier for the associated FrequencyType object.
penaltyServiceId
"penaltyServiceId": 10
Type: Number
Unique identifier for the associated Service object.
chargeRemainder
"chargeRemainder": true
Type: Boolean


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • isActive
  • frequency
  • frequencyTypeId
  • penaltyServiceId
  • chargeRemainder

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the Term object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v2/Term/{id:int}
Delete an instance of the Term object.
GETapi/v2/Term
Retrieve all of the Term objects.
GETapi/v2/Term/Paged
Retreive all of the Term objects in a paged fashion.
GETapi/v2/Term/Paged/Detail
Retreive all of the Term objects in a paged fashion with all object details.
GETapi/v2/Term/{id:int}
Retrieve an instance of the Term object by it's ID.
{id:int}Unique identifier for the Term object.
GETapi/v2/Term/{id:int}/Detail
Retreive all of the Detail objects for the specified Term.
{id:int}Unique identifier for the Term object.
PATCHapi/v2/Term/{id:int}
Update the Term object and optionally make changes to any child objects.
POSTapi/v2/Term
Create a new instance of the Term object.
PUTapi/v2/Term/{id:int}
Update an existing instance of the Term object.