Page Comparison

...

This category covers all endpoints related to project management, from creation to managing associated details like addresses and contacts.

Project Creation

...

Step 1: Retrieve Configuration Data

Before creating a project, it's important to fetch the configuration data to ensure it can be correctly set up with valid data fields such as projectType, Statuses, etc. This involves making API calls to retrieve listTypes and their corresponding items.

Fetching List Types

Call this endpoint to retrieve all available list types, including options for project settings such as types and statuses. This information is crucial for populating your application's dropdowns or similar selection interfaces.

Endpoint: GET /configurations/listTypes

• Description: Retrieves a list of configurable types like project types, statuses, and other categories that are used across various endpoints to ensure data consistency.

Fetching List Items for Specific Types

Once you have the list types, fetch the items for specific types such as projectType and Statuses.

Endpoint: GET /configurations/listItems

• Parameters:

  • typeId: The ID of the type for which items are required (e.g., projectType, Statuses).

Step 2: Create a Project

With the necessary configuration data retrieved, create a project using the appropriate API endpoint.

Creating a New Project

Endpoint: POST /projects

• Required Fields:

  • projectNumber: Must be a unique identifier. Recommended using a user-known identifier for a better user experience

  • projectType_LIID: As retrieved from the configurations.

  • status_LIID: As retrieved from the configurations.

  • purpose_id: As retrieved from the configurations.

  • cycle_LIID: As retrieved from the configurations.

Example API Calls

Here is how you might call the API to get configuration data and create a project:

1. Fetch List Types:

   • Request: GET /listTypes

   • Expected Response: List of types, including IDs and names for project settings.

2. Fetch List Items for 'ProjectType' and 'Statuses':

   • Request: GET /listType/{projectTypeId}/listItems

   • Expected Response: Details of items for each project type, including IDs and values.

Manage Addresses

Explains how to add or update addresses associated with a project.

...