POST api/Clients
Request Information
URI Parameters
None.
Body Parameters
Client| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| SecurityContextId | globally unique identifier |
None. |
|
| ParentId | integer |
None. |
|
| Name | string |
Required String length: inclusive between 0 and 100 |
|
| AccountNumber | integer |
None. |
|
| DateStarted | date |
None. |
|
| DnsAlias | string |
String length: inclusive between 0 and 20 |
|
| Enabled | boolean |
None. |
|
| ChainParentId | integer |
None. |
|
| TimeZoneId | integer |
None. |
|
| BigId | integer |
None. |
|
| IsSelfSignup | boolean |
None. |
|
| PaymentGatewayToken | string |
String length: inclusive between 0 and 50 |
|
| FriendlyName | string |
String length: inclusive between 0 and 100 |
|
| DisplayName | string |
None. |
|
| Parent | Client |
None. |
|
| TimeZone | TimeZone |
None. |
|
| ChainParent | Chain |
None. |
|
| ClientContactLensProductPricings | Collection of ClientContactLensProductPricing |
None. |
|
| ClientCorrespondenceTemplateHistories | Collection of ClientCorrespondenceTemplateHistory |
None. |
|
| ClientCorrespondenceTemplates | Collection of ClientCorrespondenceTemplate |
None. |
|
| ClientDiscountRules | Collection of ClientDiscountRule |
None. |
|
| ClientGoalSettings | Collection of ClientGoalSetting |
None. |
|
| ClientProductMappings | Collection of ClientContactLensProductMapping |
None. |
|
| SalesTaxOverrides | Collection of SalesTaxOverride |
None. |
|
| SubscriptionActivations | Collection of SubscriptionActivation |
None. |
|
| ReportingGroups | Collection of ReportingGroup |
None. |
|
| Locations | Collection of Location |
None. |
|
| EmailedReportRecipients | Collection of EmailedReportRecipient |
None. |
|
| MarketingStatuses | Collection of MarketingStatus |
None. |
|
| Patients | Collection of Patient |
None. |
|
| People | Collection of Person |
None. |
|
| Doctors | Collection of Doctor |
None. |
|
| TwilioMessageLogs | Collection of TwilioMessageLog |
None. |
|
| ClientId | integer |
None. |
|
| IsNavigation | boolean |
None. |
|
| AvailablePrivileges | Collection of SecurityPrivilege |
None. |
Request Formats
application/json
Sample not available.
text/json
Sample not available.
application/xml
Sample not available.
text/xml
Sample not available.
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Client| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| SecurityContextId | globally unique identifier |
None. |
|
| ParentId | integer |
None. |
|
| Name | string |
Required String length: inclusive between 0 and 100 |
|
| AccountNumber | integer |
None. |
|
| DateStarted | date |
None. |
|
| DnsAlias | string |
String length: inclusive between 0 and 20 |
|
| Enabled | boolean |
None. |
|
| ChainParentId | integer |
None. |
|
| TimeZoneId | integer |
None. |
|
| BigId | integer |
None. |
|
| IsSelfSignup | boolean |
None. |
|
| PaymentGatewayToken | string |
String length: inclusive between 0 and 50 |
|
| FriendlyName | string |
String length: inclusive between 0 and 100 |
|
| DisplayName | string |
None. |
|
| Parent | Client |
None. |
|
| TimeZone | TimeZone |
None. |
|
| ChainParent | Chain |
None. |
|
| ClientContactLensProductPricings | Collection of ClientContactLensProductPricing |
None. |
|
| ClientCorrespondenceTemplateHistories | Collection of ClientCorrespondenceTemplateHistory |
None. |
|
| ClientCorrespondenceTemplates | Collection of ClientCorrespondenceTemplate |
None. |
|
| ClientDiscountRules | Collection of ClientDiscountRule |
None. |
|
| ClientGoalSettings | Collection of ClientGoalSetting |
None. |
|
| ClientProductMappings | Collection of ClientContactLensProductMapping |
None. |
|
| SalesTaxOverrides | Collection of SalesTaxOverride |
None. |
|
| SubscriptionActivations | Collection of SubscriptionActivation |
None. |
|
| ReportingGroups | Collection of ReportingGroup |
None. |
|
| Locations | Collection of Location |
None. |
|
| EmailedReportRecipients | Collection of EmailedReportRecipient |
None. |
|
| MarketingStatuses | Collection of MarketingStatus |
None. |
|
| Patients | Collection of Patient |
None. |
|
| People | Collection of Person |
None. |
|
| Doctors | Collection of Doctor |
None. |
|
| TwilioMessageLogs | Collection of TwilioMessageLog |
None. |
|
| ClientId | integer |
None. |
|
| IsNavigation | boolean |
None. |
|
| AvailablePrivileges | Collection of SecurityPrivilege |
None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.
application/xml
Sample not available.
text/xml
Sample not available.