POST Scheduling/InCenterTimes

Send Location IDs for the facilities that the applicant would like to be seen to get their availability.

Request Information

URI Parameters

None.

Body Parameters

InCenterTimesRequest
NameDescriptionTypeAdditional information
LocationIds

string

None.

StartDate

string

None.

EndDate

string

None.

ZipCode

string

None.

CountryCode

string

None.

ApplicantPhoneNumber

string

None.

ShowPSCLocations

boolean

None.

ScheduleNowAttendeeCode

string

None.

Request Formats

application/json, text/json, application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

InCenterAvailability
NameDescriptionTypeAdditional information
AppointmentDuration

integer

None.

Availability

Collection of Availability

None.

Response Formats

application/json, text/json

Sample:
{
  "AppointmentDuration": 1,
  "Availability": [
    {
      "Location": {
        "LocationId": "sample string 1",
        "Name": "sample string 2",
        "Address": {
          "Type": {},
          "Line1": "sample string 2",
          "Line2": "sample string 3",
          "Line3": "sample string 4",
          "City": "sample string 5",
          "StateCode": "sample string 6",
          "PostalCode": "sample string 7",
          "CountryCode": {},
          "Latitude": null,
          "Longitude": null
        }
      },
      "StartDateTimes": [
        "2024-09-19T13:34:09.277201-05:00",
        "2024-09-19T13:34:09.277201-05:00"
      ]
    },
    {
      "Location": {
        "LocationId": "sample string 1",
        "Name": "sample string 2",
        "Address": {
          "Type": {},
          "Line1": "sample string 2",
          "Line2": "sample string 3",
          "Line3": "sample string 4",
          "City": "sample string 5",
          "StateCode": "sample string 6",
          "PostalCode": "sample string 7",
          "CountryCode": {},
          "Latitude": null,
          "Longitude": null
        }
      },
      "StartDateTimes": [
        "2024-09-19T13:34:09.277201-05:00",
        "2024-09-19T13:34:09.277201-05:00"
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<InCenterAvailability xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <AppointmentDuration>1</AppointmentDuration>
  <Availability>
    <Availability>
      <Location>
        <LocationId>sample string 1</LocationId>
        <Name>sample string 2</Name>
        <Address>
          <Type />
          <Line1>sample string 2</Line1>
          <Line2>sample string 3</Line2>
          <Line3>sample string 4</Line3>
          <City>sample string 5</City>
          <StateCode>sample string 6</StateCode>
          <PostalCode>sample string 7</PostalCode>
          <CountryCode />
        </Address>
      </Location>
      <StartDateTimes>
        <dateTime>2024-09-19T13:34:09.277201-05:00</dateTime>
        <dateTime>2024-09-19T13:34:09.277201-05:00</dateTime>
      </StartDateTimes>
    </Availability>
    <Availability>
      <Location>
        <LocationId>sample string 1</LocationId>
        <Name>sample string 2</Name>
        <Address>
          <Type />
          <Line1>sample string 2</Line1>
          <Line2>sample string 3</Line2>
          <Line3>sample string 4</Line3>
          <City>sample string 5</City>
          <StateCode>sample string 6</StateCode>
          <PostalCode>sample string 7</PostalCode>
          <CountryCode />
        </Address>
      </Location>
      <StartDateTimes>
        <dateTime>2024-09-19T13:34:09.277201-05:00</dateTime>
        <dateTime>2024-09-19T13:34:09.277201-05:00</dateTime>
      </StartDateTimes>
    </Availability>
  </Availability>
</InCenterAvailability>