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
NameDescriptionTypeAdditional information
ReservationID

Gets or sets the reservation ID.

 globally unique identifier

None.
DestinationID

Gets or sets the destination ID. Represents the location where the reservation is made.

 integer

None.
ResortID

Gets or sets the resort ID. The ID of the resort where the reservation is being made.

 integer

None.
Arrival

Gets or sets the arrival date and time of the reservation.

 date

None.
Departure

Gets or sets the departure date and time of the reservation.

 date

None.
ReservationStatusID

Gets or sets the status ID of the reservation. A code representing the current state of the reservation.

 integer

None.
Adults

Gets or sets the number of adults included in the reservation.

 integer

None.
Children

Gets or sets the number of children included in the reservation.

 integer

None.
Infants

Gets or sets the number of infants included in the reservation.

 integer

None.
Nights

Gets or sets the number of nights for the reservation.

 integer

None.
Rooms

Gets or sets the number of rooms in the reservation.

 integer

None.
RoomType

Gets or sets the type of room requested for the reservation.

 string

None.
Transportation

Gets or sets the type of transportation included with the reservation.

 string

None.
ConfirmationNumber

Gets or sets the confirmation number for the reservation.

 string

None.
ConfirmationDate

Gets or sets the confirmation date and time for the reservation.

 date

None.
Notes

Gets or sets additional notes or remarks related to the reservation.

 string

None.
PlanTypeID

Gets or sets the ID for the reservation plan type.

 integer

None.
SalesPrice

Gets or sets the sales price of the reservation.

 decimal number

None.
LeadID

Gets or sets the lead ID.

 globally unique identifier

None.
FirstName

Gets or sets the first name of the lead.

 string

None.
LastName

Gets or sets the last name of the lead.

 string

None.
Email

Gets or sets the email address of the lead.

 string

None.
Phone

Gets or sets the phone number of the lead.

 string

None.
AltPhone

Gets or sets the alternate phone number of the lead.

 string

None.
Occupation

Gets or sets the occupation of the lead.

 string

None.
MaritalStatus

Gets or sets the marital status of the lead.

 string

None.
Age

Gets or sets the age of the lead.

 integer

None.
AnnualIncome

Gets or sets the annual income of the lead.

 decimal number

None.
Guests

Gets or sets the list of guests associated with the reservation.

 Collection of Guest

None.
Address

Gets or sets the address of the lead.

 string

None.
City

Gets or sets the city of the lead.

 string

None.
State

Gets or sets the state of the lead.

 string

None.
CountryID

Gets or sets the country ID of the lead.

 integer

None.
ZipCode

Gets or sets the zip code of the lead.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "ReservationID": "de28adf2-c3ce-47c0-927a-627f72acb5e5",
  "DestinationID": 2,
  "ResortID": 3,
  "Arrival": "2026-08-09T23:11:35.1834331-06:00",
  "Departure": "2026-08-09T23:11:35.1834331-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": "2026-08-09T23:11:35.1834331-06:00",
  "Notes": "sample string 12",
  "PlanTypeID": 13,
  "SalesPrice": 14.0,
  "LeadID": "5acaaa96-1349-4241-b36b-b8326aa4b3c1",
  "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": "3c0e1133-2950-4f82-a450-feb69bdb448d",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "AgeName": "sample string 4",
      "Relationship": "sample string 5",
      "BirthDate": "2026-08-09T23:11:35.1834331-06:00",
      "Age": 1,
      "Occupation": "sample string 6"
    },
    {
      "LeadGuestID": "3c0e1133-2950-4f82-a450-feb69bdb448d",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "AgeName": "sample string 4",
      "Relationship": "sample string 5",
      "BirthDate": "2026-08-09T23:11:35.1834331-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>2026-08-09T23:11:35.1834331-06:00</Arrival>
  <Children>5</Children>
  <City>sample string 25</City>
  <ConfirmationDate>2026-08-09T23:11:35.1834331-06:00</ConfirmationDate>
  <ConfirmationNumber>sample string 11</ConfirmationNumber>
  <CountryID>27</CountryID>
  <Departure>2026-08-09T23:11:35.1834331-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>2026-08-09T23:11:35.1834331-06:00</BirthDate>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
      <LeadGuestID>3c0e1133-2950-4f82-a450-feb69bdb448d</LeadGuestID>
      <Occupation>sample string 6</Occupation>
      <Relationship>sample string 5</Relationship>
    </ApiCertificateViewModel.Guest>
    <ApiCertificateViewModel.Guest>
      <Age>1</Age>
      <AgeName>sample string 4</AgeName>
      <BirthDate>2026-08-09T23:11:35.1834331-06:00</BirthDate>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 3</LastName>
      <LeadGuestID>3c0e1133-2950-4f82-a450-feb69bdb448d</LeadGuestID>
      <Occupation>sample string 6</Occupation>
      <Relationship>sample string 5</Relationship>
    </ApiCertificateViewModel.Guest>
  </Guests>
  <Infants>6</Infants>
  <LastName>sample string 16</LastName>
  <LeadID>5acaaa96-1349-4241-b36b-b8326aa4b3c1</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>de28adf2-c3ce-47c0-927a-627f72acb5e5</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
NameDescriptionTypeAdditional information
ResponseType

Guarda el valor del tipo de resultado de la ejecución de las instrucciones de código en la función ejecutada.

 Attempt_ResponseTypes

None.
Exception

Presenta los errores que se producen cuando la ejecución de las instrucciones de código no terminan correctamente.

 Exception

None.
ID

Objeto que permite establecer cualquier tipo de valor como respuesta, sin la necesidad de que la información almacenada tenga que seguir una estructura.

 Object

None.
Message

Mensage personalizado para emitir una respuesta después de la correcta ejecución de las instrucciones de código.

 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>