Rest - Work - Session Groups - Participants: Difference between revisions
Line 79: | Line 79: | ||
<Telephone/> | <Telephone/> | ||
<Email>test@test.com</Email> | <Email>test@test.com</Email> | ||
</participant> | </participant> | ||
This will return errors on a fail or the full booking record on a successful submit. | This will return errors on a fail or the full booking record on a successful submit. |
Revision as of 15:29, 2 July 2012
Purpose
Used for administering participant registrations on session groups in the Views system.
Base URL
http://app.views.coop/api/restful/work/sessiongroups/<sid>/participants
- sid - This is the id of the session group
Note: If the Session Group has been archived, this API becomes read only.
Getting the list of participants
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml
This will return a list of participants that are associated wit the session group, similar to the following:
<sessiongroup id="7"> <participants> <participant id="123"> <Name>Jane Smith</Name> <Type>1</Type> <Attended/> <FirstAttended/> <Nickname/> <Forename>Jane</Forename> <Surname>Smith</Surname> ... <EngagmentLevel>0</EngagmentLevel> <EngagmentLevelName>Not Set</EngagmentLevelName> </participant> <participant id="102"> <Name>John Smith</Name> <Type>1</Type> <Attended/> <FirstAttended/> <Nickname/> <Forename>john</Forename> <Surname>Smith</Surname> ... <EngagmentLevel>0</EngagmentLevel> <EngagmentLevelName>Not Set </EngagmentLevelName> </participant> <participants> </sessiongroup>
Note: If the Session Group is bookable, each participant record will also contain a booking object as well.
Adding participants to a session group
Adding participants to a non-bookable session group
You can add a single participant via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X PUT
- pid - The ID of the participant to add
You can also upload a a list of participants to add to the session register via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT
<participants> <participant>101162</participant> <participant>103124</participant> <participant>103413</participant> </participants>
Adding participants to a bookable session groups
Due to financial information being required for bookable session groups the method of adding participants in slightly different.
url --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X PUT
<participant> <PersonID>100748</PersonID> <PaymentType>Debit Card</PaymentType> <PaymentAmount>20</PaymentAmount> <PaymentFee>2.50</PaymentFee> <PaymentReference>7002</PaymentReference> <Forename>Father</Forename> <Surname>Test</Surname> <Address1/> <Address2/> <Town/> <County/> <Postcode/> <Telephone/> <Email>test@test.com</Email> </participant>
This will return errors on a fail or the full booking record on a successful submit.
The required fields are all required:
- PersonID - This is the ID of the participant
- PaymentType - One of the following value 'Cash', 'Cheque', 'Debit Card', 'Credit Card', 'Other'
- PaymentAmount - This is the amount paid
Removing participants from a session group
Removing participants from a non bookable session group
You can remove a single participant from a session group via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
- pid - The ID of the participant to add
You can also upload a a list of participants to remove from the session group via the following URL
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X DELETE
<participants> <participant>101162</participant> <participant>103124</participant> <participant>103413</participant> </participants>
Removing participants from a non bookable session group
You can only remove a single participant's booking from a session group via the following:
curl --url <Base URL>/<pid> -u<username>:<password> -H Content-Type:text/xml -X DELETE
- pid - The ID of the participant to add
By default this will flag the participant as cancelled, but will not do anything with the financial side of the booking. To flag a refund was give or a credit note, you should pass the following:
<refundtype>Refund</refundtype>
or
<refundtype>Credit</refundtype>
This will result in the participants booking being completely being removed from the session group