TAG LINE
SMALL TITLE

Order Service Price

(API Version v2)


What can you do with OrderServicePrice?


Properties

Property Details
id
"id": 10
Type: Number
This is the unique numeric identifier for the OrderServicePrice
ownerId
"ownerId": 4
Type: Number
Unique identifier for the associated Owner object.
orderServiceId
"orderServiceId": 13
Type: Number
Unique identifier for the associated OrderService object.
serviceStatusTypeId
"serviceStatusTypeId": 11
Type: Number
Unique identifier for the associated ServiceStatusType object.
amount
"amount": "Hello World"
Type: String


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:

  • serviceStatusTypeId
  • amount

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 OrderServicePrice object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

GETapi/v2/OrderServicePrice
Retrieve all of the OrderServicePrice objects.
GETapi/v2/OrderServicePrice/Paged
Retreive all of the OrderServicePrice objects in a paged fashion.
GETapi/v2/OrderServicePrice/Paged/Detail
Retreive all of the OrderServicePrice objects in a paged fashion with all object details.
GETapi/v2/OrderServicePrice/{id:int}
Retrieve an instance of the OrderServicePrice object by it's ID.
{id:int}Unique identifier for the OrderServicePrice object.
GETapi/v2/OrderServicePrice/{id:int}/Detail
Retreive all of the Detail objects for the specified OrderServicePrice.
{id:int}Unique identifier for the OrderServicePrice object.