POST Scheduling

SMIS availability is available using this method. Send in a start and end date to determine the window in which dates should be made available and a list of available dates within that range will be sent in JSON/XML format.

Request Information

URI Parameters

None.

Body Parameters

Schedule Request Object

ScheduleRequest
NameDescriptionTypeAdditional information
ZipCode

The Zip Code that the examination will take place in.

string

None.

StartDate

The first date/time slot that should be returned indicating coverage.

string

None.

EndDate

The ending date/time slot that should be returned indicating coverage.

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.

Request Formats

application/json, text/json

Sample:
{
  "ZipCode": "sample string 1",
  "StartDate": "sample string 2",
  "EndDate": "sample string 3",
  "EntityTypeID": 1,
  "EntityTypeIDSpecified": true,
  "EntityID": 1,
  "EntityIDSpecified": true
}

application/xml, text/xml

Sample:
<ScheduleRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ZipCode>sample string 1</ZipCode>
  <StartDate>sample string 2</StartDate>
  <EndDate>sample string 3</EndDate>
  <EntityTypeID>1</EntityTypeID>
  <EntityID>1</EntityID>
</ScheduleRequest>

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 'ScheduleRequest'.

Response Information

Resource Description

ScheduleItems
NameDescriptionTypeAdditional information
AvailableBlocks

Collection of ScheduleItem

None.

Response Formats

application/json, text/json

Sample:
{
  "AvailableBlocks": [
    {
      "ItemType": 0,
      "DateStart": "2024-11-22T21:52:57.4558037-06:00",
      "DateEnd": "2024-11-22T21:52:57.4558037-06:00",
      "ApptBlockpk": "93f0b926-dc5f-4f8a-88bb-62aab910a4c4",
      "Title": "sample string 3"
    },
    {
      "ItemType": 0,
      "DateStart": "2024-11-22T21:52:57.4558037-06:00",
      "DateEnd": "2024-11-22T21:52:57.4558037-06:00",
      "ApptBlockpk": "93f0b926-dc5f-4f8a-88bb-62aab910a4c4",
      "Title": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
<ScheduleResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <AvailableBlock>
    <DateStart>2024-11-22T21:52:57.4558037-06:00</DateStart>
    <DateEnd>2024-11-22T21:52:57.4558037-06:00</DateEnd>
  </AvailableBlock>
  <AvailableBlock>
    <DateStart>2024-11-22T21:52:57.4558037-06:00</DateStart>
    <DateEnd>2024-11-22T21:52:57.4558037-06:00</DateEnd>
  </AvailableBlock>
</ScheduleResponse>