-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c5f7dd0
commit 369fef4
Showing
22 changed files
with
92,918 additions
and
0 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,194 @@ | ||
{ | ||
"openapi": "3.0.1", | ||
"info": { | ||
"title": "Customer Interactions", | ||
"version": "1.0" | ||
}, | ||
"servers": [ | ||
{ | ||
"url": "https://api-integration.servicetitan.io/customer-interactions/v2" | ||
} | ||
], | ||
"paths": { | ||
"/tenant/{tenant}/technician-rating/technician/{technicianId}/job/{jobId}": { | ||
"put": { | ||
"tags": [ | ||
"TechnicianRating" | ||
], | ||
"summary": "Add a rating for the specified technician, tied to the specific job.\nIf the rating already exists for that technician/ job combination, update it with the new score.", | ||
"description": "Add a rating for the specified technician, tied to the specific job.\nIf the rating already exists for that technician/ job combination, update it with the new score.", | ||
"operationId": "TechnicianRating_Update", | ||
"parameters": [ | ||
{ | ||
"name": "technicianId", | ||
"in": "path", | ||
"description": "Format - int64.", | ||
"required": true, | ||
"schema": { | ||
"type": "integer", | ||
"format": "int64" | ||
} | ||
}, | ||
{ | ||
"name": "jobId", | ||
"in": "path", | ||
"description": "Format - int64.", | ||
"required": true, | ||
"schema": { | ||
"type": "integer", | ||
"format": "int64" | ||
} | ||
}, | ||
{ | ||
"name": "tenant", | ||
"in": "path", | ||
"description": "Format - int64. Tenant ID", | ||
"required": true, | ||
"schema": { | ||
"type": "integer", | ||
"format": "int64" | ||
} | ||
} | ||
], | ||
"requestBody": { | ||
"content": { | ||
"application/json": { | ||
"schema": { | ||
"$ref": "#/components/schemas/CustomerInteractions.V2.CreateOrUpdateTechnicianAssessmentRequest" | ||
}, | ||
"example": { | ||
"value": 0 | ||
} | ||
} | ||
} | ||
}, | ||
"responses": { | ||
"200": { | ||
"description": "The request has succeeded" | ||
}, | ||
"400": { | ||
"description": "The request cannot be processed, check validation errors or request format", | ||
"content": { | ||
"application/json": { | ||
"schema": { | ||
"$ref": "#/components/schemas/ApiErrorResponse" | ||
}, | ||
"example": { | ||
"type": "string", | ||
"title": "string", | ||
"status": 0, | ||
"traceId": "string", | ||
"errors": {}, | ||
"data": {} | ||
} | ||
} | ||
} | ||
}, | ||
"404": { | ||
"description": "Technician or Job not found", | ||
"content": { | ||
"application/json": { | ||
"schema": { | ||
"$ref": "#/components/schemas/ApiErrorResponse" | ||
}, | ||
"example": { | ||
"type": "string", | ||
"title": "string", | ||
"status": 0, | ||
"traceId": "string", | ||
"errors": {}, | ||
"data": {} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"components": { | ||
"schemas": { | ||
"ApiErrorResponse": { | ||
"required": [ | ||
"type", | ||
"title", | ||
"status", | ||
"traceId", | ||
"errors", | ||
"data" | ||
], | ||
"type": "object", | ||
"properties": { | ||
"type": { | ||
"type": "string", | ||
"description": "A URI reference that identifies the problem type" | ||
}, | ||
"title": { | ||
"type": "string", | ||
"description": "A short, human-readable summary of the problem type" | ||
}, | ||
"status": { | ||
"type": "integer", | ||
"description": "The HTTP status code generated by server", | ||
"format": "int32" | ||
}, | ||
"traceId": { | ||
"type": "string", | ||
"description": "Internal trace ID for advanced diagnostics" | ||
}, | ||
"errors": { | ||
"type": "object", | ||
"additionalProperties": { | ||
"type": "array", | ||
"items": { | ||
"type": "string" | ||
} | ||
}, | ||
"description": "Provides more details about errors occurred, which can potentially be used for visual display" | ||
}, | ||
"data": { | ||
"type": "object", | ||
"additionalProperties": {}, | ||
"description": "Provides additional data, intended for programmatical usage" | ||
} | ||
}, | ||
"additionalProperties": false, | ||
"description": "Detailed error response, following RFC 7807 recommendations (https://tools.ietf.org/html/rfc7807)." | ||
}, | ||
"CustomerInteractions.V2.CreateOrUpdateTechnicianAssessmentRequest": { | ||
"required": [ | ||
"value" | ||
], | ||
"type": "object", | ||
"properties": { | ||
"value": { | ||
"type": "number", | ||
"description": "Rating (0-10)", | ||
"format": "double" | ||
} | ||
}, | ||
"additionalProperties": false | ||
} | ||
}, | ||
"securitySchemes": { | ||
"apiKeyHeader": { | ||
"type": "apiKey", | ||
"name": "ST-App-Key", | ||
"in": "header" | ||
}, | ||
"apiKeyQuery": { | ||
"type": "apiKey", | ||
"name": "servicetitanapplicationkey", | ||
"in": "query" | ||
} | ||
} | ||
}, | ||
"security": [ | ||
{ | ||
"apiKeyHeader": [] | ||
}, | ||
{ | ||
"apiKeyQuery": [] | ||
} | ||
] | ||
} |
Oops, something went wrong.