PUT api/clinics/{clinicId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clinicId | integer |
Required |
Body Parameters
AddEditClinicRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ClinicName | string |
Required |
|
| ClinicNameLongForm | string |
String length: inclusive between 0 and 250 |
|
| Address1 | string |
Required |
|
| Address2 | string |
String length: inclusive between 0 and 35 |
|
| Active | boolean |
None. |
|
| City | string |
Required |
|
| State | string |
Required |
|
| ZipCode | string |
Required |
|
| PrimaryPhone | string |
Required String length: inclusive between 0 and 25 |
|
| PrimaryPhoneType | PhoneTypes |
Required |
|
| PrimaryFax | string |
String length: inclusive between 0 and 25 |
|
| PhoneAdditional1 | string |
String length: inclusive between 0 and 25 |
|
| PhoneAdditionalType1 | PhoneTypes |
None. |
|
| PhoneAdditional2 | string |
String length: inclusive between 0 and 25 |
|
| PhoneAdditionalType2 | PhoneTypes |
None. |
|
| PhoneAdditional3 | string |
String length: inclusive between 0 and 25 |
|
| PhoneAdditionalType3 | PhoneTypes |
None. |
Request Formats
application/json, text/json
Sample:
{
"ClinicName": "sample string 1",
"ClinicNameLongForm": "sample string 2",
"Address1": "sample string 3",
"Address2": "sample string 4",
"Active": true,
"City": "sample string 5",
"State": "sample string 6",
"ZipCode": "sample string 7",
"PrimaryPhone": "sample string 8",
"PrimaryPhoneType": 0,
"PrimaryFax": "sample string 9",
"PhoneAdditional1": "sample string 10",
"PhoneAdditionalType1": 0,
"PhoneAdditional2": "sample string 11",
"PhoneAdditionalType2": 0,
"PhoneAdditional3": "sample string 12",
"PhoneAdditionalType3": 0
}
application/xml, text/xml
Sample:
<AddEditClinicRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13"> <Active>true</Active> <Address1>sample string 3</Address1> <Address2>sample string 4</Address2> <City>sample string 5</City> <ClinicId>1</ClinicId> <ClinicName>sample string 1</ClinicName> <ClinicNameLongForm>sample string 2</ClinicNameLongForm> <PhoneAdditional1>sample string 10</PhoneAdditional1> <PhoneAdditional2>sample string 11</PhoneAdditional2> <PhoneAdditional3>sample string 12</PhoneAdditional3> <PhoneAdditionalType1>Undefined</PhoneAdditionalType1> <PhoneAdditionalType2>Undefined</PhoneAdditionalType2> <PhoneAdditionalType3>Undefined</PhoneAdditionalType3> <PrimaryFax>sample string 9</PrimaryFax> <PrimaryPhone>sample string 8</PrimaryPhone> <PrimaryPhoneType>Undefined</PrimaryPhoneType> <State>sample string 6</State> <ZipCode>sample string 7</ZipCode> </AddEditClinicRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IdentifierResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| Result | Result |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": 1,
"Result": {
"ResultCode": "sample string 1",
"ResultDescription": "sample string 2"
}
}
application/xml, text/xml
Sample:
<IdentifierResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
<Result>
<ResultCode>sample string 1</ResultCode>
<ResultDescription>sample string 2</ResultDescription>
</Result>
<Id>1</Id>
</IdentifierResponse>