SonaGetCreditsByPersonID

Description¶

This function will provide information on each credit and signup for the specified participant, including non-study credit grants.

Input Parameters¶

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

Parameter	Description / Possible Values
`api_key`	Use API key generated for Sona admin user
`person_id`	The numeric identifier of the participant.

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	Person (`person_id`) not found
Error Code	-9	Credit record not found
Error Code	-10	Invalid `person_id`

Sample Input¶

Request URL

https://myschool.sona-systems.com/services/SonaAPI.svc/SonaGetCreditsByPersonID?api_key=YOUR_API_KEY&person_id=11498

URL components

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

Query parameters

api_key = YOUR_API_KEY
person_id = 11498

Sample Output¶

<SonaGetCreditsByPersonIDResponse
  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">
  <SonaGetCreditsByPersonIDResult>
    <a:Errors i:nil="true" />
    <a:Result>
      <a:APICreditItem>
        <a:class_id>115</a:class_id>
        <a:comments />
        <a:credit_id>1369</a:credit_id>
        <a:credit_type>G</a:credit_type>
        <a:date_granted>2013-11-10T00:00:00</a:date_granted>
        <a:email>[email protected]</a:email>
        <a:experiment_id>159</a:experiment_id>
        <a:first_name>Jake</a:first_name>
        <a:grantor_id>11818</a:grantor_id>
        <a:last_name>Ferry</a:last_name>
        <a:manual_credit_flag>0</a:manual_credit_flag>
        <a:occur_date>2012-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>11498</a:person_id>
        <a:show_credit>0.50</a:show_credit>
        <a:signup_id>1369</a:signup_id>
        <a:student_id_num />
        <a:user_id>jferry</a:user_id>
      </a:APICreditItem>
      <a:APICreditItem>
        <a:class_id>115</a:class_id>
        <a:comments />
        <a:credit_id>1554</a:credit_id>
        <a:credit_type>G</a:credit_type>
        <a:date_granted>2013-11-16T00:00:00</a:date_granted>
        <a:email>[email protected]</a:email>
        <a:experiment_id>153</a:experiment_id>
        <a:first_name>Jake</a:first_name>
        <a:grantor_id>10144</a:grantor_id>
        <a:last_name> Ferry </a:last_name>
        <a:manual_credit_flag>0</a:manual_credit_flag>
        <a:occur_date>2012-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-11-16T12:30:00</a:payment_status_last_updated>
        <a:penalty_credit>0</a:penalty_credit>
        <a:person_id>11498</a:person_id>
        <a:show_credit>0.50</a:show_credit>
        <a:signup_id>1554</a:signup_id>
        <a:student_id_num />
        <a:user_id>jferry</a:user_id>
      </a:APICreditItem>
      <a:APICreditItem>
        <a:class_id>115</a:class_id>
        <a:comments />
        <a:credit_id>1555</a:credit_id>
        <a:credit_type>G</a:credit_type>
        <a:date_granted>2013-11-16T00:00:00</a:date_granted>
        <a:email>[email protected]</a:email>
        <a:experiment_id>155</a:experiment_id>
        <a:first_name>Jake</a:first_name>
        <a:grantor_id>10144</a:grantor_id>
        <a:last_name>Ferry</a:last_name>
        <a:manual_credit_flag>0</a:manual_credit_flag>
        <a:occur_date>2012-06-26T15:00:08</a:occur_date>
        <a:payment_amount>12.34</a:payment_amount>
        <a:payment_status>P</a:payment_status>
        <a:payment_status_last_updated>2013-11-16T14:30:00</a:payment_status_last_updated>
        <a:penalty_credit>0</a:penalty_credit>
        <a:person_id>11498</a:person_id>
        <a:show_credit>0.50</a:show_credit>
        <a:signup_id>1555</a:signup_id>
        <a:student_id_num />
        <a:user_id>jferry</a:user_id>
      </a:APICreditItem>
    </a:Result>
  </SonaGetCreditsByPersonIDResult>
</SonaGetCreditsByPersonIDResponse>