SonaGetCreditsByDateRange

Description¶

This function will provide information on each credit within a given date range.

Input Parameters¶

Below are the following input parameters for use with the SonaGetCreditsByDateRange API function.

Parameter	Description / Possible Values
`api_key`	Use API key generated for Sona admin user
`start_date`	The start date of the date range to include. Date must be formatted as: YYYY-MM-DD.
`end_date`	The end date of the date range to include. Date must be formatted as: YYYY-MM-DD.

Output Parameters¶

Will return an array of APICreditItem class.

Error Codes¶

Below are the possible error messages encountered and their respective descriptions.

Error Type	Error Code	Description
Authentication Failed	-1 through -7	Standard authentication errors
Error Code	-8	Invalid end date
Error Code	-9	Start date is after end date
Error Code	-10	Invalid start date
Error Code	-11	No credit record found for selected date range

Sample Input¶

Request URL

https://myschool.sona-systems.com/services/SonaAPI.svc/SonaGetCreditsByDateRange?api_key=YOUR_API_KEY&start_date=2014-01-01&end_date=2014-12-31

URL components

Component	Value
Scheme	`https`
Host	`myschool.sona-systems.com`
Service path	`/services/SonaAPI.svc`
Function	`SonaGetCreditsByDateRange`

Query parameters

api_key = YOUR_API_KEY
start_date = 2014-01-01
end_date = 2014-12-31

Sample Output¶

<SonaGetCreditsByDateRangeResponse
  xmlns="https://www.sona-systems.com/"
  xmlns:a="http://schemas.datacontract.org/2004/07/emsdotnet.sonasystems"
  xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <SonaGetCreditsByDateRangeResult>
    <a:Errors i:nil="true" />
    <a:Result>
      <a:APICreditItem>
        <a:class_id>99</a:class_id>
        <a:comments />
        <a:credit_id>1749</a:credit_id>
        <a:credit_type>E</a:credit_type>
        <a:date_granted>2014-11-22T00:00:00</a:date_granted>
        <a:email>[email protected]</a:email>
        <a:experiment_id>152</a:experiment_id>
        <a:first_name>Jay</a:first_name>
        <a:grantor_id>11507</a:grantor_id>
        <a:last_name>Smith</a:last_name>
        <a:manual_credit_flag>0</a:manual_credit_flag>
        <a:occur_date>2014-06-26T15:00:08</a:occur_date>
        <a:payment_amount>0</a:payment_amount>
        <a:payment_status>W</a:payment_status>
        <a:payment_status_last_updated>0001-01-01T00:00:00</a:payment_status_last_updated>
        <a:penalty_credit>0</a:penalty_credit>
        <a:person_id>11570</a:person_id>
        <a:show_credit>0</a:show_credit>
        <a:signup_id>1749</a:signup_id>
        <a:student_id_num />
        <a:user_id>1666134</a:user_id>
      </a:APICreditItem>
      <a:APICreditItem>
        <a:class_id>97</a:class_id>
        <a:comments />
        <a:credit_id>1897</a:credit_id>
        <a:credit_type>G</a:credit_type>
        <a:date_granted>2014-12-09T00:00:00</a:date_granted>
        <a:email>[email protected]</a:email>
        <a:experiment_id>152</a:experiment_id>
        <a:first_name>Bill</a:first_name>
        <a:grantor_id>11423</a:grantor_id>
        <a:last_name>Jones</a:last_name>
        <a:manual_credit_flag>0</a:manual_credit_flag>
        <a:occur_date>2014-06-26T15:00:08</a:occur_date>
        <a:payment_amount>12.34</a:payment_amount>
        <a:payment_status>E</a:payment_status>
        <a:payment_status_last_updated>2013-12-09T12:30:00</a:payment_status_last_updated>
        <a:penalty_credit>0</a:penalty_credit>
        <a:person_id>11672</a:person_id>
        <a:show_credit>0.50</a:show_credit>
        <a:signup_id>1897</a:signup_id>
        <a:student_id_num />
        <a:user_id>4523445</a:user_id>
      </a:APICreditItem>
      <a:APICreditItem>
        <a:class_id>101</a:class_id>
        <a:comments />
        <a:credit_id>1948</a:credit_id>
        <a:credit_type>G</a:credit_type>
        <a:date_granted>2014-12-09T00:00:00</a:date_granted>
        <a:email>[email protected]</a:email>
        <a:experiment_id>152</a:experiment_id>
        <a:first_name>Lisa</a:first_name>
        <a:grantor_id>11423</a:grantor_id>
        <a:last_name>Goodman</a:last_name>
        <a:manual_credit_flag>0</a:manual_credit_flag>
        <a:occur_date>2014-06-26T15:00:08</a:occur_date>
        <a:payment_amount>12.34</a:payment_amount>
        <a:payment_status>C</a:payment_status>
        <a:payment_status_last_updated>2013-12-09T14:30:00</a:payment_status_last_updated>
        <a:penalty_credit>0</a:penalty_credit>
        <a:person_id>11661</a:person_id>
        <a:show_credit>0.50</a:show_credit>
        <a:signup_id>1948</a:signup_id>
        <a:student_id_num />
        <a:user_id>1657823</a:user_id>
      </a:APICreditItem>
    </a:Result>
  </SonaGetCreditsByDateRangeResult>
</SonaGetCreditsByDateRangeResponse>