messages
Retrieve message
Retrieves a message in accordance with Settings - Messages.
Request
HTTP GET to /messages
Parameters
Name | Required | Value | Description | Data type | Default |
|---|---|---|---|---|---|
type | Yes | type=appInfo | Required. Specifies the message to be retrieved. |
| |
businessunitid | No | businessunitid=4 | Retrieves message for specified business unit/facility. If there is no message for the specified unit the fallback method is to retrieve system level messages. | ID |
|
lang | No | lang=en | The specified language to retrieve the message in. If the message is not translated the fallback language is Swedish. | sv/ no/ en | sv |
Example:
APIURL/messages.xml?apikey=338934897438&type=appInfo&lang=en&businessunitid=2
Response
Tag | Format | Example | Description |
|---|---|---|---|
messages |
| <messages> | root-tag the encloses the messages |
message |
| <message> | The message itself |
title | String | <id>Välkomstbrev</id> | Subject line or title for the message. Often uses as the subject in an e-mail. |
body | String | <body>Aktiviteter</body> | The actual message itself. |
<messages>
<message>
<title>Welcome letter</title>
<body>Hello. Welcome to our club.</body>
</message>
</messages>
Type
Name | Värde |
|---|---|
Membership terms | internetSubscriptionTerms |
Order confirmation | orderConfirmationEmail |
Order reminder | orderReminder |
Order reminder 2 | orderReminder2 |
Order reminder 3 | orderReminder3 |
Order reminder 4 | orderReminder4 |
Booking information | bookingInfoContent |
Booking information for partner | playerInvitation |
Letter for cancellation of contracted time slot | cancelContractActivityMail |
Letter for password renewal | forgottenPasswordMail |
Confirmation letter when booked from waiting list | movedFromWaitingListMail |
Letter for change of e-mail address | changeEmailMail |
Email template | emailtemplate |
Information for "Autogiro consent via web page" | medgivandeViaHemsidaInfo |
Info page in mobile app | appInfo |
Receipt | receiptEmail |
Receipt template for invoice payment | invoiceReceiptEmail |
Message about frozen booking rights due to missed booking/bookings | suspendedMail |
My page | myPageContent |
Notification of submitted interest | newPersonNotificationMail |
Reminder for confirmation of booking | confirmationReminderMail |
SMS when booked from waiting list | movedFromWaitingListSms |
Language expression | localExpressions |
Warning due to missed booking | noShowMail |
Substitute requirement - E-mail to confirmed subsitute | substituteRequestConfirmation |
Substitute requirement - E-mail when position not filled | substituteRequestNotificationNo |
Substitute requirement - E-mail when position not filled, timeout | substituteRequestNotificationTimeout |
Substitute requirement - E-mail when position is filled | substituteRequestNotificationYes |
Substitute request | substituteRequest |
Substitute request SMS | substituteRequestSms |
Terms for Autogiro | autogiroTerms |
Terms for Internet booking | internetBookingTerms |
Welcome letter | welcomeMail |