GET {ClientId}/QuickcheckEBR/{UserId}/{AuthProfileId}/{PhoneNumber}/{SOR}/Date/{Date}?LastContactDate={LastContactDate}

Retrieves a QuickCheckEBRResponse record for the PhoneNumber using State of Residence (SOR) for CallCurfew. CustomerDate is optional if passed in the query string. No authorization header is required.

Request Information

URI Parameters

Name	Description	Type	Additional information
ClientId	PossibleNow ClientId	string	Required
UserId	PossibleNow UserId	string	Required
AuthProfileId	Profile ID provided by PossibleNow	string	Required
PhoneNumber	PhoneNumber to check. Can't start with 0 or 1, but may contain dashes. Must contain 10 digits	string	Required
SOR	State of Residence used for TimeZone and Call Curfew lookups	string	Required
Date	Optional EBR date. Current date is used if left blank	string	None.
LastContactDate	Defines the date that the Mobile number was captured. This will be used in the Mobile Scoring API call to calculate results.	string	None.

Body Parameters

None.

Response Information

Resource Description

QuickCheckEBRResponse

Name	Description	Type	Additional information
TimeZone	The UTC timezone offset of the location being called. e.g. "-5"	string	None.
CallCurfewWindow	The call curfew window	CallCurfewInfo	None.
PhoneNumber	The PhoneNumber that was checked	string	None.
Status	"DNC" or "" if No DNC Found. If State of Emergency or Holiday, and within a callable window, "SOE" or "HOL" flag will display.	string	None.
Filters	Array of FilterInfo objects	Collection of FilterInfo	None.
MobileScoringInfo	Mobile Scoring information. If a Mobile Scoring is requested, this property will contain the results of such operation; otherwise, this property will be ommited.	MobileScoringInfo	None.
EBRStatus		EBRInfo	None.

Response Codes

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

Response Formats

application/json, text/json

Sample:

{
  "EBRStatus": {
    "EBRExemption": "sample string 1",
    "GoodThruDate": "sample string 2"
  },
  "TimeZone": "sample string 1",
  "CallCurfewWindow": {
    "Start": "sample string 1",
    "End": "sample string 2",
    "WithinCallCurfewWindow": "sample string 4",
    "WithinCallWindow": "sample string 4"
  },
  "PhoneNumber": "sample string 2",
  "Status": "sample string 3",
  "Filters": [
    {
      "FilterName": "sample string 1",
      "Flag": "sample string 2",
      "IsWireless": true
    },
    {
      "FilterName": "sample string 1",
      "Flag": "sample string 2",
      "IsWireless": true
    }
  ],
  "MobileScoringInfo": {
    "RequestId": "sample string 1",
    "Status": 2,
    "Description": "sample string 3",
    "Response": {
      "VerifyNumberTransactionId": "sample string 1",
      "MSISDNType": "sample string 2",
      "NumberMatch": "sample string 3"
    },
    "AdditionalInfo": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<QuickCheckEBRResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DNC.Rest.Models">
  <Filters>
    <FilterInfo>
      <FilterName>sample string 1</FilterName>
      <Flag>sample string 2</Flag>
      <IsWireless>true</IsWireless>
    </FilterInfo>
    <FilterInfo>
      <FilterName>sample string 1</FilterName>
      <Flag>sample string 2</Flag>
      <IsWireless>true</IsWireless>
    </FilterInfo>
  </Filters>
  <LastContactDate>sample string 4</LastContactDate>
  <MobileScoringInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/DNC.Rest.Codebase.MobileScoring">
    <d2p1:AdditionalInfo>sample string 4</d2p1:AdditionalInfo>
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:RequestId>sample string 1</d2p1:RequestId>
    <d2p1:Response>
      <d2p1:MSISDNType>sample string 2</d2p1:MSISDNType>
      <d2p1:NumberMatch>sample string 3</d2p1:NumberMatch>
      <d2p1:VerifyNumberTransactionId>sample string 1</d2p1:VerifyNumberTransactionId>
    </d2p1:Response>
    <d2p1:Status>2</d2p1:Status>
  </MobileScoringInfo>
  <PhoneNumber>sample string 2</PhoneNumber>
  <Status>sample string 3</Status>
  <EBRStatus>
    <EBRExemption>sample string 1</EBRExemption>
    <GoodThruDate>sample string 2</GoodThruDate>
  </EBRStatus>
  <CallCurfewWindow>
    <End>sample string 2</End>
    <Start>sample string 1</Start>
    <WithinCallCurfewWindow>sample string 4</WithinCallCurfewWindow>
    <WithinCallWindow>sample string 4</WithinCallWindow>
  </CallCurfewWindow>
  <TimeZone>sample string 1</TimeZone>
</QuickCheckEBRResponse>