POST SelfService/EmbassyLetter

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ServiceUsername	string	Required
ServicePassword	string	Required
MembershipNumber	integer	Required
FirstName	string	Required
LastName	string	Required
PassportNumber	string	None.
RecipientAddress	string	Required
Commencementdate	date	None.
AttentionName	string	Required
PickupOption	string	None.
LetterOption	string	None.
PaymentStatus	string	None.
AmountPaid	decimal number	None.
TransactionReference	string	None.
TravelDuration	string	None.
TravelStartDate	date	None.
TravelEndDate	date	None.
AdditionalInstruction	string	None.

Request Formats

application/json, text/json

Sample:

{
  "AmountPaid": 12,
  "MembershipNumber": 3,
  "TravelEndDate": "2025-11-01T04:52:20.8417702Z",
  "TravelStartDate": "2025-11-01T04:52:20.8417702Z",
  "Commencementdate": "2025-11-01T04:52:20.8417702Z",
  "AdditionalInstruction": "sample string 15",
  "TravelDuration": "sample string 14",
  "TransactionReference": "sample string 13",
  "PaymentStatus": "sample string 11",
  "LetterOption": "sample string 10",
  "PickupOption": "sample string 9",
  "AttentionName": "sample string 8",
  "RecipientAddress": "sample string 7",
  "PassportNumber": "sample string 6",
  "LastName": "sample string 5",
  "FirstName": "sample string 4",
  "ServicePassword": "sample string 2",
  "ServiceUsername": "sample string 1"
}

application/xml, text/xml

Sample:

<EmbassyLetterRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ServiceUsername>sample string 1</ServiceUsername>
  <ServicePassword>sample string 2</ServicePassword>
  <MembershipNumber>3</MembershipNumber>
  <FirstName>sample string 4</FirstName>
  <LastName>sample string 5</LastName>
  <PassportNumber>sample string 6</PassportNumber>
  <RecipientAddress>sample string 7</RecipientAddress>
  <Commencementdate>2025-11-01T05:52:20.8417702+01:00</Commencementdate>
  <AttentionName>sample string 8</AttentionName>
  <PickupOption>sample string 9</PickupOption>
  <LetterOption>sample string 10</LetterOption>
  <PaymentStatus>sample string 11</PaymentStatus>
  <AmountPaid>12</AmountPaid>
  <TransactionReference>sample string 13</TransactionReference>
  <TravelDuration>sample string 14</TravelDuration>
  <TravelStartDate>2025-11-01T05:52:20.8417702+01:00</TravelStartDate>
  <TravelEndDate>2025-11-01T05:52:20.8417702+01:00</TravelEndDate>
  <AdditionalInstruction>sample string 15</AdditionalInstruction>
</EmbassyLetterRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EmbassyLetterResponse

Name	Type	Additional 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:

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