POST api/AppointmentServiceTypeRules
API interface handling generic JSON requests for AppointmentServiceTypeRules
Request Information
URI Parameters
None.
Body Parameters
AppointmentServiceTypeRuleRequest
AppointmentServiceTypeRuleRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Request specified appointment by Id |
integer |
None. |
| RuleCode |
Return ServiceTypeRuleCodes matching given list of codes (comma separated) |
string |
None. |
| RuleCodeLike |
Return ServiceTypeRuleCodes matching given pattern |
string |
None. |
| FromDate |
Limit return by Rules valid from given date |
date |
None. |
| ToDate |
Limit return by rules valid until specified end date |
date |
None. |
| Limit |
Limit to number of rows returned by request (default is 100) |
integer |
None. |
| Skip |
Number of rows to skip (so we can skip 10 get next 10 etc) |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": 707,
"RuleCode": "sample string 2",
"RuleCodeLike": "sample string 3",
"FromDate": "2024-04-27T10:49:58.582296+10:00",
"ToDate": "2024-04-27T10:49:58.582296+10:00",
"Limit": 534,
"Skip": 581
}
application/xml, text/xml
Sample:
<AppointmentServiceTypeRuleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint.Controllers"> <FromDate>2024-04-27T10:49:58.582296+10:00</FromDate> <Id>707</Id> <Limit>534</Limit> <RuleCode>sample string 2</RuleCode> <RuleCodeLike>sample string 3</RuleCodeLike> <Skip>581</Skip> <ToDate>2024-04-27T10:49:58.582296+10:00</ToDate> </AppointmentServiceTypeRuleRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AppointmentServiceTypeRuleReportDetails()
AppointmentServiceTypeRuleReportDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| appointmentServiceTypeRuleID | integer |
None. |
|
| appointmentServiceTypeParentNumber | integer |
None. |
|
| appointmentServiceTypeRuleBillingGroup | integer |
None. |
|
| appointmentServiceTypeRuleCode | string |
None. |
|
| appointmentServiceTypeRuleDays | string |
None. |
|
| appointmentServiceTypeRulePackage | integer |
None. |
|
| appointmentServiceTypeRulePayGroup | integer |
None. |
|
| appointmentServiceTypeRulePayLevel | integer |
None. |
|
| appointmentServiceTypeRulePriority | integer |
None. |
|
| appointmentServiceTypeRulePublicHoliday | boolean |
None. |
|
| appointmentServiceTypeRuleRate | decimal number |
None. |
|
| appointmentServiceTypeRuleRate_PAY | decimal number |
None. |
|
| appointmentServiceTypeRuleReference | string |
None. |
|
| appointmentServiceTypeRuleReferrer | integer |
None. |
|
| appointmentServiceTypeRuleService | integer |
None. |
|
| appointmentServiceTypeRuleTimeFrom | date |
None. |
|
| appointmentServiceTypeRuleTimeTo | date |
None. |
|
| appointmentServiceTypeRuleUserIDS | string |
None. |
|
| appointmentServiceTypeRuleValidFrom | date |
None. |
|
| appointmentServiceTypeRuleValidTo | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"appointmentServiceTypeRuleID": 291,
"appointmentServiceTypeParentNumber": 303,
"appointmentServiceTypeRuleBillingGroup": 776,
"appointmentServiceTypeRuleCode": "sample string 2",
"appointmentServiceTypeRuleDays": "sample string 3",
"appointmentServiceTypeRulePackage": 15,
"appointmentServiceTypeRulePayGroup": 762,
"appointmentServiceTypeRulePayLevel": 815,
"appointmentServiceTypeRulePriority": 710,
"appointmentServiceTypeRulePublicHoliday": true,
"appointmentServiceTypeRuleRate": 1.1,
"appointmentServiceTypeRuleRate_PAY": 1.1,
"appointmentServiceTypeRuleReference": "sample string 4",
"appointmentServiceTypeRuleReferrer": 46,
"appointmentServiceTypeRuleService": 415,
"appointmentServiceTypeRuleTimeFrom": "2024-04-27T10:49:58.582296+10:00",
"appointmentServiceTypeRuleTimeTo": "2024-04-27T10:49:58.582296+10:00",
"appointmentServiceTypeRuleUserIDS": "sample string 5",
"appointmentServiceTypeRuleValidFrom": "2024-04-27T10:49:58.582296+10:00",
"appointmentServiceTypeRuleValidTo": "2024-04-27T10:49:58.582296+10:00"
}
application/xml, text/xml
Sample:
<AppointmentServiceTypeRuleReportDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint.Controllers"> <appointmentServiceTypeParentNumber>303</appointmentServiceTypeParentNumber> <appointmentServiceTypeRuleBillingGroup>776</appointmentServiceTypeRuleBillingGroup> <appointmentServiceTypeRuleCode>sample string 2</appointmentServiceTypeRuleCode> <appointmentServiceTypeRuleDays>sample string 3</appointmentServiceTypeRuleDays> <appointmentServiceTypeRuleID>291</appointmentServiceTypeRuleID> <appointmentServiceTypeRulePackage>15</appointmentServiceTypeRulePackage> <appointmentServiceTypeRulePayGroup>762</appointmentServiceTypeRulePayGroup> <appointmentServiceTypeRulePayLevel>815</appointmentServiceTypeRulePayLevel> <appointmentServiceTypeRulePriority>710</appointmentServiceTypeRulePriority> <appointmentServiceTypeRulePublicHoliday>true</appointmentServiceTypeRulePublicHoliday> <appointmentServiceTypeRuleRate>1.1</appointmentServiceTypeRuleRate> <appointmentServiceTypeRuleRate_PAY>1.1</appointmentServiceTypeRuleRate_PAY> <appointmentServiceTypeRuleReference>sample string 4</appointmentServiceTypeRuleReference> <appointmentServiceTypeRuleReferrer>46</appointmentServiceTypeRuleReferrer> <appointmentServiceTypeRuleService>415</appointmentServiceTypeRuleService> <appointmentServiceTypeRuleTimeFrom>2024-04-27T10:49:58.582296+10:00</appointmentServiceTypeRuleTimeFrom> <appointmentServiceTypeRuleTimeTo>2024-04-27T10:49:58.582296+10:00</appointmentServiceTypeRuleTimeTo> <appointmentServiceTypeRuleUserIDS>sample string 5</appointmentServiceTypeRuleUserIDS> <appointmentServiceTypeRuleValidFrom>2024-04-27T10:49:58.582296+10:00</appointmentServiceTypeRuleValidFrom> <appointmentServiceTypeRuleValidTo>2024-04-27T10:49:58.582296+10:00</appointmentServiceTypeRuleValidTo> </AppointmentServiceTypeRuleReportDetails>