POST PublishedProjects/{languageCode}

Returns published projects matching with some search criterias.

Request Information

URI Parameters

Name	Description	Type	Additional information
languageCode	Language code, "en" by default	string	Required

Body Parameters

Search parameters

ParamsSearchProjects

Name	Description	Type	Additional information
Territories	Defines the list of desired territories.	Collection of Territory	None.
Sectors	Defines the list of desired sectors.	Collection of Sector	None.
Subsectors	Defines the list of desired subsectors.	Collection of Subsector	None.
GlobalCompletion	Defines the desired range for global project completion.	RangeOfDouble	None.
EstimatedCapitalCost	Defines the desired range for estimated capital cost.	RangeOfDouble	None.
OperationMaintenanceCost	Defines the desired range for operation & maintenance cost	RangeOfDouble	None.

Request Formats

application/json, text/json

Sample:

{
  "Territories": [
    {
      "Id": 2,
      "Value": "sample string 3"
    },
    {
      "Id": 2,
      "Value": "sample string 3"
    }
  ],
  "Sectors": [
    {
      "Id": 2,
      "Value": "sample string 3"
    },
    {
      "Id": 2,
      "Value": "sample string 3"
    }
  ],
  "Subsectors": [
    {
      "Sector": {
        "Id": 2,
        "Value": "sample string 3"
      },
      "Id": 2,
      "Value": "sample string 3"
    },
    {
      "Sector": {
        "Id": 2,
        "Value": "sample string 3"
      },
      "Id": 2,
      "Value": "sample string 3"
    }
  ],
  "GlobalCompletion": {
    "Minimum": 1.1,
    "Maximum": 2.1
  },
  "EstimatedCapitalCost": {
    "Minimum": 1.1,
    "Maximum": 2.1
  },
  "OperationMaintenanceCost": {
    "Minimum": 1.1,
    "Maximum": 2.1
  }
}

application/xml, text/xml

Sample:

<ParamsSearchProjects xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sif.Source.Api.Models">
  <EstimatedCapitalCost xmlns:d2p1="http://schemas.datacontract.org/2004/07/Sif.Source.Api.Common">
    <d2p1:Maximum>2.1</d2p1:Maximum>
    <d2p1:Minimum>1.1</d2p1:Minimum>
  </EstimatedCapitalCost>
  <GlobalCompletion xmlns:d2p1="http://schemas.datacontract.org/2004/07/Sif.Source.Api.Common">
    <d2p1:Maximum>2.1</d2p1:Maximum>
    <d2p1:Minimum>1.1</d2p1:Minimum>
  </GlobalCompletion>
  <OperationMaintenanceCost xmlns:d2p1="http://schemas.datacontract.org/2004/07/Sif.Source.Api.Common">
    <d2p1:Maximum>2.1</d2p1:Maximum>
    <d2p1:Minimum>1.1</d2p1:Minimum>
  </OperationMaintenanceCost>
  <Sectors>
    <Sector>
      <Id>2</Id>
      <Value>sample string 3</Value>
    </Sector>
    <Sector>
      <Id>2</Id>
      <Value>sample string 3</Value>
    </Sector>
  </Sectors>
  <Subsectors>
    <Subsector>
      <Id>2</Id>
      <Value>sample string 3</Value>
      <Sector>
        <Id>2</Id>
        <Value>sample string 3</Value>
      </Sector>
    </Subsector>
    <Subsector>
      <Id>2</Id>
      <Value>sample string 3</Value>
      <Sector>
        <Id>2</Id>
        <Value>sample string 3</Value>
      </Sector>
    </Subsector>
  </Subsectors>
  <Territories>
    <Territory>
      <Id>2</Id>
      <Value>sample string 3</Value>
    </Territory>
    <Territory>
      <Id>2</Id>
      <Value>sample string 3</Value>
    </Territory>
  </Territories>
</ParamsSearchProjects>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of published projects

Collection of SourcePublishedProject

Name	Description	Type	Additional information
PMLeaderEmail	Defines the project's PM email.	string	None.
PMLeaderFirstName	Defines the project's PM FirstName.	string	None.
PMLeaderLastName	Defines the project's PM LastName.	string	None.
PublishedAssessments	Published assessments if any	Collection of PublishedAssessment	None.
PublishedDocuments	Published documents if any	Collection of Document	None.
Timeline	Published timeline	ProjectTimeline	None.
CostEstimatedCapital	[Obsolete] Defines the project's estimated capital cost (CAPEX).	decimal number	None.
Completions	Defines project's Completions (global, by stages and by themes).	Dictionary of string [key] and decimal number [value]	None.
Contacts	Published contacts if any	Collection of Contact	None.
Guid	Defines the project Id.	globally unique identifier	None.
Name	Defines the project's name.	string	None.
Description	Defines the project's description.	string	None.
Sector	Defines the project's sector.	ReferenceData	None.
SubSector	Defines the project's subsector.	ReferenceData	None.
OtherSubsector	Defines the project's other subsector.	ReferenceDataTaxonomy	None.
Territories	Defines the project's territories.	Collection of ReferenceData	None.
Locations	Defines the project's locations.	Collection of string	None.
OtherLocation	Defines the project's other location	string	None.
TypeOfProject	Defines the type(s) of the project.	Collection of string	None.
IsPPP	Defines the project's isPPP.	boolean	None.
IsUnsolicited	Defines the project's is unsolicited.	boolean	None.
LegalFramework	Defines the project's legal framework.	CustomFieldValue	None.
Packages	Defines the project's packages	Collection of Package	None.
OtherContractualArrangement	Defines the project's other contractual arrangement.	string	None.
TechnicalSupport	Defines the project's technical support.	CustomFieldValue	None.
Threshold	Defines the project's threshold.	CustomFieldValue	None.
OwnerOrganisation	Defines the project's owner organisation.	ReferenceData	None.
CurrentProjectStatus	Defines the project's current project status.	ReferenceData	None.
CurrentProjectStatusCustom	Defines the project's current project status custom.	ReferenceData	None.
Completion	Defines project's global completion	decimal number	None.
Created	Defines the project's creation date.	date	None.
Modified	Defines the project's last update date.	date	None.
ProjectEstimatedDueDate	Defines the project's estimated due date.	date	None.
EstimatedCapitalCost	Defines the project's estimated capital cost in $.	decimal number	None.
OriginalCurrency	Defines the project's original currency.	ReferenceData	None.
OriginalCurrencyEstimatedCapitalCost	Defines the project's estimated capital cost in original currency.	decimal number	None.
SiteUrl	Defines the project's site url.	string	None.
ProjectProperties	Defines the project's property bag.	PropertyBagProject	None.
PMLeaderOrganisation	Defines the project's PM Organisation.	string	None.
PMLeaderTelephone	Defines the project's PM Telephone.	string	None.
GPSCoordinates	GPS Coordinates	Collection of GPSCoordinate	None.
PublicationDate	Date of publication	date	None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.