ID: S202606091025
Status: imported

Tags: avans 2-4 LU1

LegacyLink API Documentation

Overview

LegacyLink is a legacy SOAP-style API service for sending SMS messages.
The API uses HTTP Basic authentication and XML-based request/response formats to simulate older enterprise systems.

Base URL:
https://fakecomworld.endpoint/legacylink

Protocol:
SOAP-style XML over HTTP

---

Authentication

LegacyLink uses HTTP Basic Authentication.
Include your credentials in the Authorization header using Base64 encoding.

Basic Authentication Header Format

Authorization: Basic base64(username:password)

Default Credentials (configurable)

• Username: legacylink-user
• Password: legacylink-password

Example

1. Combine:
   legacylink-user:legacylink-password
2. Base64 encode:
   bGVnYWN5bGluay11c2VyOmxlZ2FjeWxpbmstcGFzc3dvcmQ=
3. Header:

   Authorization: Basic bGVnYWN5bGluay11c2VyOmxlZ2FjeWxpbmstcGFzc3dvcmQ=
   

Error Response (401 Unauthorized)

<?xml version="1.0" encoding="utf-8"?>
<SendSmsResponse xmlns="http://legacylink.fakecomworld.com/v1">
  <StatusCode>401</StatusCode>
  <StatusMessage>Authentication required. Use Basic authentication.</StatusMessage>
  <MessageReference></MessageReference>
  <Timestamp>2024-01-15T10:30:00Z</Timestamp>
</SendSmsResponse>

---

Required Headers

Header	Type	Required	Description
Authorization	string	Yes	Basic authentication credentials
X-STUDENT-GROUP	string	Yes	Your student group identifier
Content-Type	string	Yes	Must be application/xml or text/xml
Accept	string	Recommended	application/xml or text/xml

---

Endpoints

Send SMS

Send an SMS message to a single phone number.

Endpoint:
POST /LegacyLink/SendSms

Request Headers:

Content-Type: application/xml
Authorization: Basic bGVnYWN5bGluay11c2VyOmxlZ2FjeWxpbmstcGFzc3dvcmQ=
X-STUDENT-GROUP: your-group-name
Accept: application/xml

---

Request Body (XML)

<?xml version="1.0" encoding="utf-8"?>
<SendSmsRequest xmlns="http://legacylink.fakecomworld.com/v1">
  <PhoneNumber>+31612345678</PhoneNumber>
  <MessageText>Your SMS message content here</MessageText>
  <SenderIdentification>YourCompany</SenderIdentification>
</SendSmsRequest>

Request Schema

Field	Type	Required	Description
PhoneNumber	string	Yes	Recipient phone number in international format
MessageText	string	Yes	SMS message content (max 160 characters recommended)
SenderIdentification	string	No	Sender name or identifier

---

Success Response (200 OK)

<?xml version="1.0" encoding="utf-8"?>
<SendSmsResponse xmlns="http://legacylink.fakecomworld.com/v1">
  <StatusCode>200</StatusCode>
  <StatusMessage>SMS sent successfully</StatusMessage>
  <MessageReference>LGC-A1B2C3D4E5F67890</MessageReference>
  <Timestamp>2024-01-15T10:35:42Z</Timestamp>
</SendSmsResponse>

Response Schema

Field	Type	Description
StatusCode	integer	HTTP-style status code (200 = success)
StatusMessage	string	Human-readable status message
MessageReference	string	Unique reference ID (LGC-{16-char hex})
Timestamp	datetime	UTC timestamp of the response

---

Error Responses

• 401 Unauthorized — Missing or invalid credentials
• 400 Bad Request — Missing PhoneNumber
• 400 Bad Request — Missing MessageText
• 400 Bad Request — Missing X-STUDENT-GROUP
• 404 Not Found — Message not found
• 500 Internal Server Error
• 503 Service Unavailable
• 504 Gateway Timeout

---

Rate Limiting

LegacyLink does not enforce rate limiting, ensuring consistent and reliable message delivery.

---

Response Times

LegacyLink simulates realistic network conditions & outages.

---

Support

For issues or questions, please contact your instructor or check the project documentation.