Skip to content

Ticket


GET /tickets

GET
/tickets

Find all instances of the model matched by filter from the data source.

Parameters

Query Parameters

filter

Filter defining fields, where, include, order, offset, and limit

Typestring

Responses

Request was successful

application/json
JSON
[
{
"plantNumber": "string",
"schedulePlantNumber": "string",
"returnPlantNumber": "string",
"ticketNumber": "string",
"truckNumber": "string",
"previousTruckNumber": "string",
"ticketDate": "string",
"orderDate": "string",
"driverNumber": "string",
"driverName": "string",
"purchaseOrderNumber": "string",
"orderNumber": "string",
"timeDueOnJob": "string",
"taxCode": "string",
"minimumLoadChargeDescription": "string",
"minimumLoadChargeAmount": 0,
"onSiteSalesSubTotal": 0,
"onSiteSalesTaxTotal": 0,
"onSiteSalesTaxRate": 0,
"ticketSubTotal": 0,
"ticketTaxTotal": 0,
"ticketGrandTotal": 0,
"orderSumTotal": 0,
"previousOrderSumTotal": 0,
"timeTicketSent": "string",
"zone": "string",
"specialInstructions": "string",
"operatorMessage": "string",
"localTicketChange": true,
"lotBlockNumber": "string",
"printWeights": true,
"isMetric": true,
"loadsDelivered": "string",
"weightMasterName": "string",
"beginUnloadTime": "string",
"pocketNumber": "string",
"currency": "string",
"mapPage": "string",
"heatChargeDescription": "string",
"heatChargeAmount": 0,
"ticketMisc": "string",
"orderMisc": "string",
"salesTypeCode": "string",
"salesTypeShortDescription": "string",
"salesTypeDescription": "string",
"batchRecord": "string",
"truckLocation": "string",
"voided": false,
"voidedReason": "string",
"updatedBy": "api",
"printTimeZone": "string",
"authorityContractNumber": "string",
"scheduleStartTime": "string",
"id": "string",
"deviceId": "string",
"truckId": "string",
"companyId": "string",
"plantId": "string",
"schedulePlantId": "string",
"returnPlantId": "string",
"createdAt": "string",
"updatedAt": "string",
"customerId": "string",
"water": "string",
"delivery": "string",
"customer": "string",
"order": "string",
"mix": "string",
"onSite": "string",
"atPlant": "string",
"status": "string",
"products": [
{
"code": "string",
"description": "string",
"unit": "string",
"loadQuantity": 0,
"currency": "string",
"price": 0,
"extendedAmount": 0,
"orderedQuantity": 0,
"deliveredQuantity": 0,
"longDescription": "string",
"soldOnSite": false,
"taxable": true,
"id": "string",
"createdAt": "string",
"updatedAt": "string"
}
],
"mixDesign": "string",
"batchResult": "string",
"batchResultAggr": "string",
"inspection": "string",
"metrics": "string",
"inTransit": "string",
"customFields": [
{
"name": "string",
"label": "string",
"value": "string",
"id": "string"
}
],
"orderId": "string",
"projectId": "string",
"truckMetrics": "string",
"employeeId": "string",
"route": "string",
"returnRoute": "string",
"files": [
{
"type": "string",
"signatureUrl": "string",
"signedTime": "string",
"signedBy": "string",
"signedCode": "string",
"id": "string"
}
],
"syncStatuses": [
{
"id": "string",
"lastStatus": "string",
"lastSyncError": "string",
"lastSyncAttemptDate": "string",
"lastSuccessfulSyncDate": "string"
}
]
}
]

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/active

GET
/tickets/active

Get active tickets for a truck

Parameters

Query Parameters

truckId

Truck identifier

Typestring

Responses

Request was successful

application/json
JSON
[
{
}
]

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/count

GET
/tickets/count

Count instances of the model matched by where from the data source.

Parameters

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

