ExportClients
- Thomas Sherman (Deactivated)
- Bettina Borces
Rate Limiting
In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm. When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate. Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly. For more information please visit: Projector Rate Limiting Behavior.
Request
The service request contains:
Name | Data Type | Required? | Default Value | Discussion |
|---|---|---|---|---|
IncludeInactiveFlag | boolean | no | false | If false then inactive clients are not exported. |
MaxRowsToReturn | int | no | 1000 | The maximum number of clients to be exported. Values greater than 1000 may fail due to system-enforced transaction time limits. |
IncludeIdsAfter | int | no | Export is limited to resources whose internal Projector ID comes after this ID. To avoid skipping or duplicating exported items set this to the last ClientId from the previous result set. | |
OnlyCountRows | boolean | no | false | If true, then only the RowCount is returned. |
Response
For each resource in the result set the following data is returned:
Name | Data Type | Discussion |
|---|---|---|
ClientId | int | Projector's internal identifier for the client. This is used only to avoid skipping or duplicating exported resources. |
ClientName | string | |
ClientNumber | string | |
ParentClientId | int | Internal identifier |
ParentClientName | string | |
ParentClientNumber | string | |
StandardRateCardId | int | Internal identifier |
StandardRateCardName | string | |
StandardDiscountPercent | double | |
InheritAddressFlag | boolean | True if the address is inherited from the parent client |
AddressAttention | string | |
AddressCompanyName | string | |
AddressLine1 | string | |
AddressLine2 | string | |
AddressCity | string | |
AddressStateOrProvince | string | |
AddressZipOrPostalCode | string | |
AddressCountry | string | |
InactiveFlag | bool | |
ClientUdfs | list of ClientUdf | |
StandardContractDiscountPercent | double | |
StandardBillingAdjustedDiscountPercent | double |
Change Log
4.4
Parameter | Notes |
|---|---|
StandardContractDiscountPercent | Added as a response parameter |
StandardBillingAdjustedDiscountPercent | Added as a response parameter |