Articles on: API

Sub-Project API

The Sub-Project API in XperienceHR provides an interface for managing sub projects, including creating, updating, deactivating, and listing sub-projects, ensuring seamless integration with external systems for detailed project management and tracking.

This API supports XML & JSON format for structured data exchange and requires authentication via an API key.

By integrating the Sub-Project API, organizations can efficiently manage sub project lifecycle data, ensuring accurate tracking and resource allocation within larger projects.

Overview



API Type: REST
Supported Formats: XML
API Key: Generated in the app configuration
Method: POST, GET


Sub-Project Management



Functionality:
Create New Sub-Project
Update Sub-Project
Deactivate Sub-Project
Get all Sub-Projects

Create New Sub-Project



ParameterMinMaxRequiredInformationDescription
Name1100The sub-project name.
Code130The sub-project short name.
Description0500The description of this sub-project.
Project TypeFIXEDHOURLYDefault value is HOURLYThe sub-project type.
Inherit Parent PermissionsTRUEFALSE
Start DateThe date when the sub-project begins (format: YYYY-MM-DD).
Finish DateThe date when the sub-project ends (format: YYYY-MM-DD).
Subproject Code030
Project StatusThe status of project.
Project Status CodeValid XPHR valueThe short name of the sub-project status value.
Parent Project CodeValid XPHR valueThe code of parent project.
Budget0Double_MAX_VALUEThe amount of money expected to be spent on the sub-project ($).
Duration0Integer_MAX_VALUEThe number of hours expected to be spent on the sub-project.
Billing TypeValid values: employee, activity, projectThe way in which the budgeted amount is calculated.
Rate0Double_MAX_VALUEOnly relevant for project rate typeThe sub-project rate ($).
Duration CorrectionPositive valueThe number of hours already tracked outside the application.
BillableTRUEFALSETRUE: all activities are billable; FALSE: only manually marked activities are billable
Billable TypeThe way in which the budgeted amount is calculated.
ActiveTRUEFALSEIndicates whether the project is currently active.
Late Missing NotificationTRUEFALSETRUE: enabled; FALSE: disabled
SMS NotificationTRUEFALSEValid XPHR valueIndicates if employees will receive SMS notifications when late (paid service).
Email StringValid email addressThe email addresses that should receive Late and Missing Notifications (multiple addresses separated by commas).
Project Manager LoginsValid XPHR valueThe logins for sub-project management.
GPS Latitude-9090The latitude of the sub-project location.
GPS Longitude-180180The longitude of the sub-project location.
GPS Radius0Integer_MAX_VALUEThe GPS radius in meters.
Cost Center CodeValid XPHR valueThe code of the cost center, only for creating a new sub-project (updating Cost Center is not supported).


Billable Type OptionsDescription
YESAll activities marked strictly as billable
DEFAULT_YESAll activities marked as billable but could be unmarked
NOAll activities marked strictly as non-billable
DEFAULT_NOAll activities marked as non-billable but could be unmarked
ACTIVITYBillable flag is determined by activity setting

Endpoint



Update Sub-Project



To update sub-project's information, match its code in request body and provide value(s) for data to be updated.

Endpoint



Get All Sub-Projects



Endpoint



Error Handling



Common errors help in debugging and correcting API usage issues.

Example 1: Missing Code

Example 2: User Not Found

Example 3: Parent Project Required


HTTP Response Codes


2XX Success - Operation completed successfully.
4XX Client Error - Likely an issue with the request, such as incorrect parameters or insufficient permissions. Returns an error message in text or XML format.
5XX Server Error - Indicates a server issue. Report this error if encountered.

Updated on: 26/05/2025

Was this article helpful?

Share your feedback

Cancel

Thank you!