GET {ClientId}/CallCurfew/{SOR}?Duration={Duration}&Conservative={Conservative}

Retrieves CallCurfew information by State of Residence

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ClientId

PossibleNow ClientId

string

Required

SOR

State of Residence

string

Required

Duration

Duration in Days

integer

Default value is 7

Conservative

If true, conservative data is returned. Defaults to true if not included

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

Collection of CallCurfew
NameDescriptionTypeAdditional information
Date

Date. e.g. "05/17/2021"

string

None.

DayOfWeek

Name of the day of week. e.g. "Monday"

string

None.

TimeZone

TimeZone offset from UTC. e.g. "-4"

string

None.

Start

24 hour start time. e.g. "0900"

string

None.

End

24 hour end time. e.g. "2100"

string

None.

Response Codes

  • InternalServerError (500)
  • NotFound (404)
  • BadRequest (400)

Response Formats

application/json, text/json

Sample:
[
  {
    "Date": "sample string 1",
    "DayOfWeek": "sample string 2",
    "TimeZone": "sample string 3",
    "Start": "sample string 4",
    "End": "sample string 5"
  },
  {
    "Date": "sample string 1",
    "DayOfWeek": "sample string 2",
    "TimeZone": "sample string 3",
    "Start": "sample string 4",
    "End": "sample string 5"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCallCurfew xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DNC.Rest.Models">
  <CallCurfew>
    <Date>sample string 1</Date>
    <DayOfWeek>sample string 2</DayOfWeek>
    <End>sample string 5</End>
    <Start>sample string 4</Start>
    <TimeZone>sample string 3</TimeZone>
  </CallCurfew>
  <CallCurfew>
    <Date>sample string 1</Date>
    <DayOfWeek>sample string 2</DayOfWeek>
    <End>sample string 5</End>
    <Start>sample string 4</Start>
    <TimeZone>sample string 3</TimeZone>
  </CallCurfew>
</ArrayOfCallCurfew>