As a primary component of the DynamicEngineAPI, GetReportByID will execute a bonus report for the rep and period provided.
- Credentials: Standard Username and Password to authenticate the API user. See ByDesignCredentials.
- RepDID (Integer): RepDID for the rep. Note that this is not currently compatible with clients using an alphanumeric RepDID
- CompReportID (Integer): Report requsted. See DynamicEngineAPI ReportIDs
- PeriodDescriptionID (Integer): Period to report on. See GetPeriodDescriptions
- LocaleID (Integer): Locale for translations, if available. See OnlineAPI::GetLocales
- RequestID (Integer): Unique Id for the request made.
- Success (Integer): 0 indicates failure. 1 indicates success.
- Message (String): Error message, if applicable
- ReportTitle (String): Title of the report requested.
- DS (DataSet): The collective data returned by the report. This will vary per report.
- Invalid Credentials
- Invalid RepDID Number
- NO_DATA_FOR_SPECIFIED_CYCLE
- Access to this report is not allowed
- This function will fail if called for an alphanumeric RepDID.
- This report will only display information from reports that are exposed to API. To enable a Dynamic Compensation Report for use, please contact Client Support.
- If there are multiple bonus runs for the same period, only the oldest will currently be returned.
- Verify that a bonus run (and only 1 bonus run) exists for the period provided.
- Verify that the period provided exists
- This function will not return information on Bonus Runs that are Unofficial and Manually Executed
Request
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetReportByID xmlns="http://www.securefreedom.com/">
<cred>
<Username>string</Username>
<Password>string</Password>
<Token>string</Token>
</cred>
<repDID>string</repDID>
<CompReportID>int</CompReportID>
<PeriodDescriptionID>int</PeriodDescriptionID>
<LocaleID>int</LocaleID>
</GetReportByID>
</soap:Body>
</soap:Envelope>
Response
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetReportByIDResponse xmlns="http://www.securefreedom.com/">
<GetReportByIDResult>
<ReportTitle>string</ReportTitle>
<ds>
<xsd:schema>schema</xsd:schema>xml</ds>
</GetReportByIDResult>
</GetReportByIDResponse>
</soap:Body>
</soap:Envelope>