Tuesday, July 16, 2024

Client - Notify Change
Action:
GET
Method:
GET
URL: /api/v1/client/notifychange/get
Description: Fetch Client Notify Change records based on Generation Date
Type Key DataType Notes
Headers api-key String Your Api-Key
Params Date Date Data Feed Date / Generation Date
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of Client Notify Change records
[{
 "DataFeedID": 55,
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 170352,
 "EntityFullName": "VLADIMIR SPIRIDONOVICH PUTIN",
 "Area": 1,
 "AreaName": "Match Discounted",
 "DataFeedDate": "2024-07-16 00:00:00",
 "Notify": true,
 "Deleted": false,
 "RecordChanged": true,
 "ClassificationChanged": false,
 "NameChanged": false,
 "DateChanged": true,
 "AddressChanged": true,
 "CountryChanged": false
 "UserGroupID": "203"
 "UserGroupName": "Handler Group"
 "UserID": "105"
 "UserName": "Fred Jones"
}]
Field Data Type
DataFeedID Int 32
ClientEntityID Int 32
ClientEntityInterfaceReference Text 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
Area Byte
AreaName Text 150
DataFeedDate Date
Notify Boolean
Deleted Boolean
RecordChanged Boolean
ClassificationChanged Boolean
NameChanged Boolean
DateChanged Boolean
AddressChanged Boolean
CountryChanged Boolean
UserGroupID Int 16
UserGroupName Text 150
UserID Int 16
UserName Text 150
Action:
GET RANGE
Method:
GET
URL: /api/v1/client/notifychange/getrange
Description: Fetch Client Notify Change records based on a range of Generation Dates
Type Key DataType Notes
Headers api-key String Your Api-Key
Params StartDate Date Start Date
Params EndDate Date End Date
Params BusinessUnitID Int32 Business Unit Identifier (optional - value defaulted to 10 if not provided)
Params ReturnFormat String Json or Xml
Return Data: Json or XML collection of Client Notify Change records
[{
 "DataFeedID": 55,
 "ClientEntityID": 1234,
 "ClientEntityInterfaceReference": "AB1234",
 "ClientEntityLastName": "PUTIN",
 "ClientEntityFirstName": "VLADIMIR",
 "ClientEntityMiddleName": "",
 "EntityID": 170352,
 "EntityFullName": "VLADIMIR SPIRIDONOVICH PUTIN",
 "Area": 1,
 "AreaName": "Match Discounted",
 "DataFeedDate": "2024-07-16 00:00:00",
 "Notify": true,
 "Deleted": false,
 "RecordChanged": true,
 "ClassificationChanged": false,
 "NameChanged": false,
 "DateChanged": true,
 "AddressChanged": true,
 "CountryChanged": false
 "UserGroupID": "203"
 "UserGroupName": "Handler Group"
 "UserID": "105"
 "UserName": "Fred Jones"
}]
Field Data Type
DataFeedID Int 32
ClientEntityID Int 32
ClientEntityInterfaceReference Text 50
ClientEntityLastName Text 255
ClientEntityFirstName Text 255
ClientEntityMiddleName Text 255
EntityID Int 32
EntityFullName Text 255
Area Byte
AreaName Text 150
DataFeedDate Date
Notify Boolean
Deleted Boolean
RecordChanged Boolean
ClassificationChanged Boolean
NameChanged Boolean
DateChanged Boolean
AddressChanged Boolean
CountryChanged Boolean
UserGroupID Int 16
UserGroupName Text 150
UserID Int 16
UserName Text 150