Tuesday, July 16, 2024

Client - Onboarding Sayari Source
Action:
GET
Method:
GET
URL: /api/v1/client/onboardingsayarisource/get
Description: Fetch Sayari Source
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ClientProspectGroupID Int32 Client Prospect Group Identifier
Params SayariEntityID Int32 Sayari Entity Identifier
Params SourceID Int32 Sayari Source Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Sayari Source
{
 "BusinessUnitID": 10,
 "ClientProspectGroupID": 50,
 "SayariEntityID": 1,
 "RelationshipID": 0,
 "SourceID": 10,
 "Name": "Company Record from USA SEC Central Index Key Database",
 "SayariRecordUniqueReference": "ecdfb3f2ecc8c3797e77d5795a8066ef/00233462/1626307212345",
 "Url": "https://www.sec.gov/Archives/edgar/cik-lookup-data.txt",
 "AcquisitionDate": "2021-03-24",
 "PublicationDate": "2021-03-24",
 "SayariSourceTypeID": 1
}
Field Data Type
BusinessUnitID Int32
ProspectGroupID Int32
SayariEntityID Int32
RelationshipID Int32
SourceID Int32
Name Text 255
SayariRecordUniqueReference Text 255
Url Text 255
Acquisition Date Text 20
Publication Date Text 20
SayariSourceTypeID Byte
Action:
GET ALL
Method:
GET
URL: /api/v1/client/onboardingsayarisource/getall
Description: Fetch Sayari Sources for Prospect Group
Type Key DataType Notes
Headers api-key String Your Api-Key
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ClientProspectGroupID Int32 Client Prospect Group Identifier
Params SayariEntityID Int32 Sayari Entity Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of Client Onboarding Sayari Sources
[{
 "BusinessUnitID": 10,
 "ClientProspectGroupID": 50,
 "SayariEntityID": 1,
 "RelationshipID": 0,
 "SourceID": 10,
 "Name": "Company Record from USA SEC Central Index Key Database",
 "SayariRecordUniqueReference": "ecdfb3f2ecc8c3797e77d5795a8066ef/00233462/1626307212345",
 "Url": "https://www.sec.gov/Archives/edgar/cik-lookup-data.txt",
 "AcquisitionDate": "2021-03-24",
 "PublicationDate": "2021-03-24",
 "SayariSourceTypeID": 1
}]
Field Data Type
BusinessUnitID Int32
ProspectGroupID Int32
SayariEntityID Int32
RelationshipID Int32
SourceID Int32
Name Text 255
SayariRecordUniqueReference Text 255
Url Text 255
Acquisition Date Text 20
Publication Date Text 20
SayariSourceTypeID Byte
Action:
ADD
Method:
POST
URL: /api/v1/client/onboardingsayarisource/add
Description: Add Sayari Source
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectGroupID Int32 Client Prospect Group Identifier
Body SayariEntityID Int32 Sayari Entity Identifier
Body Name Text 255 Sayari Source Name
Body SayariRecordUniqueReference Text 255 Sayari Record unique Reference
Body Url Text 100 Sayari Source Url
Body PublicationDate Text 20 Publication Date[-Month][-Year]
Body AcquisitionDate Text 20 Acquisition Date[-Month][-Year]
Body SayariSourceTypeID Byte Sayari Source Type (About = 1, Mentions = 2)
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Sayari Source added.
{
 "BusinessUnitID": 10,
 "ClientProspectGroupID": 50,
 "SayariEntityID": 1,
 "RelationshipID": 0,
 "SourceID": 10,
 "Name": "Company Record from USA SEC Central Index Key Database",
 "SayariRecordUniqueReference": "ecdfb3f2ecc8c3797e77d5795a8066ef/00233462/1626307212345",
 "Url": "https://www.sec.gov/Archives/edgar/cik-lookup-data.txt",
 "AcquisitionDate": "2021-03-24",
 "PublicationDate": "2021-03-24",
 "SayariSourceTypeID": 1
}
Field Data Type
ClientOnboardingSayariSource Collection
 Same as Get Method results above.
Action:
UPDATE
Method:
PUT
URL: /api/v1/client/onboardingsayarisource/update
Description: Update Sayari Source
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectGroupID Int32 Client Prospect Group Identifier
Body SayariEntityID Int32 Sayari Entity Identifier
Body SourceID Int32 Sayari Source Identifier
Body Name Text 255 Sayari Source Name
Body SayariRecordUniqueReference Text 255 Sayari Record Unique Reference
Body Url Text 100 Sayari Source Url
Body PublicationDate Text 20 Publication Date[-Month][-Year]
Body AcquisitionDate Text 20 Acquisition Date[-Month][-Year]
Body SayariSourceTypeID Byte Sayari Source Type (About = 1, Mentions = 2)
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Sayari Source updated.
{
 "BusinessUnitID": 10,
 "ClientProspectGroupID": 50,
 "SayariEntityID": 1,
 "RelationshipID": 0,
 "SourceID": 10,
 "Name": "Company Record from USA SEC Central Index Key Database",
 "SayariRecordUniqueReference": "ecdfb3f2ecc8c3797e77d5795a8066ef/00233462/1626307212345",
 "Url": "https://www.sec.gov/Archives/edgar/cik-lookup-data.txt",
 "AcquisitionDate": "2021-03-24",
 "PublicationDate": "2021-03-24",
 "SayariSourceTypeID": 1
}
Field Data Type
ClientOnboardingSayariSource Collection
 Same as Get Method results above.
Action:
DELETE
Method:
DELETE
URL: /api/v1/client/onboardingsayarisource/delete
Description: Delete Sayari Source
Type Key DataType Notes
Headers api-key String Your Api-Key
Headers Content-Type String Enter value: application/x-www-form-urlencoded
Body BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Body ClientProspectGroupID Int32 Client Prospect Group Identifier
Body SayariEntityID Int32 Sayari Entity Identifier
Body SourceID Int32 Sayari Source Identifier
Body ActionUserID Int16 Identifier of the User performing action.
Body ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Sayari Source deleted.
{
 "BusinessUnitID": 10,
 "ClientProspectGroupID": 50,
 "SayariEntityID": 1,
 "RelationshipID": 0,
 "SourceID": 10,
 "Name": "Company Record from USA SEC Central Index Key Database",
 "SayariRecordUniqueReference": "ecdfb3f2ecc8c3797e77d5795a8066ef/00233462/1626307212345",
 "Url": "https://www.sec.gov/Archives/edgar/cik-lookup-data.txt",
 "AcquisitionDate": "2021-03-24",
 "PublicationDate": "2021-03-24",
 "SayariSourceTypeID": 1
} }
Field Data Type
ClientOnboardingSayariSource Collection
 Same as Get Method results above.