application/json
JSON
{
"count": 0
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/export/{action}

GET
/tickets/export/{action}

Batch ticket export

Parameters

Path Parameters

action*
Typestring
Required

Query Parameters

plantDivisionMapping
Typestring
where*
Typestring
Required
format
Typestring
recipients
Typestring
excludeBatchWeights*
Typeboolean
Required

Responses

Request was successful

application/json
JSON
[
]

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/findOne

GET
/tickets/findOne

Find first instance of the model matched by filter from the data source.

Parameters

Query Parameters

filter

Filter defining fields, where, include, order, offset, and limit

Typestring

Responses

Request was successful

application/json
JSON
{
"plantNumber": "string",
"schedulePlantNumber": "string",
"returnPlantNumber": "string",
"ticketNumber": "string",
"truckNumber": "string",
"previousTruckNumber": "string",
"ticketDate": "string",
"orderDate": "string",
"driverNumber": "string",
"driverName": "string",
"purchaseOrderNumber": "string",
"orderNumber": "string",
"timeDueOnJob": "string",
"taxCode": "string",
"minimumLoadChargeDescription": "string",
"minimumLoadChargeAmount": 0,
"onSiteSalesSubTotal": 0,
"onSiteSalesTaxTotal": 0,
"onSiteSalesTaxRate": 0,
"ticketSubTotal": 0,
"ticketTaxTotal": 0,
"ticketGrandTotal": 0,
"orderSumTotal": 0,
"previousOrderSumTotal": 0,
"timeTicketSent": "string",
"zone": "string",
"specialInstructions": "string",
"operatorMessage": "string",
"localTicketChange": true,
"lotBlockNumber": "string",
"printWeights": true,
"isMetric": true,
"loadsDelivered": "string",
"weightMasterName": "string",
"beginUnloadTime": "string",
"pocketNumber": "string",
"currency": "string",
"mapPage": "string",
"heatChargeDescription": "string",
"heatChargeAmount": 0,
"ticketMisc": "string",
"orderMisc": "string",
"salesTypeCode": "string",
"salesTypeShortDescription": "string",
"salesTypeDescription": "string",
"batchRecord": "string",
"truckLocation": "string",
"voided": false,
"voidedReason": "string",
"updatedBy": "api",
"printTimeZone": "string",
"authorityContractNumber": "string",
"scheduleStartTime": "string",
"id": "string",
"deviceId": "string",
"truckId": "string",
"companyId": "string",
"plantId": "string",
"schedulePlantId": "string",
"returnPlantId": "string",
"createdAt": "string",
"updatedAt": "string",
"customerId": "string",
"water": "string",
"delivery": "string",
"customer": "string",
"order": "string",
"mix": "string",
"onSite": "string",
"atPlant": "string",
"status": "string",
"products": [
{
"code": "string",
"description": "string",
"unit": "string",
"loadQuantity": 0,
"currency": "string",
"price": 0,
"extendedAmount": 0,
"orderedQuantity": 0,
"deliveredQuantity": 0,
"longDescription": "string",
"soldOnSite": false,
"taxable": true,
"id": "string",
"createdAt": "string",
"updatedAt": "string"
}
],
"mixDesign": "string",
"batchResult": "string",
"batchResultAggr": "string",
"inspection": "string",
"metrics": "string",
"inTransit": "string",
"customFields": [
{
"name": "string",
"label": "string",
"value": "string",
"id": "string"
}
],
"orderId": "string",
"projectId": "string",
"truckMetrics": "string",
"employeeId": "string",
"route": "string",
"returnRoute": "string",
"files": [
{
"type": "string",
"signatureUrl": "string",
"signedTime": "string",
"signedBy": "string",
"signedCode": "string",
"id": "string"
}
],
"syncStatuses": [
{
"id": "string",
"lastStatus": "string",
"lastSyncError": "string",
"lastSyncAttemptDate": "string",
"lastSuccessfulSyncDate": "string"
}
]
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/volumeDelivered

GET
/tickets/volumeDelivered

Parameters

Query Parameters

from*

Start of period for which to compute total volume delivered

Typestring
Required
to

End of period for which to compute total volume delivered, by default the current moment

Typestring

Responses

Request was successful

application/json
JSON
{
"totalVolume": 0,
"unit": "string",
"ticketCount": 0
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}

GET
/tickets/{id}

Find a model instance by {{id}} from the data source.

Parameters

Path Parameters

id*

Model id

Typestring
Required

Query Parameters

filter

Filter defining fields and include

Typestring

Responses

Request was successful

application/json
JSON
{
"plantNumber": "string",
"schedulePlantNumber": "string",
"returnPlantNumber": "string",
"ticketNumber": "string",
"truckNumber": "string",
"previousTruckNumber": "string",
"ticketDate": "string",
"orderDate": "string",
"driverNumber": "string",
"driverName": "string",
"purchaseOrderNumber": "string",
"orderNumber": "string",
"timeDueOnJob": "string",
"taxCode": "string",
"minimumLoadChargeDescription": "string",
"minimumLoadChargeAmount": 0,
"onSiteSalesSubTotal": 0,
"onSiteSalesTaxTotal": 0,
"onSiteSalesTaxRate": 0,
"ticketSubTotal": 0,
"ticketTaxTotal": 0,
"ticketGrandTotal": 0,
"orderSumTotal": 0,
"previousOrderSumTotal": 0,
"timeTicketSent": "string",
"zone": "string",
"specialInstructions": "string",
"operatorMessage": "string",
"localTicketChange": true,
"lotBlockNumber": "string",
"printWeights": true,
"isMetric": true,
"loadsDelivered": "string",
"weightMasterName": "string",
"beginUnloadTime": "string",
"pocketNumber": "string",
"currency": "string",
"mapPage": "string",
"heatChargeDescription": "string",
"heatChargeAmount": 0,
"ticketMisc": "string",
"orderMisc": "string",
"salesTypeCode": "string",
"salesTypeShortDescription": "string",
"salesTypeDescription": "string",
"batchRecord": "string",
"truckLocation": "string",
"voided": false,
"voidedReason": "string",
"updatedBy": "api",
"printTimeZone": "string",
"authorityContractNumber": "string",
"scheduleStartTime": "string",
"id": "string",
"deviceId": "string",
"truckId": "string",
"companyId": "string",
"plantId": "string",
"schedulePlantId": "string",
"returnPlantId": "string",
"createdAt": "string",
"updatedAt": "string",
"customerId": "string",
"water": "string",
"delivery": "string",
"customer": "string",
"order": "string",
"mix": "string",
"onSite": "string",
"atPlant": "string",
"status": "string",
"products": [
{
"code": "string",
"description": "string",
"unit": "string",
"loadQuantity": 0,
"currency": "string",
"price": 0,
"extendedAmount": 0,
"orderedQuantity": 0,
"deliveredQuantity": 0,
"longDescription": "string",
"soldOnSite": false,
"taxable": true,
"id": "string",
"createdAt": "string",
"updatedAt": "string"
}
],
"mixDesign": "string",
"batchResult": "string",
"batchResultAggr": "string",
"inspection": "string",
"metrics": "string",
"inTransit": "string",
"customFields": [
{
"name": "string",
"label": "string",
"value": "string",
"id": "string"
}
],
"orderId": "string",
"projectId": "string",
"truckMetrics": "string",
"employeeId": "string",
"route": "string",
"returnRoute": "string",
"files": [
{
"type": "string",
"signatureUrl": "string",
"signedTime": "string",
"signedBy": "string",
"signedCode": "string",
"id": "string"
}
],
"syncStatuses": [
{
"id": "string",
"lastStatus": "string",
"lastSyncError": "string",
"lastSyncAttemptDate": "string",
"lastSuccessfulSyncDate": "string"
}
]
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/customerRel

GET
/tickets/{id}/customerRel

Fetches belongsTo relation customerRel.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

refresh
Typeboolean

Responses

Request was successful

application/json
JSON
{
"number": "string",
"name": "string",
"allowViewBatchWeights": true,
"allowViewPhotos": true,
"allowViewDriverNotes": true,
"allowOrderRequest": false,
"allowViewWaterDetails": true,
"allowAcceptRejectLoad": true,
"externalId": "string",
"id": "string",
"companyId": "string",
"divisionId": "string",
"contractorCompanyId": "string",
"createdAt": "string",
"updatedAt": "string",
"contacts": "string",
"customFields": [
{
"name": "string",
"value": "string",
"id": "string"
}
]
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/exists

GET
/tickets/{id}/exists

Check whether a model instance exists in the data source.

Parameters

Path Parameters

id*

Model id

Typestring
Required

Responses

Request was successful

application/json
JSON
{
"exists": true
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/export/{action}

GET
/tickets/{id}/export/{action}

Export specific ticket

Parameters

Path Parameters

action*
Typestring
Required
id*

PersistedModel id

Typestring
Required

Query Parameters

plantDivisionMapping
Typestring
format
Typestring
recipients
Typestring
type
Typestring
excludeBatchWeights*
Typeboolean
Required

Responses

Request was successful

application/json
JSON
[
]

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/images

GET
/tickets/{id}/images

Queries images of Ticket.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

filter
Typestring

Responses

Request was successful

application/json
JSON
[
{
"status": "string",
"url": "string",
"notes": "string",
"truckLocation": "string",
"id": "string",
"ticketId": "string",
"companyId": "string",
"createdAt": "string",
"updatedAt": "string"
}
]

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/images/count

GET
/tickets/{id}/images/count

Counts images of Ticket.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

application/json
JSON
{
"count": 0
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/images/{fk}

GET
/tickets/{id}/images/{fk}

Find a related item by id for images.

Parameters

Path Parameters

fk*

Foreign key for images

Typestring
Required
id*

PersistedModel id

Typestring
Required

Responses

Request was successful

application/json
JSON
{
"status": "string",
"url": "string",
"notes": "string",
"truckLocation": "string",
"id": "string",
"ticketId": "string",
"companyId": "string",
"createdAt": "string",
"updatedAt": "string"
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/returnPlant

GET
/tickets/{id}/returnPlant

Fetches belongsTo relation returnPlant.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

refresh
Typeboolean

Responses

Request was successful

application/json
JSON
{
"number": "string",
"description": "string",
"address": "string",
"region": {
},
"location": "string",
"radius": 100,
"dvirEmails": [
"string"
],
"timeZone": "string",
"id": "string",
"companyId": "string",
"createdAt": "string",
"updatedAt": "string",
"plantRegionId": "string",
"addressDetails": "string"
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/returnTicketRoute

GET
/tickets/{id}/returnTicketRoute

Fetches hasOne relation returnTicketRoute.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

refresh
Typeboolean

Responses

Request was successful

application/json
JSON
{
"origin": "string",
"destination": "string",
"polyline": "string",
"googleMapsURL": "string",
"id": "string",
"plantId": "string",
"waypoints": [
{
"index": 0,
"location": "string",
"stopover": false
}
]
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/schedulePlant

GET
/tickets/{id}/schedulePlant

Fetches belongsTo relation schedulePlant.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

refresh
Typeboolean

Responses

Request was successful

application/json
JSON
{
"number": "string",
"description": "string",
"address": "string",
"region": {
},
"location": "string",
"radius": 100,
"dvirEmails": [
"string"
],
"timeZone": "string",
"id": "string",
"companyId": "string",
"createdAt": "string",
"updatedAt": "string",
"plantRegionId": "string",
"addressDetails": "string"
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/ticketAtPlant

GET
/tickets/{id}/ticketAtPlant

Fetches hasOne relation ticketAtPlant.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

refresh
Typeboolean

Responses

Request was successful

application/json
JSON
{
"waterAdded": "string",
"id": "string"
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/ticketBatchResult

GET
/tickets/{id}/ticketBatchResult

Fetches hasOne relation ticketBatchResult.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

refresh
Typeboolean

Responses

Request was successful

application/json
JSON
{
"loadTime": "string",
"specificGravityOfSlurry": 0,
"activityOfSlurryPercent": 0,
"substitutionOfSlurryPercent": 0,
"temperWater": "string",
"temperWaterUnits": "string",
"id": "string",
"aggregates": [
{
"name": "string",
"target": 0,
"actual": 0,
"units": "lb",
"moisture": 0,
"moisturePercent": 0,
"design": 0,
"id": "string"
}
],
"cements": [
{
"name": "string",
"target": 0,
"actual": 0,
"units": "lb",
"moisture": 0,
"moisturePercent": 0,
"design": 0,
"id": "string"
}
],
"admixtures": [
{
"name": "string",
"target": 0,
"actual": 0,
"units": "lb",
"moisture": 0,
"moisturePercent": 0,
"design": 0,
"id": "string"
}
],
"waters": [
{
"name": "string",
"target": 0,
"actual": 0,
"units": "lb",
"moisture": 0,
"moisturePercent": 0,
"design": 0,
"id": "string"
}
]
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/ticketBatchResultAggr

GET
/tickets/{id}/ticketBatchResultAggr

Fetches hasOne relation ticketBatchResultAggr.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

refresh
Typeboolean

Responses

Request was successful

application/json
JSON
{
"loadTime": "string",
"specificGravityOfSlurry": 0,
"activityOfSlurryPercent": 0,
"substitutionOfSlurryPercent": 0,
"temperWater": "string",
"temperWaterUnits": "string",
"id": "string",
"aggregates": [
{
"name": "string",
"target": 0,
"actual": 0,
"units": "lb",
"moisture": 0,
"moisturePercent": 0,
"design": 0,
"id": "string"
}
],
"cements": [
{
"name": "string",
"target": 0,
"actual": 0,
"units": "lb",
"moisture": 0,
"moisturePercent": 0,
"design": 0,
"id": "string"
}
],
"admixtures": [
{
"name": "string",
"target": 0,
"actual": 0,
"units": "lb",
"moisture": 0,
"moisturePercent": 0,
"design": 0,
"id": "string"
}
],
"waters": [
{
"name": "string",
"target": 0,
"actual": 0,
"units": "lb",
"moisture": 0,
"moisturePercent": 0,
"design": 0,
"id": "string"
}
]
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/ticketCustomFields

GET
/tickets/{id}/ticketCustomFields

Queries ticketCustomFields of Ticket.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

filter
Typestring

Responses

Request was successful

application/json
JSON
[
{
"name": "string",
"label": "string",
"value": "string",
"id": "string"
}
]

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/ticketCustomFields/count

GET
/tickets/{id}/ticketCustomFields/count

Counts ticketCustomFields of Ticket.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

application/json
JSON
{
"count": 0
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/ticketCustomFields/{fk}

GET
/tickets/{id}/ticketCustomFields/{fk}

Find a related item by id for ticketCustomFields.

Parameters

Path Parameters

fk*

Foreign key for ticketCustomFields

Typestring
Required
id*

PersistedModel id

Typestring
Required

Responses

Request was successful

application/json
JSON
{
"name": "string",
"label": "string",
"value": "string",
"id": "string"
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/ticketFiles

GET
/tickets/{id}/ticketFiles

Queries ticketFiles of Ticket.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

filter
Typestring

Responses

Request was successful

application/json
JSON
[
{
"type": "string",
"signatureUrl": "string",
"signedTime": "string",
"signedBy": "string",
"signedCode": "string",
"id": "string"
}
]

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/ticketFiles/count

GET
/tickets/{id}/ticketFiles/count

Counts ticketFiles of Ticket.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

application/json
JSON
{
"count": 0
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/ticketFiles/{fk}

GET
/tickets/{id}/ticketFiles/{fk}

Find a related item by id for ticketFiles.

Parameters

Path Parameters

fk*

Foreign key for ticketFiles

Typestring
Required
id*

PersistedModel id

Typestring
Required

Responses

Request was successful

application/json
JSON
{
"type": "string",
"signatureUrl": "string",
"signedTime": "string",
"signedBy": "string",
"signedCode": "string",
"id": "string"
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/ticketInTransit

GET
/tickets/{id}/ticketInTransit

Fetches hasOne relation ticketInTransit.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

refresh
Typeboolean

Responses

Request was successful

application/json
JSON
{
"beginPour": "string",
"endPour": "string",
"loadStartDate": "string",
"loadStartLocationLocalTime": "string",
"loaded": "string",
"loading": "string",
"pausePour": "string",
"admixAtArrival": {
},
"admixAtDischarge": {
},
"admixAtLeavePlant": {
},
"maxAllowedWater": {
},
"slumpAtArrival": {
},
"slumpAtDischarge": {
},
"slumpAtInitialSlump": {
},
"slumpAtLeavePlant": {
},
"slumpVsTargetAtArrival": {
},
"slumpVsTargetAtDischarge": {
},
"slumpVsTargetInitialSlump": {
},
"waterAtArrival": {
},
"waterAtDischarge": {
},
"waterAtLeavePlant": {
},
"id": "string"
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/ticketProducts

GET
/tickets/{id}/ticketProducts

Queries ticketProducts of Ticket.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

filter
Typestring

Responses

Request was successful

application/json
JSON
[
{
"code": "string",
"description": "string",
"unit": "string",
"loadQuantity": 0,
"currency": "string",
"price": 0,
"extendedAmount": 0,
"orderedQuantity": 0,
"deliveredQuantity": 0,
"longDescription": "string",
"soldOnSite": false,
"taxable": true,
"id": "string",
"createdAt": "string",
"updatedAt": "string"
}
]

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/ticketProducts/count

GET
/tickets/{id}/ticketProducts/count

Counts ticketProducts of Ticket.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

where

Criteria to match model instances

Typestring

Responses

Request was successful

application/json
JSON
{
"count": 0
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/ticketProducts/{fk}

GET
/tickets/{id}/ticketProducts/{fk}

Find a related item by id for ticketProducts.

Parameters

Path Parameters

fk*

Foreign key for ticketProducts

Typestring
Required
id*

PersistedModel id

Typestring
Required

Responses

Request was successful

application/json
JSON
{
"code": "string",
"description": "string",
"unit": "string",
"loadQuantity": 0,
"currency": "string",
"price": 0,
"extendedAmount": 0,
"orderedQuantity": 0,
"deliveredQuantity": 0,
"longDescription": "string",
"soldOnSite": false,
"taxable": true,
"id": "string",
"createdAt": "string",
"updatedAt": "string"
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/ticketRoute

GET
/tickets/{id}/ticketRoute

Fetches hasOne relation ticketRoute.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

refresh
Typeboolean

Responses

Request was successful

application/json
JSON
{
"origin": "string",
"destination": "string",
"polyline": "string",
"googleMapsURL": "string",
"id": "string",
"plantId": "string",
"waypoints": [
{
"index": 0,
"location": "string",
"stopover": false
}
]
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

GET /tickets/{id}/ticketWater

GET
/tickets/{id}/ticketWater

Fetches hasOne relation ticketWater.

Parameters

Path Parameters

id*

PersistedModel id

Typestring
Required

Query Parameters

refresh
Typeboolean

Responses

Request was successful

application/json
JSON
{
"unit": "string",
"temper": 0,
"aggregate": 0,
"batched": 0,
"allowedMax": 0,
"addedAtPlant": 0,
"addedOnSite": 0,
"addedAllowedOnSite": 0,
"addedAllowedOnSitePositive": 0,
"addedTotal": 0,
"designTotal": 0,
"wcrDesign": 0,
"wcrAtPlant": 0,
"wcrOnSite": 0,
"id": "string"
}

Playground

Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python