Term

(API Version v2)

What can you do with Term?

DELETE api/v2/Term/{id:int}
GET api/v2/Term
GET api/v2/Term/Paged
GET api/v2/Term/Paged/Detail
GET api/v2/Term/{id:int}
GET api/v2/Term/{id:int}/Detail
PATCH api/v2/Term/{id:int}
POST api/v2/Term
PUT api/v2/Term/{id:int}

Properties

Property Details

id	"id": 1 Type: Number This is the unique numeric identifier for the Term
ownerId	"ownerId": 26 Type: Number Unique identifier for the associated Owner object.
name	"name": "Hello World" Type: String
isActive	"isActive": true Type: Boolean
frequency	"frequency": 23 Type: Number
frequencyTypeId	"frequencyTypeId": 19 Type: Number Unique identifier for the associated FrequencyType object.
penaltyServiceId	"penaltyServiceId": 17 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:

termPenalty - create, update, delete

DataFlow PATCH objects:

term - create, update, delete
termPenalty - create, update, delete

End Points

DELETE	api/v2/Term/{id:int}
Delete an instance of the Term object.

GET	api/v2/Term
Retrieve all of the Term objects.

GET	api/v2/Term/Paged
Retreive all of the Term objects in a paged fashion.

GET	api/v2/Term/Paged/Detail
Retreive all of the Term objects in a paged fashion with all object details.

GET	api/v2/Term/{id:int}
Retrieve an instance of the Term object by it's ID.
{id:int}	Unique identifier for the Term object.

GET	api/v2/Term/{id:int}/Detail
Retreive all of the Detail objects for the specified Term.
{id:int}	Unique identifier for the Term object.

PATCH	api/v2/Term/{id:int}
Update the Term object and optionally make changes to any child objects.

POST	api/v2/Term
Create a new instance of the Term object.

PUT	api/v2/Term/{id:int}
Update an existing instance of the Term object.