POST api/Directory/AddProviderLocation?serviceLevels={serviceLevels}

Adds a new provider location. Note: Provider service levels are currently defaulted to "New", "Cancel", and "RxFill".Modification of serviceLevels is not supported at this time.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
serviceLevels

A comma-sepaarted list of service levels to associate with the provider location. /// *** Currently not supported, and will be ignored. *** Acceptable content: "New,Cancel,Change,CIMessage,CIEvent,ControlledSubstance" Note - CI options require DirectAddress, ControlledSubstance required DEA or SSN

string

None.

Body Parameters

The provider details - model from sureScripts project

ProviderSD
NameDescriptionTypeAdditional information
Id

string

None.

FirstName

string

Required

String length: inclusive between 0 and 100

MiddleName

string

String length: inclusive between 0 and 100

LastName

string

Required

String length: inclusive between 0 and 100

Credentials

string

String length: inclusive between 0 and 100

Address1

string

String length: inclusive between 0 and 250

Address2

string

String length: inclusive between 0 and 250

City

string

String length: inclusive between 0 and 100

State

string

String length: inclusive between 0 and 2

ZipCode

string

String length: inclusive between 0 and 10

Phone1

string

String length: inclusive between 0 and 15

Phone1Ext

string

String length: inclusive between 0 and 10

Phone2

string

String length: inclusive between 0 and 15

Phone2Ext

string

String length: inclusive between 0 and 10

Fax

string

String length: inclusive between 0 and 15

LicenseNumber

string

String length: inclusive between 0 and 50

DeaNumber

string

String length: inclusive between 0 and 50

DeaNumberSuffix

string

String length: inclusive between 0 and 50

AllowCII

boolean

None.

AllowCIIIToCV

boolean

None.

Npi

string

String length: inclusive between 0 and 50

DirectAddress

string

None.

BusinessName

string

None.

Active

boolean

None.

Suffix

string

String length: inclusive between 0 and 50

Prefix

string

String length: inclusive between 0 and 50

LastUpdateUserId

string

None.

LastUpdateDateTime

date

None.

ServiceLevel

string

None.

ActiveStartTime

date

None.

ActiveEndTime

date

None.

Display

string

None.

Name

string

None.

Address

string

None.

FirstAndLastName

string

None.

FullName

string

None.

Xml

Collection of Object

None.

Request Formats

application/json, text/json

Sample:
{
  "<Id>k__BackingField": "sample string 1",
  "<FirstName>k__BackingField": "sample string 2",
  "<MiddleName>k__BackingField": "sample string 3",
  "<LastName>k__BackingField": "sample string 4",
  "<Credentials>k__BackingField": "sample string 5",
  "<Address1>k__BackingField": "sample string 6",
  "<Address2>k__BackingField": "sample string 7",
  "<City>k__BackingField": "sample string 8",
  "<State>k__BackingField": "sample string 9",
  "<ZipCode>k__BackingField": "sample string 10",
  "<Phone1>k__BackingField": "sample string 11",
  "<Phone1Ext>k__BackingField": "sample string 12",
  "<Phone2>k__BackingField": "sample string 13",
  "<Phone2Ext>k__BackingField": "sample string 14",
  "<Fax>k__BackingField": "sample string 15",
  "<LicenseNumber>k__BackingField": "sample string 16",
  "<DeaNumber>k__BackingField": "sample string 17",
  "<DeaNumberSuffix>k__BackingField": "sample string 18",
  "<AllowCII>k__BackingField": true,
  "<AllowCIIIToCV>k__BackingField": true,
  "<Npi>k__BackingField": "sample string 21",
  "<DirectAddress>k__BackingField": "sample string 22",
  "<BusinessName>k__BackingField": "sample string 23",
  "<Active>k__BackingField": true,
  "<Suffix>k__BackingField": "sample string 25",
  "<Prefix>k__BackingField": "sample string 26",
  "<LastUpdateUserId>k__BackingField": "sample string 27",
  "<LastUpdateDateTime>k__BackingField": "2026-05-19T23:14:35.9745635-05:00",
  "<ServiceLevel>k__BackingField": "sample string 29",
  "<ActiveStartTime>k__BackingField": "2026-05-19T23:14:35.9745635-05:00",
  "<ActiveEndTime>k__BackingField": "2026-05-19T23:14:35.9745635-05:00"
}

application/xml, text/xml

Sample:
<ProviderSD xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>sample string 1</Id>
  <FirstName>sample string 2</FirstName>
  <MiddleName>sample string 3</MiddleName>
  <LastName>sample string 4</LastName>
  <Credentials>sample string 5</Credentials>
  <Address1>sample string 6</Address1>
  <Address2>sample string 7</Address2>
  <City>sample string 8</City>
  <State>sample string 9</State>
  <ZipCode>sample string 10</ZipCode>
  <Phone1>sample string 11</Phone1>
  <Phone1Ext>sample string 12</Phone1Ext>
  <Phone2>sample string 13</Phone2>
  <Phone2Ext>sample string 14</Phone2Ext>
  <Fax>sample string 15</Fax>
  <LicenseNumber>sample string 16</LicenseNumber>
  <DeaNumber>sample string 17</DeaNumber>
  <DeaNumberSuffix>sample string 18</DeaNumberSuffix>
  <AllowCII>true</AllowCII>
  <AllowCIIIToCV>true</AllowCIIIToCV>
  <Npi>sample string 21</Npi>
  <DirectAddress>sample string 22</DirectAddress>
  <BusinessName>sample string 23</BusinessName>
  <Active>true</Active>
  <Suffix>sample string 25</Suffix>
  <Prefix>sample string 26</Prefix>
  <LastUpdateUserId>sample string 27</LastUpdateUserId>
  <LastUpdateDateTime>2026-05-19T23:14:35.9745635-05:00</LastUpdateDateTime>
  <ServiceLevel>sample string 29</ServiceLevel>
  <ActiveStartTime>2026-05-19T23:14:35.9745635-05:00</ActiveStartTime>
  <ActiveEndTime>2026-05-19T23:14:35.9745635-05:00</ActiveEndTime>
</ProviderSD>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.