Internal Team Technician Resource¶
Get Internal Team Technician¶
HTTP Request
GET /api/internalTeamTechnicians/{id}
📋 Description: Retrieves detailed information about a specific internal team technician identified by the provided ID, facilitating effective resource management and personnel oversight.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "phone": "string",
7 "email": "string",
8 "internalTeam": {
9 "id": 0,
10 "createdBy": "string",
11 "createdAt": "2019-08-24T14:15:22Z",
12 "modifiedBy": "string",
13 "modifiedAt": "2019-08-24T14:15:22Z",
14 "displayId": "string",
15 "name": "string",
16 "email": "string",
17 "phone": "string",
18 "manager": "string",
19 "internalTeamAvailable": true,
20 "description": "string",
21 "new": true
22 }
23}
Update Internal Team Technician¶
HTTP Request
PUT /api/internalTeamTechnicians/{id}
📋 Description: Updates the details of a specific internal team technician identified by the provided ID, ensuring that the technician’s information is current and accurately reflects their role within the organization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated information for the internal team technician, including personal details, role specifications, and availability status. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "phone": "string",
7 "email": "string",
8 "internalTeam": {
9 "id": 0,
10 "createdBy": "string",
11 "createdAt": "2019-08-24T14:15:22Z",
12 "modifiedBy": "string",
13 "modifiedAt": "2019-08-24T14:15:22Z",
14 "displayId": "string",
15 "name": "string",
16 "email": "string",
17 "phone": "string",
18 "manager": "string",
19 "internalTeamAvailable": true,
20 "description": "string",
21 "new": true
22 }
23}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Internal Team Technician¶
HTTP Request
DELETE /api/internalTeamTechnicians/{id}
📋 Description: Deletes a specified internal team technician from the system, ensuring that personnel records are accurately maintained and up-to-date.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get All Internal Team Technicians¶
HTTP Request
GET /api/internalTeamTechnicians
📋 Description: Retrieves a list of internal team technicians, providing essential details for resource allocation and team management. This operation supports efficient oversight of technical personnel within the organization.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "name": "string",
7 "phone": "string",
8 "email": "string",
9 "internalTeam": {
10 "id": 0,
11 "createdBy": "string",
12 "createdAt": "2019-08-24T14:15:22Z",
13 "modifiedBy": "string",
14 "modifiedAt": "2019-08-24T14:15:22Z",
15 "displayId": "string",
16 "name": "string",
17 "email": "string",
18 "phone": "string",
19 "manager": "string",
20 "internalTeamAvailable": true,
21 "description": "string",
22 "new": true
23 }
24 }
25]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a technician within an internal team, encapsulating essential details such as skills, availability, and assignment status to facilitate effective resource management and operational efficiency.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» name |
string |
false |
none |
Name of the resource |
» phone |
string |
false |
none |
Contact number for the technician, facilitating direct communication for service coordination and support. |
string |
false |
none |
Email address of the technician, used for communication and notifications within the internal team. |
|
» internalTeam |
false |
none |
Data structure representing an internal team within the organization, encompassing team members, roles, and associated responsibilities to facilitate effective collaboration and resource management. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» modifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» name |
string |
false |
none |
Name of the resource |
string |
false |
none |
Email address of the internal team member, used for communication and notifications within the organization. |
|
»» phone |
string |
false |
none |
Contact number for the internal team, used for communication and coordination purposes. |
»» manager |
string |
false |
none |
Represents the name or identifier of the team manager responsible for overseeing the internal team. |
»» internalTeamAvailable |
boolean |
false |
none |
Indicates whether the internal team is available to support the request or project. |
»» description |
string |
false |
none |
Description of the resource |
»» new |
boolean |
false |
none |
Indicates whether the internal team is newly created within the system. |
Create Internal Team Technician¶
HTTP Request
POST /api/internalTeamTechnicians
📋 Description: Creates a new internal team technician record, enabling efficient management of technical resources within the organization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details of internal team technicians, including their roles, contact information, and availability for resource allocation. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "phone": "string",
7 "email": "string",
8 "internalTeam": {
9 "id": 0,
10 "createdBy": "string",
11 "createdAt": "2019-08-24T14:15:22Z",
12 "modifiedBy": "string",
13 "modifiedAt": "2019-08-24T14:15:22Z",
14 "displayId": "string",
15 "name": "string",
16 "email": "string",
17 "phone": "string",
18 "manager": "string",
19 "internalTeamAvailable": true,
20 "description": "string",
21 "new": true
22 }
23}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10