PUT api/FranchiseOperation/UpdateFranchiseOperation
Request Information
URI Parameters
None.
Body Parameters
VMFranchiseOperation| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| FranchiseOperationCategoryId | integer |
None. |
|
| Name | string |
None. |
|
| Url | string |
None. |
|
| CreatedDate | date |
None. |
|
| IsDeleted | boolean |
None. |
|
| tbFranchiseOperationCategory | VMFranchiseOperationCategory |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": 1,
"FranchiseOperationCategoryId": 1,
"Name": "sample string 2",
"Url": "sample string 3",
"CreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"IsDeleted": true,
"tbFranchiseOperationCategory": {
"$id": "2",
"Id": 1,
"CompanyId": 1,
"Name": "sample string 2",
"CreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"IsDeleted": true,
"tbCompany": {
"$id": "3",
"Id": 1,
"UserId": "sample string 2",
"RoleId": 1,
"Role": "sample string 3",
"CompanyName": "sample string 4",
"FirstName": "sample string 5",
"LastName": "sample string 6",
"PhoneNumber": "sample string 7",
"Email": "sample string 8",
"Icon": "sample string 9",
"Gender": "sample string 10",
"StateId": 1,
"City": "sample string 11",
"Address": "sample string 12",
"SubscriptionPlanId": 1,
"CurrentPeriodEnd": "2025-09-10T07:00:07.2070681+00:00",
"CurrentPeriodLeeway": "2025-09-10T07:00:07.2070681+00:00",
"SubscriptionStateId": 1,
"IsDirectorAlso": true,
"IsProfileCompleted": true,
"OfficeCount": 1,
"Description": "sample string 13",
"CreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"IsDeleted": true,
"tbState": {
"$id": "4",
"Id": 1,
"StateName": "sample string 2",
"isDeleted": true,
"CreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"CountryId": 1,
"tbCompanies": [
{
"$ref": "3"
},
{
"$ref": "3"
}
],
"tbInstructors": [
{
"$id": "5",
"Id": 1,
"UserId": "sample string 2",
"OfficeId": 1,
"Name": "sample string 3",
"Initials": "sample string 4",
"Email": "sample string 5",
"Phone": "sample string 6",
"StateId": 1,
"City": "sample string 7",
"Zip": "sample string 8",
"Address": "sample string 9",
"Gender": "sample string 10",
"Schedule": "sample string 11",
"PayRate": 1.0,
"SocialSecurityNumber": "sample string 12",
"MaritalStatus": "sample string 13",
"NumberOfExemptions": 1,
"DateOfBirth": "2025-09-10T07:00:07.2070681+00:00",
"AccountNumber": "sample string 14",
"RoutingNumber": "sample string 15",
"HireDate": "2025-09-10T07:00:07.2070681+00:00",
"Clearance": true,
"DirectDeposit": true,
"Equipment": true,
"Notes": "sample string 16",
"EquipmentNote": "sample string 17",
"IsApplication": true,
"IsInterviewNotes": true,
"IsTopSheet": true,
"IsStaffEmergencyContact": true,
"IsW4": true,
"IsI9": true,
"IsInstructorAgreement": true,
"IsChildAbuseAndInnapropriateContact": true,
"IsGeneralKnowledgeAnswerSheet": true,
"IsCurriculumAnswerSheet": true,
"IsHighFivesMoment": true,
"IsGamePlan": true,
"IsChildProtection": true,
"IsEmployeePledge": true,
"IsClassProcedureAnswerSheet": true,
"IsEmpahsis": true,
"IsDirectorQuiz": true,
"IsCampGamePlan": true,
"IsCampHighFivesMoment": true,
"IsCampEmpahsis": true,
"IsProgramManualAnswerSheet": true,
"IsProgramTrainingReceipt": true,
"IsCampManualAnswerSheet": true,
"IsCampTrainingPresentationAnswerSheet": true,
"IsCampTrainingReceipt": true,
"CreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"IsDeleted": true,
"UpdatedOn": "2025-09-10T07:00:07.2070681+00:00",
"tbOffice": {
"$id": "6",
"Id": 1,
"CompanyId": 1,
"OfficeName": "sample string 2",
"OfficeShortName": "sample string 3",
"OfficeType": "sample string 4",
"OfficeLocation": "sample string 5",
"EmploymentType": "sample string 6",
"Phone": "sample string 7",
"Email": "sample string 8",
"StateId": 1,
"City": "sample string 9",
"Address": "sample string 10",
"ShirtSize": "sample string 11",
"Banking": "sample string 12",
"PayrollCompany": "sample string 13",
"InsuranceBroker": "sample string 14",
"COIStanding": "sample string 15",
"VirtualMeetingPlatform": "sample string 16",
"BackgroundCheckPlatform": "sample string 17",
"ProviderTaxId": "sample string 18",
"Currency": "sample string 19",
"PaymentGateway": "sample string 20",
"PublishableKey": "sample string 21",
"SecretKey": "sample string 22",
"PT_ApiKey": "sample string 23",
"PT_MerchantUID": "sample string 24",
"TwitterLink": "sample string 25",
"FacebookLink": "sample string 26",
"InstagramLink": "sample string 27",
"AdvertisingSpending": 1,
"IsRevenueASP": true,
"IsRevenueSpark": true,
"IsRevenueSchoolYearCamps": true,
"IsRevenueSummerCamps": true,
"IsRevenueLeagues": true,
"IsRevenueClinics": true,
"RevenueOtherStreams": "sample string 28",
"Description": "sample string 29",
"Announcement": "sample string 30",
"Testimonials": "sample string 31",
"IsDeleted": true,
"IsLocked": true,
"CreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"UpdatedOn": "2025-09-10T07:00:07.2070681+00:00",
"tbCampaigns": [
{
"$id": "7",
"Id": 1,
"Officeid": 1,
"Subject": "sample string 2",
"EmailContent": "sample string 3",
"CreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"IsDeleted": true,
"tbCampaignDetails": [
{
"$id": "8",
"Id": 1,
"CampaignId": 1,
"UserEmail": "sample string 2",
"tbCampaign": {
"$ref": "7"
},
"SenderName": "sample string 3",
"SenderAccountName": "sample string 4"
},
{
"$ref": "8"
}
],
"vMCampaignDetails": [
{
"$ref": "8"
},
{
"$ref": "8"
}
],
"SenderEmail": "sample string 4"
},
{
"$ref": "7"
}
],
"tbCompany": {
"$ref": "3"
},
"tbCoupons": [
{
"$id": "9",
"Id": 1,
"OfficeId": 1,
"Name": "sample string 2",
"Code": "sample string 3",
"DiscountType": "sample string 4",
"DiscountAmount": 1.0,
"ProgramEligibility": "sample string 5",
"MaximumUsageAllowed": 1,
"NumberUsed": 1,
"StartDate": "2025-09-10T07:00:07.2070681+00:00",
"EndDate": "2025-09-10T07:00:07.2070681+00:00",
"CreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"IsActive": true,
"IsDeleted": true,
"UpdatedOn": "2025-09-10T07:00:07.2070681+00:00",
"tbOffice": {
"$ref": "6"
},
"tbCouponPrograms": [
{
"$id": "10",
"Id": 1,
"CouponId": 1,
"ProgramId": 1,
"tbCoupon": {
"$ref": "9"
}
},
{
"$ref": "10"
}
],
"ProgramId": 1,
"ProgramIds": "sample string 6",
"IsCouponApplied": true
},
{
"$ref": "9"
}
],
"tbDirectors": [
{
"$id": "11",
"Id": 1,
"UserId": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"City": "sample string 5",
"StateId": 1,
"OfficeId": 1,
"Role": "sample string 6",
"Gender": "sample string 7",
"PhoneNumber": "sample string 8",
"Email": "sample string 9",
"Address": "sample string 10",
"CreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"IsDeleted": true,
"IsLocked": true,
"tbOffice": {
"$ref": "6"
},
"DirectorName": "sample string 11",
"Password": "sample string 12",
"OfficeName": "sample string 13",
"StateName": "sample string 14",
"SubscriptionPlanName": "sample string 15",
"CurrentPeriodEnd": "2025-09-10T07:00:07.2070681+00:00",
"tbCompany": {
"$ref": "3"
}
},
{
"$ref": "11"
}
],
"tbDiscount": {
"$id": "12",
"Id": 1,
"OfficeId": 1,
"Name": "sample string 2",
"NumberOfUsers": 1,
"ProgramEligibility": "sample string 3",
"DiscountType": "sample string 4",
"DiscountAmount": 1.0,
"CreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"IsActive": true,
"IsDeleted": true,
"UpdatedOn": "2025-09-10T07:00:07.2070681+00:00",
"tbOffice": {
"$ref": "6"
},
"tbDiscountPrograms": [
{
"$id": "13",
"Id": 1,
"DiscountId": 1,
"ProgramId": 1,
"tbDiscount": {
"$ref": "12"
}
},
{
"$ref": "13"
}
],
"ProgramIds": "sample string 5",
"IsDiscountValid": true
},
"tbEmailTemplates": [
{
"$id": "14",
"Id": 1,
"OfficeId": 1,
"Name": "sample string 2",
"TemplateContent": "sample string 3",
"CreatedOn": "2025-09-10T07:00:07.2070681+00:00",
"Isdeleted": true,
"VMOffice": {
"$ref": "6"
}
},
{
"$ref": "14"
}
],
"tbEvaluations": [
{
"$id": "15",
"Id": 1,
"OfficeId": 1,
"SchoolId": 1,
"ProgramClassId": 1,
"DirectorId": 1,
"Instructors": "sample string 2",
"Comments": "sample string 3",
"AdditionalNotes": "sample string 4",
"IsUniform": true,
"IsReachedEarly": true,
"IsEquip": true,
"PDC": true,
"IsInstructorEnergetic": true,
"IsAllStudentsInvolved": true,
"IsFunEnvironment": true,
"IsSolidPace": true,
"IsHighFives": true,
"CreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"IsActive": true,
"tbDirector": {
"$ref": "11"
},
"tbOffice": {
"$ref": "6"
},
"tbProgramClass": {
"$id": "16",
"Id": 1,
"OfficeId": 1,
"ProgramId": 1,
"ProgramScheduleId": 1,
"ClassDate": "2025-09-10T07:00:07.2070681+00:00",
"ClassStatus": 1,
"ClassStatusName": "sample string 2",
"ClassDay": "sample string 3",
"EndTime": "2025-09-10T07:00:07.2070681+00:00",
"StartTime": "2025-09-10T07:00:07.2070681+00:00",
"InstructorInitials": "sample string 4",
"Notes": "sample string 5",
"YearId": 1,
"IsDeleted": true,
"IsPublished": true,
"tbEvaluations": [
{
"$ref": "15"
},
{
"$ref": "15"
}
],
"tbProgram": {
"$id": "17",
"Id": 1,
"SessionId": 1,
"OfficeId": 1,
"SchoolId": 1,
"Program": "sample string 2",
"NumberofKids": 1,
"StartDate": "2025-09-10T07:00:07.2070681+00:00",
"EndDate": "2025-09-10T07:00:07.2070681+00:00",
"Cost": 1.0,
"TotalCost": 1.0,
"WeeksDuration": 1,
"InstructorsId": "sample string 3",
"InstructorsInitials": "sample string 4",
"Availability": "sample string 5",
"StartTime": "2025-09-10T07:00:07.2070681+00:00",
"EndTime": "2025-09-10T07:00:07.2070681+00:00",
"ProcessingFeePercentage": 1.0,
"IsSurveyActive": true,
"SurveyUrl": "sample string 6",
"RegistrationStart": "2025-09-10T07:00:07.2070681+00:00",
"RegistrationEnd": "2025-09-10T07:00:07.2070681+00:00",
"StudentCapacity": 1,
"RegistrationType": "sample string 7",
"Description": "sample string 8",
"Notes": "sample string 9",
"IsEarlyBird": true,
"EarlyBirdRegistrationEnd": "2025-09-10T07:00:07.2070681+00:00",
"EarlyBirdCost": 1.0,
"ProgramCategory": "sample string 10",
"GradeMinRequirment": "sample string 11",
"GradeMaxRequirment": "sample string 12",
"IsTShirt": true,
"IsFriendRequest": true,
"IsRoommateRequest": true,
"IsPaymentPlan": true,
"PaymentPlanInstallmentDate": "2025-09-10T07:00:07.2070681+00:00",
"PaymentPlanFee": 1.0,
"IsManualDisplay": true,
"OtherURL": "sample string 13",
"CreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"UpdatedOn": "2025-09-10T07:00:07.2070681+00:00",
"YearId": 1,
"IsDeleted": true,
"IsPublished": true,
"tbOffice": {
"$ref": "6"
},
"tbSchool": {
"$id": "18",
"Id": 1,
"OfficeId": 1,
"Name": "sample string 2",
"SchoolPhone": "sample string 3",
"Website": "sample string 4",
"StateId": 1,
"City": "sample string 5",
"Address": "sample string 6",
"Zipcode": "sample string 7",
"SalesStageName": "sample string 8",
"PartnerName": "sample string 9",
"PartnerEmail": "sample string 10",
"PartnerPhone": "sample string 11",
"Description": "sample string 12",
"CreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"IsDeleted": true,
"tbEvaluations": [
{
"$ref": "15"
},
{
"$ref": "15"
}
],
"tbOffice": {
"$ref": "6"
},
"tbPrograms": [
{
"$ref": "17"
},
{
"$ref": "17"
}
],
"tbProgramPayments": [
{
"$id": "19",
"Id": 1,
"OfficeId": 1,
"SessionId": 1,
"SchoolId": 1,
"ProgramId": 1,
"Payment": 1.0,
"CollectionDate": "2025-09-10T07:00:07.2070681+00:00",
"PaymentMode": 1,
"IsCompleted": true,
"tbOffice": {
"$ref": "6"
},
"tbSchool": {
"$ref": "18"
},
"Year": 2,
"PaymentModeName": "sample string 3",
"TotalAmount": 1.0,
"TotalAmountCollected": 1.0,
"TotalAmountReceivable": 1.0,
"RecievingStatus": 4,
"tbProgram": {
"$ref": "17"
}
},
{
"$ref": "19"
}
],
"tbState": {
"$ref": "4"
},
"StateName": "sample string 13"
},
"tbProgramClasses": [
{
"$ref": "16"
},
{
"$ref": "16"
}
],
"tbProgramSchedules": [
{
"$id": "20",
"Id": 1,
"OfficeId": 1,
"ProgramId": 1,
"CampStartDate": "2025-09-10T07:00:07.2070681+00:00",
"CampStartDay": "sample string 2",
"CampEndDate": "2025-09-10T07:00:07.2070681+00:00",
"CampEndDay": "sample string 3",
"CampRegistrationEnd": "2025-09-10T07:00:07.2070681+00:00",
"CampBasePrice": 1.0,
"CampAfterCareCharge": 1.0,
"CampAfterDescription": "sample string 4",
"CampBeforeCareCharge": 1.0,
"CampBeforeDescription": "sample string 5",
"CampLunchCharge": 1.0,
"CampLunchDescription": "sample string 6",
"IsDeleted": true,
"IsActive": true,
"tbOffice": {
"$ref": "6"
},
"tbProgram": {
"$ref": "17"
},
"tbProgramClasses": [
{
"$ref": "16"
},
{
"$ref": "16"
}
],
"tbRegistrationItemSchedules": [
{
"$id": "21",
"Id": 1,
"RegistrationItemId": 1,
"ScheduleId": 1,
"OriginalCampBasePrice": 1.0,
"CampBasePriceEarlyBirdDiscount": 1.0,
"CampBasePrice": 1.0,
"CampAfterCareCharge": 1.0,
"CampBeforeCareCharge": 1.0,
"CampLunchCharge": 1.0,
"SubTotalExclTax": 1.0,
"SubTotalInclTax": 1.0,
"RegistrationStatus": "sample string 2",
"SubTotalCouponDiscount": 1.0,
"TotalAmount": 1.0,
"CancellationFeePercentage": 1.0,
"CancellationFeeAmount": 1.0,
"RefundedAmount": 1.0,
"PaidAmount": 1.0,
"IsTransfer": true,
"TransferredScheduleId": 1,
"TransferStatus": "sample string 3",
"TransferFee": 1.0,
"TransferDifference": 1.0,
"TransferOldOrderAdjustment": 1.0,
"tbProgramSchedule": {
"$ref": "20"
},
"tbRegistrationItem": {
"$id": "22",
"Id": 1,
"OrderId": 1,
"ProgramId": 1,
"ChildId": 1,
"ProgramTotal": 1.0,
"IsEarlyBirdApplied": true,
"EarlyBirdDiscountAmount": 1.0,
"IsSiblingDiscountApplied": true,
"SiblingDiscountId": 1,
"SiblingDiscountAmount": 1.0,
"IsPaymentPlanApplied": true,
"PaymentPlan2ndInstallmentDate": "2025-09-10T07:00:07.2070681+00:00",
"PaymentPlan2ndInstallmentAmount": 1.0,
"PaymentPlanFeeAmount": 1.0,
"IsPaymentPlan2ndInstallmentPaid": true,
"IsCouponApplied": true,
"CouponId": 1,
"CouponDiscountAmount": 1.0,
"ProcessingFeeAmount": 1.0,
"SubTotalAmountExclTax": 1.0,
"SubTotalAmountInclTax": 1.0,
"TotalAmount": 1.0,
"SchoolName": "sample string 2",
"TeacherName": "sample string 3",
"StandardDismissal": "sample string 4",
"Grade": "sample string 5",
"DismissalFromEnrichment": "sample string 6",
"IsTShirtRequired": true,
"TShirtSizeRequired": "sample string 7",
"IsFriendRequest": true,
"FriendRequestNote": "sample string 8",
"IsRoommateRequest": true,
"RoommateRequestNote": "sample string 9",
"PaidAmount": 1.0,
"PendingAmount": 1.0,
"CancellationFeePercentage": 1.0,
"CancellationFeeAmount": 1.0,
"RefundedAmount": 1.0,
"RegistrationDate": "2025-09-10T07:00:07.2070681+00:00",
"RegistrationStatus": "sample string 10",
"PaymentStatus": "sample string 11",
"IsTransfer": true,
"TransferredItemId": 1,
"TransferStatus": "sample string 12",
"TransferFee": 1.0,
"TransferDifference": 1.0,
"TransferOldOrderAdjustment": 1.0,
"UpdatedOn": "2025-09-10T07:00:07.2070681+00:00",
"UpdatedBy": "sample string 13",
"tbChild": {
"$id": "23",
"Id": 1,
"RegistrantId": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Gender": "sample string 4",
"DOB": "2025-09-10T07:00:07.2070681+00:00",
"IsMedicalCondition": true,
"MedicalNeeds": "sample string 5",
"IsAllergy": true,
"AllergicRestrictions": "sample string 6",
"IsDeleted": true,
"InsuranceCompany": "sample string 7",
"InsurancePolicyNumber": "sample string 8",
"InsuranceCompanyPhone": "sample string 9",
"IsPhotographyReleasePermission": true,
"IsSelfAdministeredMedication": true,
"SelfAdministeredMedicationDesc": "sample string 10",
"CreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"tbRegistrant": {
"$id": "24",
"Id": 1,
"UserId": "sample string 2",
"Email": "sample string 3",
"Phone": "sample string 4",
"IsNewsletter": true,
"Wallet": 1.0,
"ParentFirstName": "sample string 5",
"ParentLastName": "sample string 6",
"ParentPhone": "sample string 7",
"ParentEmail": "sample string 8",
"ParentAddress": "sample string 9",
"Parent2FirstName": "sample string 10",
"Parent2LastName": "sample string 11",
"Parent2Phone": "sample string 12",
"Parent2Email": "sample string 13",
"Parent2Address": "sample string 14",
"CreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"IsDeleted": true,
"IsActive": true,
"tbChilds": [
{
"$ref": "23"
},
{
"$ref": "23"
}
],
"tbRegistrantWalletHistories": [
{
"$id": "25",
"Id": 1,
"OrderId": 1,
"RegistrantId": 1,
"Action": "sample string 2",
"TransactionAmount": 1.0,
"PaymentMethod": "sample string 3",
"TransactionType": "sample string 4",
"WalletAmount": 1.0,
"CardAmount": 1.0,
"PaymentIntentId": "sample string 5",
"ExistingWalletAmount": 1.0,
"UpdatedWalletAmount": 1.0,
"PaymentDate": "2025-09-10T07:00:07.2070681+00:00",
"PaymentStatus": "sample string 6",
"Note": "sample string 7",
"tbRegistrant": {
"$ref": "24"
},
"tbOrder": {
"$id": "26",
"Id": 1,
"OfficeId": 1,
"RegistrantId": 1,
"Currency": "sample string 2",
"PaymentGateway": "sample string 3",
"ProgramTotal": 1.0,
"IsCouponApplied": true,
"CouponId": 1,
"CouponDiscountAmount": 1.0,
"ProcessingFeeAmount": 1.0,
"OrderEarlyBirdDiscount": 1.0,
"OrderSiblingDiscount": 1.0,
"SubTotalAmountInclTax": 1.0,
"SubTotalAmountExclTax": 1.0,
"TotalAmount": 1.0,
"PaidAmount": 1.0,
"PendingAmount": 1.0,
"CancellationFeePercentage": 1.0,
"CancellationFeeAmount": 1.0,
"RefundedAmount": 1.0,
"Agent": "sample string 4",
"RegistrantIp": "sample string 5",
"SelectedFormsIds": "sample string 6",
"RegistrationDate": "2025-09-10T07:00:07.2070681+00:00",
"RegistrationStatus": "sample string 7",
"PaymentStatus": "sample string 8",
"tbOffice": {
"$ref": "6"
},
"tbRegistrant": {
"$ref": "24"
},
"tbRegistrationItems": [
{
"$ref": "22"
},
{
"$ref": "22"
}
],
"tbOrderPayments": [
{
"$ref": "25"
},
{
"$ref": "25"
}
],
"orderId": "sample string 9",
"IsPaylater": true,
"IsTransfer": true,
"TransferDifference": 1.0,
"TransferOldOrderAdjustment": 1.0,
"TransferRemainingAmount": 1.0,
"TransferFee": 1.0,
"ClientSecret": "sample string 12",
"WalletAmountPending": 1.0,
"strRegistrationDate": "sample string 13",
"tbDiscount": {
"$ref": "12"
},
"tbOrderPayment": {
"$ref": "25"
},
"tbTransferableRegistrationItem": {
"$ref": "22"
}
},
"ProgramId": 8,
"itemId": 9,
"IsWalletUsed": true,
"strPaymentDate": "sample string 10"
},
{
"$ref": "25"
}
],
"tbOrders": [
{
"$ref": "26"
},
{
"$ref": "26"
}
],
"tbWaitlists": [
{
"$id": "27",
"Id": 1,
"RegistrantId": 1,
"ChildId": 1,
"ProgramId": 1,
"ScheduleId": 1,
"AppliedDate": "2025-09-10T07:00:07.2070681+00:00",
"IsDeleted": true,
"tbChild": {
"$ref": "23"
},
"tbProgram": {
"$ref": "17"
},
"tbProgramSchedule": {
"$ref": "20"
},
"tbRegistrant": {
"$ref": "24"
},
"strAppliedDate": "sample string 2",
"ProgramName": "sample string 3",
"RegistrationAvailablity": 1
},
{
"$ref": "27"
}
],
"tbUser": {
"$id": "28",
"Id": 1,
"UserId": "sample string 2",
"UserName": "sample string 3",
"Password": "sample string 4",
"NewPassword": "sample string 5",
"RoleName": "sample string 6",
"FullName": "sample string 7",
"Email": "sample string 8",
"Phone": "sample string 9",
"ProgramId": 10,
"ValidUpto": "2025-09-10T07:00:07.2070681+00:00",
"StripePlanId": "sample string 12",
"IsRemember": true,
"Wallet": 1.0,
"tbOffice": {
"$ref": "6"
},
"tbCompany": {
"$ref": "3"
},
"tbDirector": {
"$ref": "11"
},
"tbRegistrant": {
"$ref": "24"
},
"tbInstructor": {
"$ref": "5"
},
"tbProgram": {
"$ref": "17"
}
},
"ProgramId": 15,
"Participants": "sample string 16",
"UserName": "sample string 17",
"Password": "sample string 18",
"NewPassword": "sample string 19",
"IsRemember": true
},
"tbRegistrationItems": [
{
"$ref": "22"
},
{
"$ref": "22"
}
],
"tbWaitlists": [
{
"$ref": "27"
},
{
"$ref": "27"
}
],
"ChildCount": 11,
"ParentCount": 12,
"AuthorizedCount": 13,
"EmergencyCount": 14,
"Program": "sample string 15",
"ProgramId": 16,
"Amount": 1.0,
"strDOB": "sample string 17"
},
"tbProgram": {
"$ref": "17"
},
"tbOrder": {
"$ref": "26"
},
"tbRegistrationItemSchedules": [
{
"$ref": "21"
},
{
"$ref": "21"
}
],
"itemId": "sample string 14",
"ClientSecret": "sample string 15",
"ChildName": "sample string 16",
"ProgramName": "sample string 17",
"ProgramTotalInclEarlyBird": 1.0,
"SiblingDiscountRelatedItemId": 1,
"WalletAmountPending": 1.0,
"strRegistrationDate": "sample string 18",
"strPaymentPlanInstallmentDate": "sample string 19",
"PaymentPlanFeeAmountInclTax": 1.0,
"PaymentPlanFeeTax": 1.0,
"CustomDismissalText": "sample string 20",
"tbChilds": [
{
"$ref": "23"
},
{
"$ref": "23"
}
],
"tbDiscount": {
"$ref": "12"
},
"tbRegistrant": {
"$ref": "24"
},
"tbOrderPayment": {
"$ref": "25"
}
},
"WeekDate": "sample string 4",
"tbOrderPayment": {
"$ref": "25"
},
"ScheduleIdToBeTransfer": 1,
"IsCampBeforeCareApplied": true,
"IsCampAfterCareApplied": true,
"IsCampLunchApplied": true
},
{
"$ref": "21"
}
],
"tbWaitlists": [
{
"$ref": "27"
},
{
"$ref": "27"
}
],
"Availability": "sample string 7",
"EndTime": "2025-09-10T07:00:07.2070681+00:00",
"StartTime": "2025-09-10T07:00:07.2070681+00:00",
"InstructorsIds": "sample string 8",
"InstructorsInitials": "sample string 9",
"strCampStartDate": "sample string 10",
"strCampEndDate": "sample string 11",
"strCampStartEndDate": "sample string 12",
"strCampRegistrationEnd": "sample string 13",
"isCampRegDateOpen": true,
"StudentCapacity": 15,
"StudentAvailability": 16,
"isSpotAvailable": true,
"RegistrationCount": 18,
"IsCampAfterCare": true,
"IsCampBeforeCare": true,
"IsCampLunch": true
},
{
"$ref": "20"
}
],
"tbProgramSurveys": [
{
"$id": "29",
"Id": 1,
"OfficeId": 1,
"ProgramId": 1,
"OverallProgramRating": 1,
"OrganizationRating": 1,
"EquipmentRating": 1,
"InstructorsRating": 1,
"IsInstructorsMakeProgramEnthusiastic": true,
"IsRecommendToOtherFamilies": true,
"IsParticipateAgain": true,
"MoreActivitiesRequiredComments": "sample string 2",
"AdditionalComments": "sample string 3",
"CreatedOn": "2025-09-10T07:00:07.2070681+00:00",
"tbOffice": {
"$ref": "6"
},
"tbProgram": {
"$ref": "17"
},
"SurveyCount": 4,
"OverallProgramRatingCount": 5,
"OverallProgramRating1Count": 6,
"OverallProgramRating2Count": 7,
"OverallProgramRating3Count": 8,
"OverallProgramRating4Count": 9,
"OrganizationRatingCount": 10,
"OrganizationRating1Count": 11,
"OrganizationRating2Count": 12,
"OrganizationRating3Count": 13,
"OrganizationRating4Count": 14,
"EquipmentRatingCount": 15,
"EquipmentRating1Count": 16,
"EquipmentRating2Count": 17,
"EquipmentRating3Count": 18,
"EquipmentRating4Count": 19,
"InstructorsRatingCount": 20,
"InstructorsRating1Count": 21,
"InstructorsRating2Count": 22,
"InstructorsRating3Count": 23,
"InstructorsRating4Count": 24,
"IsInstructorsMakeProgramEnthusiasticCount": 25,
"IsInstructorsMakeProgramEnthusiastic1Count": 26,
"IsInstructorsMakeProgramEnthusiastic2Count": 27,
"IsRecommendToOtherFamiliesCount": 28,
"IsRecommendToOtherFamilies1Count": 29,
"IsRecommendToOtherFamilies2Count": 30,
"IsParticipateAgainCount": 31,
"IsParticipateAgain1Count": 32,
"IsParticipateAgain2Count": 33,
"MoreActivitiesRequiredCommentsCount": [
"sample string 1",
"sample string 2"
],
"AdditionalCommentsCount": [
"sample string 1",
"sample string 2"
],
"YearId": 34,
"SessionId": 35
},
{
"$ref": "29"
}
],
"tbRegistrationItems": [
{
"$ref": "22"
},
{
"$ref": "22"
}
],
"tbWaitlists": [
{
"$ref": "27"
},
{
"$ref": "27"
}
],
"InstructorsIds": "sample string 14",
"strStartTime": "sample string 15",
"strEndTime": "sample string 16",
"strStartDate": "sample string 17",
"strEndDate": "sample string 18",
"StartDateTime": "sample string 19",
"EndDateTime": "sample string 20",
"StartEndTime": "sample string 21",
"strRegistrationStart": "sample string 22",
"strRegistrationEnd": "sample string 23",
"strEarlyBirdRegistrationEnd": "sample string 24",
"strPaymentPlanInstallmentDate": "sample string 25",
"DayName": "sample string 26",
"TotalAmountCollected": 27.0,
"TotalAmountReceivable": 28.0,
"SchedulesCount": 29,
"isSpotAvailable": true,
"StudentAvailability": 31,
"RegistrationCount": 32
},
"tbProgramSchedule": {
"$ref": "20"
},
"tbProgramClassInstructors": [
{
"$id": "30",
"Id": 1,
"ProgramClassId": 1,
"InstructorId": 1,
"InstructorInitials": "sample string 2",
"tbInstructor": {
"$ref": "5"
}
},
{
"$ref": "30"
}
],
"tbProgramClassScheduleLogs": [
{
"$id": "31",
"Id": 1,
"ProgramClassId": 1,
"InstructorId": 1,
"ClockInTime": "2025-09-10T07:00:07.2070681+00:00",
"ClockInLocation": "sample string 2",
"ClockInLongitude": 1.0,
"ClockInLatitude": 1.0,
"ClockOutTime": "2025-09-10T07:00:07.2070681+00:00",
"ClockOutLocation": "sample string 3",
"ClockOutLongitude": 1.0,
"ClockOutLatitude": 1.0,
"LogStatus": "sample string 4",
"Note": "sample string 5",
"tbInstructor": {
"$ref": "5"
},
"tbProgramClass": {
"$ref": "16"
},
"CurrentTime": "2025-09-10T07:00:07.2070681+00:00",
"strClockInTime": "sample string 6",
"strClockOutTime": "sample string 7"
},
{
"$ref": "31"
}
],
"InitialInstructors": "sample string 6",
"InstructorName": "sample string 7",
"HiddenInstructorIds": "sample string 8",
"IsEvaluated": true,
"strStartTime": "sample string 10",
"strEndTime": "sample string 11",
"strClassDate": "sample string 12",
"tbSchool": {
"$ref": "18"
},
"InstructorsIds": "sample string 13"
},
"tbSchool": {
"$ref": "18"
},
"ClassDate": "2025-09-10T07:00:07.2070681+00:00",
"StartTime": "2025-09-10T07:00:07.2070681+00:00",
"EndTime": "2025-09-10T07:00:07.2070681+00:00",
"ProgramName": "sample string 8"
},
{
"$ref": "15"
}
],
"tbForms": [
{
"$id": "32",
"Id": 1,
"OfficeId": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"FormType": "sample string 4",
"IsSignRequired": true,
"IsMandatory": true,
"CreatedOn": "2025-09-10T07:00:07.2070681+00:00",
"IsDeleted": true,
"VMOffice": {
"$ref": "6"
}
},
{
"$ref": "32"
}
],
"tbInstructors": [
{
"$ref": "5"
},
{
"$ref": "5"
}
],
"tbInstructorSchedules": [
{
"$id": "33",
"Id": 1,
"OfficeId": 1,
"InstructorId": 1,
"Day": "sample string 2",
"DayName": "sample string 3",
"tbOffice": {
"$ref": "6"
}
},
{
"$ref": "33"
}
],
"tbState": {
"$ref": "4"
},
"tbOfficeRecurrings": [
{
"$id": "34",
"Id": 1,
"OfficeId": 1,
"PaymentMethodId": "sample string 2",
"PayorId": "sample string 3",
"LastFour": "sample string 4",
"CardBrand": "sample string 5",
"TokenGeneratedDate": "2025-09-10T07:00:07.2070681+00:00",
"RecurringId": "sample string 6",
"RecurringFee": 1.0,
"RecurringInterval": "sample string 7",
"NextPaymentDate": "2025-09-10T07:00:07.2070681+00:00",
"SubscriptionStatus": "sample string 8",
"RecurringStatus": "sample string 9",
"SubscriptionCreatedDate": "2025-09-10T07:00:07.2070681+00:00",
"FailedPaymentCount": 1,
"LastFailedPaymentDate": "2025-09-10T07:00:07.2070681+00:00",
"Notes": "sample string 10",
"tbOffice": {
"$ref": "6"
},
"tbDirectors": [
{
"$ref": "11"
},
{
"$ref": "11"
}
],
"PTAdminApiKey": "sample string 11",
"PTApiUrl": "sample string 12",
"dtSubscriptionCreatedDate": "sample string 13",
"dtNextPaymentDate": "sample string 14",
"strTokenGeneratedDate": "sample string 15"
},
{
"$ref": "34"
}
],
"tbPrograms": [
{
"$ref": "17"
},
{
"$ref": "17"
}
],
"tbProgramPayments": [
{
"$ref": "19"
},
{
"$ref": "19"
}
],
"tbProgramSchedules": [
{
"$ref": "20"
},
{
"$ref": "20"
}
],
"tbProgramSurveys": [
{
"$ref": "29"
},
{
"$ref": "29"
}
],
"tbOrders": [
{
"$ref": "26"
},
{
"$ref": "26"
}
],
"tbSchools": [
{
"$ref": "18"
},
{
"$ref": "18"
}
],
"OfficeStatus": "sample string 32",
"Revenue": 1.0,
"NumberOfStudents": 33,
"Programs": 34,
"OfficeNoAllowed": 35,
"OfficeNoLeft": 36,
"DirRole": "sample string 37",
"Zipcode": "sample string 38",
"amount_per_payment": "sample string 39",
"RecurringFee": 1.0,
"SubscriptionStatus": "sample string 40"
},
"tbState": {
"$ref": "4"
},
"tbInstructorSchedules": [
{
"$ref": "33"
},
{
"$ref": "33"
}
],
"tbProgramClassScheduleLogs": [
{
"$ref": "31"
},
{
"$ref": "31"
}
],
"StateName": "sample string 18",
"PayrollHours": "sample string 19",
"PayrollAmount": 1.0,
"StartDate": "2025-09-10T07:00:07.2070681+00:00",
"EndDate": "2025-09-10T07:00:07.2070681+00:00",
"StartTime": "2025-09-10T07:00:07.2070681+00:00",
"EndTime": "2025-09-10T07:00:07.2070681+00:00",
"SessionId": 24,
"YearId": 25,
"strDateOfBirth": "sample string 26",
"strHireDate": "sample string 27"
},
{
"$ref": "5"
}
],
"tbOffices": [
{
"$ref": "6"
},
{
"$ref": "6"
}
],
"tbSchools": [
{
"$ref": "18"
},
{
"$ref": "18"
}
]
},
"tbOffices": [
{
"$ref": "6"
},
{
"$ref": "6"
}
],
"StateName": "sample string 14",
"UserName": "sample string 15",
"Password": "sample string 16",
"SubscriptionPlanName": "sample string 17"
},
"tbFranchiseOperations": [
{
"$ref": "1"
},
{
"$ref": "1"
}
]
}
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |