BLbluestaq
Supporting Data

GET /udl/organizationdetails/findBySource

Changed on

Service operation to get a single OrganizationDetails by a source passed as a query parameter. OrganizationDetails represent details of organizations such as a corporation, manufacturer, consortium, government, etc. An organization can have detail records from several sources.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/organizationdetails/findBySource
  • Auth
    none declared

Query parameters

sourcestring required

The source of the OrganizationDetails records to find.

namestring required

Organization details name.

firstResultinteger
maxResultsinteger

Response

OK

idstring

Unique identifier of the record, auto-generated by the system.

idOrganizationstring required

Unique identifier of the parent organization.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

namestring required

Organization details name.

emailstring

Listed contact email address for the organization.

address1string

Street number of the organization.

address2string

Field for additional organization address information such as PO Box and unit number.

address3string

Contains the third line of address information for an organization.

geoAdminLevel1string

Administrative boundaries of the first sub-national level. Level 1 is simply the largest demarcation under whatever demarcation criteria has been determined by the governing body. For example, this may be a state or province.

geoAdminLevel2string

Administrative boundaries of the second sub-national level. Level 2 is simply the second largest demarcation under whatever demarcation criteria has been determined by the governing body. For example, this may be a county or district.

geoAdminLevel3string

Administrative boundaries of the third sub-national level. Level 3 is simply the third largest demarcation under whatever demarcation criteria has been determined by the governing body. For example, this may be a city or township.

postalCodestring

A postal code, such as PIN or ZIP Code, is a series of letters or digits or both included in the postal address of the organization.

descriptionstring

Organization description.

formerOrgIdstring

Former organization ID (if this organization previously existed as another organization).

parentOrgIdstring

Parent organization ID of this organization if it is a child organization.

financialYearEndDatestring date-time

For organizations of type CORPORATION, the effective financial year end date for revenue, EBITDA, and profit values.

revenuenumber double

For organizations of type CORPORATION, total annual revenue as of financialYearEndDate in US Dollars.

profitnumber double

For organizations of type CORPORATION, total annual profit as of financialYearEndDate in US Dollars.

ebitdanumber double

For organizations of type CORPORATION, the company EBITDA value as of financialYearEndDate in US Dollars.

ftesinteger

Total number of FTEs in this organization.

brokerstring

Designated broker for this organization.

ceostring

For organizations of type CORPORATION, the name of the Chief Executive Officer.

cfostring

For organizations of type CORPORATION, the name of the Chief Financial Officer.

ctostring

For organizations of type CORPORATION, the name of the Chief Technology Officer.

riskManagerstring

The name of the risk manager for the organization.

massRankinginteger

Mass ranking for this organization.

revenueRankinginteger

Revenue ranking for this organization.

financialNotesstring

For organizations of type CORPORATION, notes on company financials.

servicesNotesstring

Notes on the services provided by the organization.

fleetPlanNotesstring

Satellite fleet planning notes for this organization.

sourcestring required

Source of the data.

originstring

Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin.

dataMode'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE' required

Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data:

REAL: Data collected or produced that pertains to real-world objects, events, and analysis.

TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics.

EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data.

SIMULATED: Synthetic data generated by a model to mimic real-world datasets.

createdAtstring date-time

Time the row was created in the database, auto-populated by the system.

createdBystring

Application user who created the row in the database, auto-populated by the system.

origNetworkstring

The originating source network on which this record was created, auto-populated by the system.

Example response

[
  {
    "id": "ORGANIZATIONDETAILS-ID",
    "idOrganization": "ORGANIZATION-ID",
    "classificationMarking": "U",
    "name": "some.user",
    "email": "some_organization@organization.com",
    "address1": "123 Main Street",
    "address2": "Apt 4B",
    "address3": "Colorado Springs CO, 80903",
    "geoAdminLevel1": "Colorado",
    "geoAdminLevel2": "El Paso County",
    "geoAdminLevel3": "Colorado Springs",
    "postalCode": "80903",
    "description": "Example description",
    "formerOrgId": "FORMERORG-ID",
    "parentOrgId": "PARENTORG-ID",
    "financialYearEndDate": "2021-01-01T01:01:01.123Z",
    "revenue": 123.4,
    "profit": 123.4,
    "ebitda": 123.4,
    "ftes": 123,
    "broker": "some.user",
    "ceo": "some.user",
    "cfo": "some.user",
    "cto": "some.user",
    "riskManager": "some.user",
    "massRanking": 123,
    "revenueRanking": 123,
    "financialNotes": "Example notes",
    "servicesNotes": "Example notes",
    "fleetPlanNotes": "Example notes",
    "source": "some.user",
    "origin": "some.user",
    "dataMode": "TEST",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "origNetwork": "OPS1"
  }
]

Changes

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

  • 75f764c843a9Revision changes
    • info

      api operation id findBySource_1 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.