POST api/Certificates

Creates a new certificate or updates an existing one. The user can provide all necessary details for the certificate, including reservation and guest information. Only the model, which represents the certificate in JSON format, is required.

Request Information

URI Parameters

None.

Body Parameters

A JSON object containing the details of the certificate, including both reservation and guest information. The following properties are included: -ReservationID: The unique identifier for the reservation.-DestinationID: The ID of the destination where the certificate is being applied.-ResortID: The ID of the resort for the reservation.-Arrival: The arrival date and time for the reservation (e.g., "2025-04-17T10:52:45").-Departure: The departure date and time for the reservation (e.g., "2025-04-20T10:52:45").-ReservationStatusID: Status code for the reservation (e.g., 1 for confirmed).-Adults: The number of adults in the reservation.-Children: The number of children in the reservation.-Infants: The number of infants in the reservation.-Nights: The number of nights for the stay.-Rooms: The number of rooms requested.-RoomType: The type of room requested (e.g., "Deluxe Suite").-Transportation: The type of transportation included with the reservation (e.g., "Shuttle").-ConfirmationNumber: The unique confirmation number for the reservation.-ConfirmationDate: The date and time when the reservation was confirmed.-Notes: Additional notes related to the reservation (optional).-PlanTypeID: The ID of the reservation plan (e.g., "All-Inclusive").-SalesPrice: The price of the reservation, excluding taxes and fees.-LeadID: The unique ID of the lead guest.-FirstName: The first name of the lead guest.-LastName: The last name of the lead guest.-Email: The email address of the lead guest.-Phone: The phone number of the lead guest.-AltPhone: An alternate phone number for the lead guest.-Occupation: The occupation of the lead guest.-MaritalStatus: The marital status of the lead guest (e.g., "Married").-Age: The age of the lead guest.-AnnualIncome: The annual income of the lead guest (optional).-Guests: A list of guests in the reservation, including first name, last name, relationship to the lead guest, age, etc.-Address: The primary address of the lead guest.-City: The city of the lead guest's address.-State: The state of the lead guest's address.-CountryID: The country ID of the lead guest's location.-ZipCode: The zip code of the lead guest's address.

CertificateInfo

Name	Type	Additional information
ReservationID	globally unique identifier	None.
DestinationID	integer	None.
ResortID	integer	None.
Arrival	date	None.
Departure	date	None.
ReservationStatusID	integer	None.
Adults	integer	None.
Children	integer	None.
Infants	integer	None.
Nights	integer	None.
Rooms	integer	None.
RoomType	string	None.
Transportation	string	None.
ConfirmationNumber	string	None.
ConfirmationDate	date	None.
Notes	string	None.
PlanTypeID	integer	None.
SalesPrice	decimal number	None.
LeadID	globally unique identifier	None.
FirstName	string	None.
LastName	string	None.
Email	string	None.
Phone	string	None.
AltPhone	string	None.
Occupation	string	None.
MaritalStatus	string	None.
Age	integer	None.
AnnualIncome	decimal number	None.
Guests	Collection of Guest	None.
Address	string	None.
City	string	None.
State	string	None.
CountryID	integer	None.
ZipCode	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ReservationID": "5ee7a57f-2d83-48fa-baf9-d7cd49bd0e48",
  "DestinationID": 2,
  "ResortID": 3,
  "Arrival": "2025-12-13T00:26:37.0788804-06:00",
  "Departure": "2025-12-13T00:26:37.0943918-06:00",
  "ReservationStatusID": 1,
  "Adults": 4,
  "Children": 5,
  "Infants": 6,
  "Nights": 7,
  "Rooms": 8,
  "RoomType": "sample string 9",
  "Transportation": "sample string 10",
  "ConfirmationNumber": "sample string 11",
  "ConfirmationDate": "2025-12-13T00:26:37.0943918-06:00",
  "Notes": "sample string 12",
  "PlanTypeID": 13,
  "SalesPrice": 14.0,
  "LeadID": "f8406480-9747-42f1-b117-53547f2a0e52",
  "FirstName": "sample string 15",
  "LastName": "sample string 16",
  "Email": "sample string 17",
  "Phone": "sample string 18",
  "AltPhone": "sample string 19",
  "Occupation": "sample string 20",
  "MaritalStatus": "sample string 21",
  "Age": 22,
  "AnnualIncome": 23.0,
  "Guests": [
    {
      "LeadGuestID": "97d4a21f-3001-4ba2-9ffa-cd067d4e2a86",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "AgeName": "sample string 4",
      "Relationship": "sample string 5",
      "BirthDate": "2025-12-13T00:26:37.0943918-06:00",
      "Age": 1,
      "Occupation": "sample string 6"
    },
    {
      "LeadGuestID": "97d4a21f-3001-4ba2-9ffa-cd067d4e2a86",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "AgeName": "sample string 4",
      "Relationship": "sample string 5",
      "BirthDate": "2025-12-13T00:26:37.0943918-06:00",
      "Age": 1,
      "Occupation": "sample string 6"
    }
  ],
  "Address": "sample string 24",
  "City": "sample string 25",
  "State": "sample string 26",
  "CountryID": 27,
  "ZipCode": "sample string 28"
}

