---
title: "API Design"
slug: "safran-project-integration-api-api-design"
updated: 2024-07-19T06:15:32Z
published: 2024-08-22T05:52:56Z
canonical: "docs.safran.com/safran-project-integration-api-api-design"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.safran.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Design

## API Design

### Architecture

The API uses Microsoft's .Net Core framework, which utilities the REpresentational State Transfer (REST) architectural style. REST web services are simple, modern, HTTP-based, and accessible to various external applications (mobile, web, desktop, etc.). The initial version of the API supports both XML and JSON response types. As the JSON response is smaller in size, that type is preferred.

Calls to the API have the following format:

https://

e.g. https://localhost:3961/v1/projects retrieves all projects https://localhost:3961/v1/projects/19 retrieves project with project_id = 19

A sample JSON API response:

```
{
  "projects": {
    "project": [
      {
        "project_id":1,
        "project_name":"First Project",
        "network_id":1,
        "network_name":"First Project"
      },
      {
        "project_id":3,
        "project_name":"Third Project",
        "network_id":3,
        "network_name":"Third Project"
      },
      {
        "project_id":7,
        "project_name":"Seventh Project",
        "network_id":7,
        "network_name":"Seventh Project"
      }
    ]
  }
}
```

          Project Network Terminology

          

Since Safran Project now only uses the "Project" terminology and not the "Network" terminology, "project_name" and "network_name" will always contain the same value. Likewise, for "project_title" and "network_description." "project_id" and "network_id" will usually be the same for new Safran 7 installations.