Skip to content
Cloud APIs
/
/
/
LicenseAggregationDto

LicenseAggregationDto

A data transfer object (DTO) representing aggregated license data (block, nation, licensees).

idinteger, (int32)

The unique id

labelstring, <= 64 characters

The label

versioninteger, (int32)

The version of the license.

startDatestring or null, (date-time)

The date from which the license is valid.

endDatestring or null, (date-time)

The date the license expires.

effectiveDatestring or null, (date-time)

The date from which the current license data is valid. A license can change during its validity period.

licenseesArray of objects(AnalysisLicenseeForAggregationDto)

The licensees of this license.

crsIdinteger or null, (int32)

Coordinate reference system unique identifier (EPSG number, like: 4326).

innerRingsArray of strings

The list of holes in the polygon representation of this license (optional).

outerRingstring

The outer ring of the polygon. If there is a polygon data, this has to be filled.

historyArray of objects(HistoryWithRealNameDto)

The change history

folderDetailsobject(AggregatedFolderParentsDto)

A data transfer object (DTO) representing the collection of parent basin and play folders of an aggregated folder.

areProspectsUpToDateboolean

True if there are no prospects associated with older versions of this license.

prospectsArray of objects(ProspectAnalysisDataForLicenseDto)

Aggregated prospect of the segment/dry/discovery analysis which has this license.

blockNamesArray of strings

Contains the distinct list of block names associated with this license.

nationNamestring

The name of the nation to which this license belongs.

nationIdinteger or null, (int32)

The unique identifier of the nation to which this license belongs.

wktPolygonstringdeprecated

Store the license geometry in wkt polygon.

{
  "id": 0,
  "label": "string",
  "version": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "effectiveDate": "2019-08-24T14:15:22Z",
  "licensees": [
    { … }
  ],
  "crsId": 0,
  "innerRings": [
    "string"
  ],
  "wktPolygon": "string",
  "outerRing": "string",
  "history": [
    { … }
  ],
  "folderDetails": {
    "basins": [ … ],
    "plays": [ … ]
  },
  "areProspectsUpToDate": true,
  "prospects": [
    { … }
  ],
  "blockNames": [
    "string"
  ],
  "nationName": "string",
  "nationId": 0
}