Tuesday, July 16, 2024

Client - Onboarding Sayari Entity Attribute
Action:
GET
Method:
GET
URL: /api/v1/client/onboardingsayarientityattribute/get
Description: Fetch Sayari Entity Attribute
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 AttributeID Int32 Sayari Entity Attribute Identifier
Params ReturnFormat String Json or Xml
Return Data: Json or XML of the Client Onboarding Sayari Entity Attribute
{
 "BusinessUnitID": 10,
 "ClientProspectGroupID": 50,
 "SayariEntityID": 10,
 "AttributeID": 208,
 "SayariEntityAttributeTypeID": 1,
 "Name": "value",
 "Value": "Pooled Investment Fund",
 "Type": "Business_Purpose0"
}
Field Data Type
BusinessUnitID Int32
ProspectGroupID Int32
SayariEntityID Int32
AttributeID Int32
SayariEntityAttributeTypeID Byte
Name Text 100
Value Text 500
Type Text 100
Action:
GET ALL
Method:
GET
URL: /api/v1/client/onboardingsayarientityattribute/getall
Description: Fetch Entity Attributes for Sayari Entity
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 Entity Attributes
[{
 "BusinessUnitID": 10,
 "ClientProspectGroupID": 50,
 "SayariEntityID": 10,
 "AttributeID": 208,
 "SayariEntityAttributeTypeID": 1,
 "Name": "",
 "Value": "Pooled Investment Fund",
 "Type": "Business_Purpose0"
}]
Field Data Type
BusinessUnitID Int32
ProspectGroupID Int32
SayariEntityID Int32
AttributeID Int32
SayariEntityAttributeTypeID Byte
Name Text 100
Value Text 500
Type Text 100
Action:
ADD
Method:
POST
URL: /api/v1/client/onboardingsayarientityattribute/add
Description: Add Sayari Entity Attribute
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 SayariEntityAttributeTypeID Byte Sayari Entity Attribute Type Identifier (Unknown = 0, Translated Name = 1, Additional Information = 2, Country = 3, Contact = 4, Status = 5, Finances = 6, Business Purpose = 7, Shares = 8, Date Of Birth = 9, Address = 10, Identifier = 11, Position = 12, Gender = 13, Company Type = 14, Name = 15, Weak Identifier = 16)
Body Name Text 100 Sayari Entity Attribute Name
Body Value Text 500 Sayari Entity Attribute Unique Reference
Body Type Text 100 Attribute Type
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 Entity Attribute added.
{
 "BusinessUnitID": 10,
 "ClientProspectGroupID": 50,
 "SayariEntityID": 10,
 "AttributeID": 208,
 "SayariEntityAttributeTypeID": 1,
 "Name": "value",
 "Value": "Pooled Investment Fund",
 "Type": "Business_Purpose0"
}
Field Data Type
ClientOnboardingSayariEntityAttribute Collection
 Same as Get Method results above.
Action:
UPDATE
Method:
PUT
URL: /api/v1/client/onboardingsayarientityattribute/update
Description: Update Sayari Entity Attribute
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 AttributeID Int32 Sayari Entity Attribute Identifier
Body SayariEntityAttributeTypeID Byte Sayari Entity Attribute Type Identifier (Unknown = 0, Translated Name = 1, Additional Information = 2, Country = 3, Contact = 4, Status = 5, Finances = 6, Business Purpose = 7, Shares = 8, Date Of Birth = 9, Address = 10, Identifier = 11, Position = 12, Gender = 13, Company Type = 14, Name = 15, Weak Identifier = 16)
Body Name Text 100 Sayari Entity Attribute Name
Body Value Text 500 Sayari Entity Attribute Unique Reference
Body Type Text 100 Attribute Type
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 Entity Attribute updated.
{
 "BusinessUnitID": 10,
 "ClientProspectGroupID": 50,
 "SayariEntityID": 10,
 "AttributeID": 208,
 "SayariEntityAttributeTypeID": 1,
 "Name": "value",
 "Value": "Pooled Investment Fund",
 "Type": "Business_Purpose0"
}
Field Data Type
ClientOnboardingSayariEntityAttribute Collection
 Same as Get Method results above.
Action:
DELETE
Method:
DELETE
URL: /api/v1/client/onboardingsayarientityattribute/delete
Description: Delete Sayari Entity Attribute
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 AttributeID Int32 Sayari Entity Attribute 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 Entity Attribute deleted.
{
 "BusinessUnitID": 10,
 "ClientProspectGroupID": 50,
 "SayariEntityID": 10,
 "AttributeID": 208,
 "SayariEntityAttributeTypeID": 1,
 "Name": "value",
 "Value": "Pooled Investment Fund",
 "Type": "Business_Purpose0"
} }
Field Data Type
ClientOnboardingSayariEntityAttribute Collection
 Same as Get Method results above.