Data Entity

Data - Entity

Action:

GET

Method:

GET

URL:

/api/v1/data/entity/get

Description:

Fetch a Dow Jones Data Entity based on Identifier

Type

Key

DataType

Notes

Headers

api-key

String

Your Api-Key

Params

EntityID

Int32

Entity Identifier

Params

ReturnFormat

String

Json or Xml

Return Data:

Json or XML of the Data Entity
{
"EntityID": 98141,
"EntityTypeID": 1,
"EntityTypeName": "Person",
"LastName": "PUTIN",
"FirstName": "VLADIMIR",
"MiddleName": "VLADIMIROVICH",
"FullName": "VLADIMIR VLADIMIROVICH PUTIN",
"Title": "",
"Suffix": "",
"GenderID": 1,
"GenderName": "Male",
"StatusID": 1,
"StatusName": "Active",
"Deceased": false,
"IsPEP": true,
"IsRCA": false,
"IsWBL": false,
"IsSAN": false,
"IsAVM": false,
"IsOTH": false,
"IsUNK": false,
"ActionDate": "22-Jun-2018"
}

Field	Data Type
EntityID	Int 32
EntityTypeID	Byte
EntityTypeName	Text 150
LastName	Text 255
FirstName	Text 255
MiddleName	Text 255
FullName	Text 255
Title	Text 255
Suffix	Text 255
GenderID	Byte
GenderName	Text 150
StatusID	Byte
StatusName	Text 150
Deceased	Boolean
IsPEP	Boolean
IsRCA	Boolean
IsWBL	Boolean
IsSAN	Boolean
IsAVM	Boolean
IsOTH	Boolean
IsUNK	Boolean
ActionDate	Text 12

Action:

GET DETAIL

Method:

GET

URL:

/api/v1/data/entity/getdetail

Description:

Fetch a Dow Jones Data Entities Detail based on Identifier

Type

Key

DataType

Notes

Headers

api-key

String

Your Api-Key

Params

EntityID

Int32

Entity Identifier

Params

SuppressIdentifiers

Boolean

Suppress Identifiers in the returned Detail

Params

IncludeAddress

Boolean

Include Address data in the returned Detail

Params

IncludeAlias

Boolean

Include Alias data in the returned Detail

Params

IncludeBirthPlace

Boolean

Include Birth Place data in the returned Detail

Params

IncludeCountry

Boolean

Include Country data in the returned Detail

Params

IncludeDate

Boolean

Include Date data in the returned Detail

Params

IncludeDescription

Boolean

Include Description data in the returned Detail

Params

IncludeIdentity

Boolean

Include Identity data in the returned Detail

Params

IncludeImage

Boolean

Include Image data in the returned Detail

Params

IncludeNote

Boolean

Include Note data in the returned Detail

Params

IncludeOrigin

Boolean

Include Origin data in the returned Detail

Params

IncludeRelationshipDirect

Boolean

Include Relationship Direct data in the returned Detail

Params

IncludeRelationshipIndirect

Boolean

Include Relationship Indirect data in the returned Detail

Params

IncludeRole

Boolean

Include Role data in the returned Detail

Params

IncludeSanction

Boolean

Include Sanction data in the returned Detail

Params

IncludeVessel

Boolean

Include Vessel data in the returned Detail

Params

ReturnFormat

String

Json or Xml

Return Data:

