Action: | GET | |||||||||||||||||
Method: | GET | |||||||||||||||||
URL: | /api/v1/client/onboardingsayarientity/get | |||||||||||||||||
Description: | Fetch 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 of the Client Onboarding Sayari Entity { "BusinessUnitID": 10, "ClientProspectGroupID": 50, "SayariEntityID": 10, "SayariEntityName": "Brewan Howard", "SayariEntityUniqueReference": "LYEdVCoB3eOcaOhRMtOc_g", "SayariEntityTypeID": 1 } |
|
Action: | GET ALL | |||||||||||||||||
Method: | GET | |||||||||||||||||
URL: | /api/v1/client/onboardingsayarientity/getall | |||||||||||||||||
Description: | Fetch Sayari Entities 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 | ReturnFormat | String | Json or Xml | |||||||||||||||
Return Data: |
Json or XML collection of Client Onboarding Sayari Entities [{ "BusinessUnitID": 10, "ClientProspectGroupID": 50, "SayariEntityID": 10, "SayariEntityName": "", "SayariEntityUniqueReference": "", "SayariEntityTypeID": 1 }] |
|
Action: | ADD | |||||||||
Method: | POST | |||||||||
URL: | /api/v1/client/onboardingsayarientity/add | |||||||||
Description: | Add Sayari Entity | |||||||||
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 | SayariEntityName | Text 255 | Sayari Entity Name | |||||||
Body | SayariEntityUniqueReference | Text 100 | Sayari Entity Unique Reference | |||||||
Body | SayariEntityTypeID | Byte | Sayari Entity Type (Person = 1, Company = 2, Vessel = 3, Intellectual Property = 4, Legal Matter = 5, Generic = 6, Security = 7, Tradename = 8, Property = 9, Aircraft = 10) | |||||||
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 added. { "BusinessUnitID": 10, "ClientProspectGroupID": 50, "SayariEntityName": "Brewan Howard", "SayariEntityUniqueReference": "LYEdVCoB3eOcaOhRMtOc_g", "SayariEntityTypeID": 1 } |
|
Action: | UPDATE | |||||||||
Method: | PUT | |||||||||
URL: | /api/v1/client/onboardingsayarientity/update | |||||||||
Description: | Update Sayari Entity | |||||||||
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 | SayariEntityName | Text 510 | Sayari Entity Name | |||||||
Body | SayariEntityUniqueReference | Text 510 | Sayari Entity Unique Reference | |||||||
Body | SayariEntityTypeID | Byte | Sayari Entity Type (Person = 1, Company = 2, Vessel = 3, Intellectual Property = 4, Legal Matter = 5, Generic = 6, Security = 7, Tradename = 8, Property = 9, Aircraft = 10) | |||||||
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 updated. { "BusinessUnitID": 10, "ClientProspectGroupID": 50, "SayariEntityID": 10, "SayariEntityName": "Brewan Howard", "SayariEntityUniqueReference": "LYEdVCoB3eOcaOhRMtOc_g", "SayariEntityTypeID": 1 } |
|
Action: | DELETE | |||||||||
Method: | DELETE | |||||||||
URL: | /api/v1/client/onboardingsayarientity/delete | |||||||||
Description: | Delete Sayari Entity | |||||||||
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 | 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 deleted. { "BusinessUnitID": 10, "ClientProspectGroupID": 50, "SayariEntityID": 10, "SayariEntityName": "Brewan Howard", "SayariEntityUniqueReference": "LYEdVCoB3eOcaOhRMtOc_g", "SayariEntityTypeID": 1 } } |
|