Contractor Contact Resource¶
Get Contractor Contact¶
HTTP Request
GET /api/contractorContacts/{id}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Retrieves detailed information about a specific contractor contact identified by the provided ID, facilitating effective management of contractor relationships.
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 "contractorContactAvailable": true
9}
Update Contractor Contact¶
HTTP Request
PUT /api/contractorContacts/{id}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Updates the details of a specific contractor contact identified by the provided ID, ensuring that the information remains current and accurate for effective management of contractor relationships.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated contractor contact information, including name, email, phone number, and any relevant notes for effective communication management. |
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 "contractorContactAvailable": true
9}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Contractor Contact¶
HTTP Request
DELETE /api/contractorContacts/{id}
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Deletes a specified contractor contact from the system, ensuring that outdated or unnecessary contact information is effectively removed to maintain data integrity.
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 Contractor Contacts¶
HTTP Request
GET /api/contractorContacts
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Fetches a list of contractor contact details, enabling users to efficiently manage and engage with their contractor relationships.
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 "contractorContactAvailable": true
10 }
11]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the contact information of a contractor, including essential details for effective communication and collaboration within project 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 |
» name |
string |
false |
none |
Name of the resource |
» phone |
string |
false |
none |
Contact phone number for the contractor, facilitating direct communication regarding project details and updates. |
string |
false |
none |
Email address of the contractor’s primary contact, used for communication and notifications related to contract management. |
|
» contractorContactAvailable |
boolean |
false |
none |
Indicates whether a contact person for the contractor is available for communication. |
Create Contractor Contact¶
HTTP Request
POST /api/contractorContacts
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Creates a new contractor contact entry in the system, enabling efficient management of contractor relationships and communication.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the contractor contact information, including name, email, phone number, and associated contractor ID for effective communication management. |
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 "contractorContactAvailable": true
9}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10