application/xml, text/xml

Sample:

<ApiCertificateViewModel.CertificateInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ePlat.Models.ViewModels">
  <Address>sample string 24</Address>
  <Adults>4</Adults>
  <Age>22</Age>
  <AltPhone>sample string 19</AltPhone>
  <AnnualIncome>23</AnnualIncome>
  <Arrival>2025-12-13T00:26:37.0788804-06:00</Arrival>
  <Children>5</Children>
  <City>sample string 25</City>
  <ConfirmationDate>2025-12-13T00:26:37.0943918-06:00</ConfirmationDate>
  <ConfirmationNumber>sample string 11</ConfirmationNumber>
  <CountryID>27</CountryID>
  <Departure>2025-12-13T00:26:37.0943918-06:00</Departure>
  <DestinationID>2</DestinationID>
  <Email>sample string 17</Email>
  <FirstName>sample string 15</FirstName>
  <Guests>
    <ApiCertificateViewModel.Guest>
      <Age>1</Age>
      <AgeName>sample string 4</AgeName>
      <BirthDate>2025-12-13T00:26:37.0943918-06:00</BirthDate>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
      <LeadGuestID>97d4a21f-3001-4ba2-9ffa-cd067d4e2a86</LeadGuestID>
      <Occupation>sample string 6</Occupation>
      <Relationship>sample string 5</Relationship>
    </ApiCertificateViewModel.Guest>
    <ApiCertificateViewModel.Guest>
      <Age>1</Age>
      <AgeName>sample string 4</AgeName>
      <BirthDate>2025-12-13T00:26:37.0943918-06:00</BirthDate>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
      <LeadGuestID>97d4a21f-3001-4ba2-9ffa-cd067d4e2a86</LeadGuestID>
      <Occupation>sample string 6</Occupation>
      <Relationship>sample string 5</Relationship>
    </ApiCertificateViewModel.Guest>
  </Guests>
  <Infants>6</Infants>
  <LastName>sample string 16</LastName>
  <LeadID>f8406480-9747-42f1-b117-53547f2a0e52</LeadID>
  <MaritalStatus>sample string 21</MaritalStatus>
  <Nights>7</Nights>
  <Notes>sample string 12</Notes>
  <Occupation>sample string 20</Occupation>
  <Phone>sample string 18</Phone>
  <PlanTypeID>13</PlanTypeID>
  <ReservationID>5ee7a57f-2d83-48fa-baf9-d7cd49bd0e48</ReservationID>
  <ReservationStatusID>1</ReservationStatusID>
  <ResortID>3</ResortID>
  <RoomType>sample string 9</RoomType>
  <Rooms>8</Rooms>
  <SalesPrice>14</SalesPrice>
  <State>sample string 26</State>
  <Transportation>sample string 10</Transportation>
  <ZipCode>sample string 28</ZipCode>
</ApiCertificateViewModel.CertificateInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the unique identifier (ReservationID) of the newly created or updated certificate.

AttemptResponseV2

Name	Type	Additional information
ResponseType	Attempt_ResponseTypes	None.
Exception	Exception	None.
ID	Object	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseType": 0,
  "Exception": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  },
  "ID": {},
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<AttemptResponseV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ePlat.Models.Utils">
  <Exception xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName>
    <Message i:nil="true" xmlns="" />
    <Data i:nil="true" xmlns="" />
    <InnerException i:nil="true" xmlns="" />
    <HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL>
    <StackTraceString i:nil="true" xmlns="" />
    <RemoteStackTraceString i:nil="true" xmlns="" />
    <RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex>
    <ExceptionMethod i:nil="true" xmlns="" />
    <HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult>
    <Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source>
    <WatsonBuckets i:nil="true" xmlns="" />
  </Exception>
  <ID />
  <Message>sample string 2</Message>
  <ResponseType>Warning</ResponseType>
</AttemptResponseV2>