Json or XML of the Data Entity Detail (For brevity the example has been scaled down)
{
"EntityID": 98141,
"Entity": {
"EntityID": 98141,
"EntityTypeID": 1,
"EntityTypeName": "Person",
"LastName": "PUTIN",
"FirstName": "VLADIMIR",
"MiddleName": "VLADIMIROVICH",
"FullName": "VLADIMIR VLADIMIROVICH PUTIN",
"Title": "",
"Suffix": "",
"GenderID": 1,
"GenderName": "Male",
"StatusID": 1,
"StatusName": "Active",
"Deceased": false,
"IsPEP": true,
"IsRCA": false,
"IsWBL": false,
"IsSAN": false,
"IsAVM": false,
"IsOTH": false,
"IsUNK": false,
"ActionDate": "22-Jun-2018"
},
"Alias": [
{
"NameTypeID": 1,
"NameTypeName": "Primary Name",
"EntityTypeID": 1,
"LastName": "ПУТИН",
"FirstName": "ВЛАДИМИР",
"MiddleName": "ВЛАДИМИРОВИЧ",
"FullName": "ВЛАДИМИР ВЛАДИМИРОВИЧ ПУТИН",
"Title": "",
"Suffix": ""
}
],
"Address": [],
"BirthPlace": [
{
"Name": "St. Petersburg,Russia"
}
],
"Country": [
{
"CountryTypeID": 1,
"CountryTypeName": "Citizenship",
"CountryID": 182,
"CountryName": "Russia"
}
],
"Date": [
{
"DateTypeID": 1,
"DateTypeName": "Date of Birth",
"Day": "07",
"Month": "Oct",
"Year": "1952",
"Note": ""
}
],
"Description": [
{
"Description1ID": 1,
"Description1Name": "Politically Exposed Person (PEP)",
"Description2ID": 0,
"Description2Name": "",
"Description3ID": 0,
"Description3Name": ""
}
],
"Identity": [],
"Image": [
{
"URL": "http://citata.in/wp-content/uploads/2012/07/%D0%9F%D1%83%D1%82%D0%B8%D0%BD.jpg"
}
],
"Origin": [
{
"Origin": "http://news.bbc.co.uk/hi/russian/russia/newsid_7206000/7206009.stm"
}
],
"Relationship": [
{
"EntityName": "VLADIMIR VLADIMIROVICH PUTIN",
"RelationshipTypeID": 1,
"RelationshipTypeName": "Public Figure",
"AssociatedEntityID": 3391396,
"AssociatedEntityName": "OLEG VLADIMIROVICH PUTIN",
"RelationshipID": 3,
"RelationshipName": "Brother",
"CurrentRelationship": true
}
],
"IndirectRelationship": [
{
"EntityName": "OLGA ALEKSANDROVNA TSOMAEVA",
"RelationshipTypeID": 1,
"RelationshipTypeName": "Public Figure",
"AssociatedEntityID": 98141,
"AssociatedEntityName": "VLADIMIR VLADIMIROVICH PUTIN",
"RelationshipID": 12,
"RelationshipName": "Brother-in-law",
"CurrentRelationship": false
}
],
"Role": [
{
"RoleTypeID": 1,
"RoleTypeName": "Primary Occupation",
"Title": "President of Russia",
"OccupationID": 1,
"OccupationName": "Heads & Deputies State/National Government",
"SinceDay": "07",
"SinceMonth": "May",
"SinceYear": "2018",
"ToDay": "",
"ToMonth": "",
"ToYear": ""
}
],
"Sanction": [],
"Vessel": [],
"Notes": {
"Note": "Textual information about the Entity"
}
}

Field	Data Type
EntityID	Int 32
Entity	Model
Sames as Entity Get Method
Alias	Collection
Same as Alias Get Method
Address	Collection
Same as Address Get Method
BirthPlace	Collection
Same as Birth Place Get Method
Country	Collection
Same as Country Get Method
Date	Collection
Same as Date Get Method
Description	Collection
Same as Description Get Method
Identity	Collection
Same as Identity Get Method
Image	Collection
Same as Image Get Method
Origin	Collection
Same as Origin Get Method
Relationship	Collection
Same as Relationship Get Direct Method
IndirectRelationship	Collection
Same as Relationship Get Indirect Method
Role	Collection
Same as Role Get Method
Sanction	Collection
Same as Sanction Get Method
Vessel	Collection
Same as Vessel Get Method
Notes	Model
Same as Note Get Method