POST SelfService/SpecialLetter

Request Information

URI Parameters

None.

Body Parameters

SpecialLetterRequest
NameDescriptionTypeAdditional information
ServiceUsername

string

Required

ServicePassword

string

Required

MembershipNumber

integer

Required

FirstName

string

Required

LastName

string

Required

RecipientAddress

string

Required

Commencementdate

date

Required

AttentionName

string

Required

TypeOfLetter

string

Required

AdditionalInstruction

string

None.

Request Formats

application/json, text/json

Sample:
{
  "MembershipNumber": 3,
  "Commencementdate": "2025-04-28T12:01:16.1661522Z",
  "AdditionalInstruction": "sample string 9",
  "TypeOfLetter": "sample string 8",
  "AttentionName": "sample string 7",
  "RecipientAddress": "sample string 6",
  "LastName": "sample string 5",
  "FirstName": "sample string 4",
  "ServicePassword": "sample string 2",
  "ServiceUsername": "sample string 1"
}

application/xml, text/xml

Sample:
<SpecialLetterRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ServiceUsername>sample string 1</ServiceUsername>
  <ServicePassword>sample string 2</ServicePassword>
  <MembershipNumber>3</MembershipNumber>
  <FirstName>sample string 4</FirstName>
  <LastName>sample string 5</LastName>
  <RecipientAddress>sample string 6</RecipientAddress>
  <Commencementdate>2025-04-28T13:01:16.1661522+01:00</Commencementdate>
  <AttentionName>sample string 7</AttentionName>
  <TypeOfLetter>sample string 8</TypeOfLetter>
  <AdditionalInstruction>sample string 9</AdditionalInstruction>
</SpecialLetterRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SpecialLetterResponse
NameDescriptionTypeAdditional information
MembershipNumber

integer

None.

TrackingId

string

None.

Status

string

None.

StatusMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "MembershipNumber": 1,
  "StatusMessage": "sample string 4",
  "Status": "sample string 3",
  "TrackingId": "sample string 2"
}

application/xml, text/xml

Sample:
<SpecialLetterResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <MembershipNumber>1</MembershipNumber>
  <TrackingId>sample string 2</TrackingId>
  <Status>sample string 3</Status>
  <StatusMessage>sample string 4</StatusMessage>
</SpecialLetterResponse>