DNC.REST API -- ASP.NET Web API Help Page

Introduction

Authorization

APIs that whose action ends with "Auth" in the URL require the proper authorization header in order to work. Ex: “AddNumberAuth”.
Please see the Authorization documentation on how to generate the correct header.

FilterMaintenanceAuth

Handles authorized filter maintenance calls

API	Description
POST {ClientId}/AddNumberAuth/{PhoneNumber}	Adds a number to a filter. Authorization header is required.
POST {ClientId}/AddNumberAuth	Adds numbers to a filter. Authorization header is required.
POST {ClientId}/RemoveNumberAuth/{PhoneNumber}	Removes a number from a filter. Authorization header is required.
POST {ClientId}/RemoveNumberAuth	Removes numbers from a filter. Authorization header is required.

QuickCheckEBR

Handles client QuickCheckEBR calls

API	Description
GET {ClientId}/QuickcheckEBR/{UserId}/{AuthProfileId}/{PhoneNumber}?Date={Date}&LastContactDate={LastContactDate}	Retrieves a QuickCheckEBRResponse record for the PhoneNumber passed in using AreaCode for CallCurfew. CustomerDate is optional if passed in the query string. No authorization header is required.
GET {ClientId}/QuickcheckEBR/{UserId}/{AuthProfileId}/{PhoneNumber}/Date/{Date}?LastContactDate={LastContactDate}	Retrieves a QuickCheckEBRResponse record for the PhoneNumber passed in using AreaCode for CallCurfew. CustomerDate is optional if passed in the query string. No authorization header is required.
GET {ClientId}/QuickcheckEBR/{UserId}/{AuthProfileId}/Phone?EBRDataList[0]={EBRDataList[0]}&EBRDataList[1]={EBRDataList[1]}	Retrieves a QuickCheckMultiEBRResponse record for up to 100 Phone Numbers passed in using AreaCode for CallCurfew. No authorization header is required.
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.
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.
GET {ClientId}/QuickcheckEBR/{UserId}/{AuthProfileId}/{PhoneNumber}/{SOR}/PostalCode/{PostalCode}?Date={Date}&LastContactDate={LastContactDate}	Retrieves a QuickCheckEBRResponse record for the PhoneNumber using PostalCode for CallCurfew. CustomerDate is optional if passed in the query string. No authorization header is required.
GET {ClientId}/QuickcheckEBR/{UserId}/{AuthProfileId}/{PhoneNumber}/{SOR}/PostalCode/{PostalCode}/Date/{Date}?LastContactDate={LastContactDate}	Retrieves a QuickCheckEBRResponse record for the PhoneNumber using PostalCode for CallCurfew. CustomerDate is optional if passed in the query string. No authorization header is required.

QuickCheckEBRAuth

Handles authorized client QuickCheckEBR calls

