Contractor Resource

Get All Contractors

HTTP Request

GET /api/contractors

Interactive Demo

Deprecated

This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.

📋 Description: Fetches a list of contractors, providing essential details for effective resource management and project allocation.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "address": "string",
    "contractorContacts": [
      {
        "id": 0,
        "createdBy": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "phone": "string",
        "email": "string",
        "contractorContactAvailable": true
      }
    ],
    "contractorAvailable": true
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ContractorDTO]	false	none	[Data transfer object representing a contractor’s profile, including essential details such as identification, contact information, and contractual terms, facilitating effective management and communication within project workflows.]
» 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
» address	string	false	none	Represents the physical location of the contractor, essential for service delivery and compliance with local regulations.
» contractorContacts	[ContractorContactDTO]	false	none	An array of contact details for contractors associated with the project, facilitating effective communication and collaboration.
»» 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.
»» email	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.
» contractorAvailable	boolean	false	none	Indicates whether the contractor is currently available for assignment within the project.

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create Contractor

HTTP Request

POST /api/contractors

Interactive Demo

Deprecated

This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.

📋 Description: Creates a new contractor record within the system, enabling efficient management of contractor information and resources.

Parameters

Name	In	Type	Required	Description
body	body	ContractorDTO	true	Request body containing the contractor details, including identification, contact information, and contractual terms necessary for onboarding.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "address": "string",
  "contractorContacts": [
    {
      "id": 0,
      "createdBy": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "phone": "string",
      "email": "string",
      "contractorContactAvailable": true
    }
  ],
  "contractorAvailable": true
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	integer

Example Responses

0

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Contractor

HTTP Request

GET /api/contractors/{id}

Interactive Demo

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 identified by the provided ID, enabling users to access essential contractor data for effective management and decision-making.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ContractorDTO

Example Responses

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "address": "string",
  "contractorContacts": [
    {
      "id": 0,
      "createdBy": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "phone": "string",
      "email": "string",
      "contractorContactAvailable": true
    }
  ],
  "contractorAvailable": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Update Contractor

HTTP Request

POST /api/contractors/{id}

Interactive Demo

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 identified by the provided ID, enabling businesses to maintain accurate and current contractor information.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ContractorDTO	true	Request body containing the contractor details, including name, contact information, and service specifications, to update the contractor’s profile.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "address": "string",
  "contractorContacts": [
    {
      "id": 0,
      "createdBy": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "phone": "string",
      "email": "string",
      "contractorContactAvailable": true
    }
  ],
  "contractorAvailable": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete Contractor

HTTP Request

DELETE /api/contractors/{id}

Interactive Demo

Deprecated

This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.

📋 Description: Deletes a contractor identified by the specified ID, ensuring the removal of associated data from the system and maintaining data integrity within the contractor management framework.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Update Contractor Availability With Children

HTTP Request

POST /api/contractors/{id}/updateChildrenAvailability

Interactive Demo

Deprecated

This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.

📋 Description: Updates the availability status of children associated with a specific contractor, allowing for efficient management of resource allocation and scheduling.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ContractorDTO	true	Request body containing the updated availability information for the specified contractor’s children, including their availability status and relevant scheduling details.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "address": "string",
  "contractorContacts": [
    {
      "id": 0,
      "createdBy": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "phone": "string",
      "email": "string",
      "contractorContactAvailable": true
    }
  ],
  "contractorAvailable": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Contractor Contacts

HTTP Request

GET /api/contractors/{id}/contractorContacts

Interactive Demo

Deprecated

This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.

📋 Description: Fetches the list of contractor contacts associated with a specific contractor, identified by the unique contractor ID, to facilitate effective communication and relationship management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "phone": "string",
    "email": "string",
    "contractorContactAvailable": true
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ContractorContactDTO]	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.
» email	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.

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create Contractor Contact

HTTP Request

POST /api/contractors/{id}/contractorContacts

Interactive Demo

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 associated with the specified contractor ID, enabling efficient management of contractor relationships and communication.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ContractorContactDTO	true	Request body containing the contractor contact information, including name, email, phone number, and role, essential for maintaining accurate communication records within contractor management.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "phone": "string",
  "email": "string",
  "contractorContactAvailable": true
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	integer

Example Responses

0

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Contractor Contact

HTTP Request

GET /api/contractors/{id}/contractorContacts/{cid}

Interactive Demo

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 associated with a given contractor, enabling users to access essential contact details for effective communication and management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
cid	path	integer(int64)	true	Unique identifier for the specific contractor contact associated with the contractor identified by {id}.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ContractorContactDTO

Example Responses

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "phone": "string",
  "email": "string",
  "contractorContactAvailable": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Update Contractor Contact

HTTP Request

POST /api/contractors/{id}/contractorContacts/{cid}

Interactive Demo

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 associated with the specified contractor, enabling effective management of contractor relationships and communication.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
cid	path	integer(int64)	true	Unique identifier for the contractor contact associated with the specified contractor, facilitating targeted updates and management of contact information.
body	body	ContractorContactDTO	true	Request body containing the contractor contact details, including name, email, phone number, and role, essential for managing contractor relationships effectively.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "phone": "string",
  "email": "string",
  "contractorContactAvailable": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete Contractor Contact

HTTP Request

DELETE /api/contractors/{id}/contractorContacts/{cid}

Interactive Demo

Deprecated

This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.

📋 Description: Deletes a specific contractor contact associated with a contractor, ensuring the removal of outdated or unnecessary contact information from the system.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
cid	path	integer(int64)	true	Unique identifier for the contractor contact to be deleted from the specified contractor’s profile.

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Contractors

HTTP Request

POST /api/contractors/search

Interactive Demo

Deprecated

This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.

📋 Description: Submits a search request to locate contractors based on specified criteria, facilitating efficient contractor management and selection processes.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the search results for contractors should be paginated, allowing for efficient retrieval of large datasets.
body	body	ContractorDtoFilter	true	Request body containing search criteria for contractors, including filters such as location, skills, and availability to facilitate targeted recruitment efforts.

Body Parameters

{
  "idIn": [
    0
  ],
  "idNotIn": [
    0
  ],
  "nameLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageContractorDTO

Example Responses

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "id": 0,
      "createdBy": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "address": "string",
      "contractorContacts": [
        {
          "id": 0,
          "createdBy": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "name": "string",
          "phone": "string",
          "email": "string",
          "contractorContactAvailable": true
        }
      ],
      "contractorAvailable": true
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---