POST Scheduling/Hold

Once a date has been picked from the schedule request, a hold can be made on an appointment. Use this method to claim that block. The PrimaryDate node will be checked against aviailable time. The secondary and tertiary dates can be set to anything and should be used if no coverage was available via the ScheduleRequest method call.

Request Information

URI Parameters

None.

Body Parameters

ScheduleHoldRequest

Name	Description	Type	Additional information
ApplicantFirstName	The name of the applicant for insurance.	string	None.
ApplicantLastName		string	None.
ApplicantName		string	None.
AddressLine1		string	None.
AddressLine2		string	None.
ApplicantCity		string	None.
State		string	None.
ZipCode	The Zip Code that the examination will take place in.	string	None.
EntityTypeID	An Entity Type ID as assigned by SMM for use in this call.	integer	None.
EntityID	An Entity ID as assigned by SMM for use in this call.	integer	None.
PrimaryDate	The primary date that the applicant would like to schedule for.	string	None.
SecondaryDate	The secondary date that the applicant would like to schedule for. This date does not need to come from available calendar dates and can be entered as a quasi-preset.	string	None.
TertiaryDate	The tertiary date that the applicant would like to schedule for. This date does not need to come from available calendar dates and can be entered as a quasi-preset.	string	None.
PolicyNumber	The policy number is for external tracking only and is not a required field.	string	None.
Reference	The reference number is for external tracking only. This can be the primary key field from the entity making the request. This is not a required field.	string	None.
LocationID		string	None.
GenderCode		string	None.

Request Formats

application/json, text/json

Sample:

{
  "ApplicantFirstName": "sample string 1",
  "ApplicantLastName": "sample string 2",
  "ApplicantName": "sample string 3",
  "AddressLine1": "sample string 4",
  "AddressLine2": "sample string 5",
  "ApplicantCity": "sample string 6",
  "State": "sample string 7",
  "ZipCode": "sample string 8",
  "EntityTypeID": 1,
  "EntityTypeIDSpecified": true,
  "EntityID": 1,
  "EntityIDSpecified": true,
  "PrimaryDate": "sample string 9",
  "SecondaryDate": "sample string 10",
  "TertiaryDate": "sample string 11",
  "PolicyNumber": "sample string 12",
  "Reference": "sample string 13",
  "LocationID": "sample string 14",
  "GenderCode": "sample string 15"
}

application/xml, text/xml

Sample:

<ScheduleHoldRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <LocationID>sample string 14</LocationID>
  <GenderCode>sample string 15</GenderCode>
  <ApplicantFirstName>sample string 1</ApplicantFirstName>
  <ApplicantLastName>sample string 2</ApplicantLastName>
  <ApplicantName>sample string 3</ApplicantName>
  <AddressLine1>sample string 4</AddressLine1>
  <AddressLine2>sample string 5</AddressLine2>
  <ApplicantCity>sample string 6</ApplicantCity>
  <State>sample string 7</State>
  <ZipCode>sample string 8</ZipCode>
  <EntityTypeID>1</EntityTypeID>
  <EntityID>1</EntityID>
  <PrimaryDate>sample string 9</PrimaryDate>
  <SecondaryDate>sample string 10</SecondaryDate>
  <TertiaryDate>sample string 11</TertiaryDate>
  <PolicyNumber>sample string 12</PolicyNumber>
  <Reference>sample string 13</Reference>
</ScheduleHoldRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ScheduleHoldRequest'.

Response Information

Resource Description

ScheduleHoldResponse

Name	Description	Type	Additional information
Status	Describes the result of the transmission.	ResultResponse	None.
ConfirmationNumber	A confirmation value that should be included in future transmissions to SMM w/order information for connection to the incoming order.	string	None.
ConfirmationDate	The date of the confirmation.	date	None.
ConfirmationExpires	The date when the confirmation expires. If an order is received w/the confirmation number after the confirmation date, the eXpress Scheduling request will be ignored and normal scheduling will take place.	date	None.
PrimaryDateConfirmed	A repeat of the date entered for the primary date.	date	None.
SecondaryDateConfirmed	A repeat of the date entered for the primary date.	date	None.
TertiaryDateConfirmed	A repeat of the date entered for the primary date.	date	None.
Log	An array of strings that contain failure details, if there were any.	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": {
    "tc": 0,
    "Value": "Not Yet Run",
    "Result": 0
  },
  "ConfirmationNumber": "sample string 1",
  "InternalReference": 2,
  "ConfirmationDate": "2024-11-22T21:41:14.8316297-06:00",
  "ConfirmationDateSpecified": true,
  "ConfirmationExpires": "2024-11-22T21:41:14.8316297-06:00",
  "ConfirmationExpiresSpecified": true,
  "PrimaryDateConfirmed": "2024-11-22T21:41:14.8316297-06:00",
  "PrimaryDateConfirmedSpecified": true,
  "SecondaryDateConfirmed": "2024-11-22T21:41:14.8316297-06:00",
  "SecondaryDateConfirmedSpecified": true,
  "TertiaryDateConfirmed": "2024-11-22T21:41:14.8316297-06:00",
  "TertiaryDateConfirmedSpecified": true,
  "Log": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ScheduleHoldResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Status tc="0">Not Yet Run</Status>
  <ConfirmationNumber>sample string 1</ConfirmationNumber>
  <ConfirmationDate>2024-11-22T21:41:14.8316297-06:00</ConfirmationDate>
  <ConfirmationExpires>2024-11-22T21:41:14.8316297-06:00</ConfirmationExpires>
  <PrimaryDateConfirmed>2024-11-22T21:41:14.8316297-06:00</PrimaryDateConfirmed>
  <SecondaryDateConfirmed>2024-11-22T21:41:14.8316297-06:00</SecondaryDateConfirmed>
  <TertiaryDateConfirmed>2024-11-22T21:41:14.8316297-06:00</TertiaryDateConfirmed>
  <Log>
    <LogItem>sample string 1</LogItem>
    <LogItem>sample string 2</LogItem>
  </Log>
</ScheduleHoldResponse>