API	Description
GET {ClientId}/QuickcheckEBRAuth/{UserId}/{AuthProfileId}/{PhoneNumber}?Date={Date}&LastContactDate={LastContactDate}	Retrieves a QuickCheckEBRResponse record for the PhoneNumber passed in using AreaCode for CallCurfew. CustomerDate is optional if passed in the query string. Authorization header is required.
GET {ClientId}/QuickcheckEBRAuth/{UserId}/{AuthProfileId}/{PhoneNumber}/Date/{Date}?LastContactDate={LastContactDate}	Retrieves a QuickCheckEBRResponse record for the PhoneNumber passed in using AreaCode for CallCurfew. CustomerDate is optional if passed in the query string. Authorization header is required.
GET {ClientId}/QuickcheckEBRAuth/{UserId}/{AuthProfileId}/Phone?EBRDataList[0]={EBRDataList[0]}&EBRDataList[1]={EBRDataList[1]}&LastContactDate={LastContactDate}	Retrieves a QuickCheckMultiEBRResponse record for up to 100 Phone Numbers passed in using AreaCode for CallCurfew. Authorization header is required.
GET {ClientId}/QuickcheckEBRAuth/{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. Authorization header is required.
GET {ClientId}/QuickcheckEBRAuth/{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. Authorization header is required.
GET {ClientId}/QuickcheckEBRAuth/{UserId}/{AuthProfileId}/{PhoneNumber}/{SOR}/PostalCode/{PostalCode}?Date={Date}&LastContactDate={LastContactDate}	Retrieves a QuickCheckEBRResponse record for the PhoneNumber using PostalCode for CallCurfew. CustomerDate is optional if passed in the query string. Authorization header is required.
GET {ClientId}/QuickcheckEBRAuth/{UserId}/{AuthProfileId}/{PhoneNumber}/{SOR}/PostalCode/{PostalCode}/Date/{Date}?LastContactDate={LastContactDate}	Retrieves a QuickCheckEBRResponse record for the PhoneNumber using PostalCode for CallCurfew. CustomerDate is optional if passed in the query string. Authorization header is required.

QuickCheckAuth

Handles authorized client QuickCheck calls

API	Description
GET {ClientId}/QuickcheckAuth/{UserId}/{AuthProfileId}/{PhoneNumber}?LastContactDate={LastContactDate}	Retrieves a QuickCheckResponse record for the PhoneNumber passed in using AreaCode for CallCurfew. Authorization header is required.
GET {ClientId}/QuickcheckAuth/{UserId}/{AuthProfileId}?PhoneNumberList[0]={PhoneNumberList[0]}&PhoneNumberList[1]={PhoneNumberList[1]}	Retrieves a QuickCheckMultiResult record for up to 250 Phone Numbers passed in using AreaCode for CallCurfew. Authorization header is required.
GET {ClientId}/QuickcheckAuth/{UserId}/{AuthProfileId}/{PhoneNumber}/{SOR}?LastContactDate={LastContactDate}	Retrieves a QuickCheckResponse record for the PhoneNumber using State of Residence (SOR) for CallCurfew. Authorization header is required.
GET {ClientId}/QuickcheckAuth/{UserId}/{AuthProfileId}/{PhoneNumber}/{SOR}/PostalCode/{PostalCode}?LastContactDate={LastContactDate}	Retrieves a QuickCheckResponse record for the PhoneNumber using PostalCode for CallCurfew. Authorization header is required.
GET {ClientId}/QuickcheckAuth/{UserId}/{AuthProfileId}/MobileScoring?PhoneNumberList[0]={PhoneNumberList[0]}&PhoneNumberList[1]={PhoneNumberList[1]}	Retrieves a QuickCheckMultiResult record for up to 250 Phone Numbers passed in using AreaCode for CallCurfew. Authorization header is required.
GET {ClientId}/QuickcheckAuth/{UserId}/{AuthProfileId}/Phone/SOR?PhoneDataList[0].PhoneNumber={PhoneDataList[0].PhoneNumber}&PhoneDataList[0].SOR={PhoneDataList[0].SOR}&PhoneDataList[0].PostalCode={PhoneDataList[0].PostalCode}&PhoneDataList[1].PhoneNumber={PhoneDataList[1].PhoneNumber}&PhoneDataList[1].SOR={PhoneDataList[1].SOR}&PhoneDataList[1].PostalCode={PhoneDataList[1].PostalCode}	Retrieves a QuickCheckMultiResult record for up to 100 Phone Numbers passed in using State of Residence (SOR) and optionally PostalCode for CallCurfew. No authorization header is required.

FilterMaintenance

Handles filter maintenance calls

API	Description
POST {ClientId}/AddNumber/{PhoneNumber}	Adds a number to a filter. No authorization header is required.
POST {ClientId}/AddNumber	Adds numbers to filters. No authorization header is required.
POST {ClientId}/RemoveNumber/{PhoneNumber}	Removes a number from a filter. No authorization header is required.
POST {ClientId}/RemoveNumber	Removes numbers from a filter. No authorization header is required.

CallCurfew

API	Description
GET {ClientId}/CallCurfew/NPANXX/{NPA}/{NXX}?Duration={Duration}&Conservative={Conservative}	Retrieves CallCurfew information by NPA/NXX
GET {ClientId}/CallCurfew/{SOR}?Duration={Duration}&Conservative={Conservative}	Retrieves CallCurfew information by State of Residence
GET {ClientId}/CallCurfew/{SOR}/{PostalCode}?Duration={Duration}&Conservative={Conservative}	Retrieves CallCurfew information by State of Residence and PostalCode

QuickCheckPlus

API	Description
GET {ClientId}/QuickcheckBlend/{UserId}/{AuthProfileId}?phoneNumbers[0]={phoneNumbers[0]}&phoneNumbers[1]={phoneNumbers[1]}	Retrieves a WithCallCurfewResults record for the PhoneNumbers that are passed in.

QuickCheck

Handles client QuickCheck calls

API	Description
GET {ClientId}/Quickcheck/{UserId}/{AuthProfileId}/{PhoneNumber}?LastContactDate={LastContactDate}	Retrieves a QuickCheckResponse record for the PhoneNumber passed in using AreaCode for CallCurfew. No authorization header is required.
GET {ClientId}/Quickcheck/{UserId}/{AuthProfileId}?PhoneNumberList[0]={PhoneNumberList[0]}&PhoneNumberList[1]={PhoneNumberList[1]}	Retrieves a QuickCheckMultiResult record for up to 250 Phone Numbers passed in using AreaCode for CallCurfew. No authorization header is required.
GET {ClientId}/Quickcheck/{UserId}/{AuthProfileId}/{PhoneNumber}/{SOR}?LastContactDate={LastContactDate}	Retrieves a QuickCheckResponse record for the PhoneNumber using State of Residence (SOR) for CallCurfew. No authorization header is required.
GET {ClientId}/Quickcheck/{UserId}/{AuthProfileId}/{PhoneNumber}/{SOR}/PostalCode/{PostalCode}?LastContactDate={LastContactDate}	Retrieves a QuickCheckResponse record for the PhoneNumber using PostalCode for CallCurfew. No authorization header is required.
GET {ClientId}/Quickcheck/{UserId}/{AuthProfileId}/MobileScoring?PhoneNumberList[0]={PhoneNumberList[0]}&PhoneNumberList[1]={PhoneNumberList[1]}	Retrieves a QuickCheckMultiResult record for up to 250 Phone Numbers passed in using AreaCode for CallCurfew. No authorization header is required.
GET {ClientId}/Quickcheck/{UserId}/{AuthProfileId}/Phone/SOR?PhoneDataList[0].PhoneNumber={PhoneDataList[0].PhoneNumber}&PhoneDataList[0].SOR={PhoneDataList[0].SOR}&PhoneDataList[0].PostalCode={PhoneDataList[0].PostalCode}&PhoneDataList[1].PhoneNumber={PhoneDataList[1].PhoneNumber}&PhoneDataList[1].SOR={PhoneDataList[1].SOR}&PhoneDataList[1].PostalCode={PhoneDataList[1].PostalCode}	Retrieves a QuickCheckMultiResult record for up to 100 Phone Numbers passed in using State of Residence (SOR) and optionally PostalCode for CallCurfew. No authorization header is required.