| Action: | IMPORT | |||||||||||||||||||||||||||||||||||||||||||||||||||
| Method: | POST | |||||||||||||||||||||||||||||||||||||||||||||||||||
| URL: | /api/v1/data/iwlentity/import | |||||||||||||||||||||||||||||||||||||||||||||||||||
| Description: | Import IWL Entity data in bulk. Adds new or updates existing. Uploading of bulk data using this method should be batched into manageable blocks of 5000 records. | |||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||||||||||
| Headers | Content-Type | String | Enter value: application/json | |||||||||||||||||||||||||||||||||||||||||||||||||
| Params | BusinessUnitID | Int32 | Business Unit Identifier (optional - value defaulted to 10 if not provided) | |||||||||||||||||||||||||||||||||||||||||||||||||
| Params | IncludeDetailInResult | Boolean | Include details of valid items in the batch in the response. | |||||||||||||||||||||||||||||||||||||||||||||||||
| Params | ActionUserID | Int16 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||||||||||
| Body | raw | Json | Json Collection of IWL Entity values | |||||||||||||||||||||||||||||||||||||||||||||||||
| Input Data: |
Aliases - Format=(NameType, LastName, FirstName, MiddleName, Title, Suffix) Primary Delimiter = ; (Semi-colon) Secondary Delimiter = , (Comma) Each alias should be separated by a semi-colon. Values for NameType, LastName, etc should be separated by a comma. [{ "InterfaceReference": "AB1234", "EntityType": "0", "GenderID": 1, "StatusID": 1, "LastName": "PUTIN", "FirstName": "VLADIMIR", "MiddleName": "", "Title": "", "Suffix": "", "Deceased": false, "IsPEP": false, "IsRCA": false, "IsWBL": false, "IsSAN": false, "IsAVM": false, "IsOTH": false, "IsUNK": false, "Aliases": "", "Dates": "", "Countries": "", "Addresses": "", "Note": "" }] |
|||||||||||||||||||||||||||||||||||||||||||||||||||
| Return Data: |
Import returns an object with volume information and two collections Rejections and Allocations. Rejections are validation errors or import rejections in the batch. Allocations are Internal and External references for any Additions in the batch. If the request query parameter 'IncludeDetailInResult' is true, the return object will contain two additional collections: 1) ValidItemsActionRequiredList and 2) ValidItemsNoActionRequiredList. ValidItemsActionRequiredList are valid items in the batch that will be added or updated. ValidItemsNoActionRequiredList are valid items in the batch that have no changes and will not be updated. These two collections will contain fields that can be used for additional validation. { "ImportRejections": 0, "ValidItemsActionRequired": 2, "ValidItemsNoActionRequired": 0, "Rejections": [], "Allocations": [ { "ItemNumber": 1, "InterfaceReference": "AB6001a", "IWLEntityID": 100000239 }, { "ItemNumber": 2, "InterfaceReference": "AB6002a", "IWLEntityID": 100000240 } ], "ValidItemsActionRequiredList": [ { "FileRow": 1, "ClientID": 100, "InterfaceReference": "AB6001a", "HandledByUserGroupID": 202 "HandledByUserID": 101 }, { "FileRow": 2, "ClientID": 100, "InterfaceReference": "AB6002a", "HandledByUserGroupID": 1240 "HandledByUserID": 101 } ], "ValidItemsNoActionRequiredList": [] } |
|
||||||||||||||||||||||||||||||||||||||||||||||||||