BrightofficeAPI
The following operations are supported. For a formal definition, please review the Service Description.
- AccessPaysuiteCancelContract
- AccessPaysuiteCreateContract
- AccessPaysuiteCreateCustomer
- AccessPaysuiteFreezeContractPayments
- AccessPaysuiteIsStartDateValidatForContract
- AddApplicationTree
- AddDelegateToTrainingCourse
- AddDelegateToTrainingCourseV2
- AddNewWorkFlowGroup
- AssignNewCompanyIdToData
- AssignNewCompanyIdToDataWithNewGroupCode
- BackupApplicationTree
- CancelDebtorRepeatPayment
- CaseRecalculatePaymentPlan
- CheckApplicationModeInTreeMenu
- CheckAutoScheduler
- CheckDataBaseName
- CheckExistingApplicationMode
- CheckIfServiceBackUpRunned
- CheckIfUsernameExists
- CheckWorkflowExists
- CheckforBorrowingsandInvestments
- CleanDatabaseData
- ConfirmClearAcceptPayment
- ConfirmCustomerUserMFA
- CopyReportData
- CreateADPData
- CreateBarCode
- CreateCase
- CreateCaseAsset
- CreateCaseJSON
- CreateClearAcceptPaymentRequest
- CreateCompanyMastRecord
- CreateCreditCardDetails
- CreateCustomerUser
- CreateDTTermsCustom
- CreateDatabaseBackup
- CreateDatabaseView
- CreateDelegateQualification
- CreateDocumentToPdf
- CreateGoCardlessSubscription
- CreateModulesOptionsRecord
- CreateNewAccidentAlerterJSON
- CreateNewAppointment
- CreateNewJob
- CreateNewLearnerDelegate
- CreateNewProspect
- CreateNewProspectV2
- CreateNewProspectWP
- CreateNewSalesInvoice
- CreateNewTaskLogging
- CreateNewViewOnDatabase
- CreateNewWorkflowGroup
- CreateNotes
- CreateOpayoRecurringDetails
- CreateOpayoTakePaymentHostedFields
- CreatePaymentReceipt
- CreateProductLineonProductInvoice
- CreateProductLinesData
- CreateRefinanceCase
- CreateSalesOrder
- CreateSource
- CreateSuperUserForCompany
- CreateSuperUserForCompanyWithNewGroupCode
- CreateTakePayment
- CreateTrainingCourseDelegateInvoice
- CreateTransactions
- CreateUpdateSupplierDetails
- CreditSafeAddCompanyToPortfolio
- CreditSafeCompanyCreditReport
- CreditSafeCompanySearch
- CreditSafeConsumerReport
- CreditSafeDirectorCreditReport
- CreditSafeDirectorSearch
- CustomerLoginVerification
- CustomerPasswordChange
- CustomerStatuses
- CustomerUserChangePassword
- CustomerUserResetPassword
- CustomerUserSendResetPassword
- DeleteApplicationTree
- DeleteCustomer
- DeleteJobProductBarcode
- DeleteProductDeliveryInBarcode
- DeleteProductDeliveryInDetail
- DeleteProductLine
- DeleteProductQuantityAdjustmentBarcode
- DeleteProductQuantityAdjustmentDetail
- DoesViewExists
- DownloadBackupFile
- DownloadBackupFiles
- ExecuteTriggerEvent
- ExternalLoginVerification
- FetchifyEmailVerification
- FetchifyMobileVerification
- GetADPData
- GetAccountsAnalytics
- GetActiveTrainingCounties
- GetActiveTrainingCourseCodes
- GetActiveTrainingCoursesList
- GetActiveTrainingCoursesList2
- GetActiveTrainingCoursesListByCustomer
- GetActiveTrainingCoursesListByCustomer_NumbOfPages
- GetActiveTrainingCoursesListByCustomer_Paginated
- GetActiveTrainingCoursesListExtJSON
- GetActiveTrainingCoursesListJSON
- GetActiveTrainingCoursesListJSON2
- GetActiveTrainingCoursesListJSON2_NumbOfPages
- GetActiveTrainingCoursesListJSON2_Paginated
- GetActiveTrainingSector
- GetAdjustmentReasonList
- GetAllCompanies
- GetAllCompaniesWithActiveFilter
- GetAllCompaniesWithActiveFilterDatabase
- GetAllCourseVenuesJSON
- GetAllDatabaseView
- GetAllDrives
- GetAllMatterTypesJSON
- GetAllTrainingCoursesListExtJSON
- GetAllTrainingCoursesListExtJSON2
- GetAllViewDefinitions
- GetAllWorkFlowTables
- GetApplicationCRMTreeType
- GetApplicationModeDetails
- GetAppointmentDetailsMobile
- GetAppointmentListForUserBetweenDates
- GetAppointmentListForUserBetweenDatesJSON
- GetAppointmentOutcomeList
- GetAppointmentStatusListForAppointmentCode
- GetAppointmentStatusListForAppointmentCodeJSON
- GetAppointments
- GetBackupFilesList
- GetBankProviders
- GetBusinessFormsByJob
- GetBusinessFormsByJobJSON
- GetBusinessFormsByTypeJSON
- GetBusinessFormsQuestionnaireByJob
- GetBusinessFormsQuestionnaireByJobJSON
- GetBusinessFormsQuestionnaireByJobJSONV2
- GetBusinessFormsQuestionnaireByJobJSONV3
- GetBusinessFormsQuestionnaireByJobMultiRecord
- GetBusinessFormsQuestionnaireByJobMultiRecordAnswers
- GetBusinessFormsQuestionnaireByJobMultiRecordAnswersJSON
- GetBusinessFormsQuestionnaireByJobMultiRecordAnswersJSONV2
- GetBusinessFormsQuestionnaireByJobMultiRecordAnswersJSONV3
- GetBusinessFormsQuestionnaireByJobMultiRecordJSON
- GetCase
- GetCaseAssessorByCaseJSON
- GetCaseByFilter
- GetCaseByFilterJSON
- GetCaseByOldReference
- GetCaseIncomeExpenditure
- GetCaseSettlementFigure
- GetCaseStatusesByApplicantCodeForUser
- GetCaseStatusesByApplicantCodeForUserJSON
- GetCasesByFilter
- GetCasewithLastNote
- GetCasewithNotes
- GetCharsPerLineForJob
- GetCharsPerLineForJobJSON
- GetCloudDataForCreditCheck
- GetCloudDataForCreditCheckJSON
- GetCompany
- GetCompanyBOG
- GetCompanyMastByDbNameAndURL
- GetConfigurationDatasets
- GetContracts_Investments
- GetCreditCardDetails
- GetCreditCheck
- GetCustomer
- GetCustomerByFilter
- GetCustomerByName
- GetCustomerCountUserAndCustomerType
- GetCustomerCountUserAndCustomerTypeWP
- GetCustomerDetailsJSON
- GetCustomerListForUser
- GetCustomerListForUserAndCustomerType
- GetCustomerListForUserAndCustomerTypeJSON
- GetCustomerListForUserAndCustomerTypeSortOrderJSON
- GetCustomerListForUserAndCustomerTypeWP
- GetCustomerListForUserJSON
- GetCustomerListWithExternalLogin
- GetCustomerStatusList
- GetCustomerStatusListBetweenDates
- GetCustomerStatusListBetweenDatesJSON
- GetCustomerStatusListBetweenDatesJSONV2
- GetCustomerStatusListJSON
- GetCustomerTypesList
- GetCustomerTypesListBetweenDates
- GetCustomerTypesListBetweenDatesJSON
- GetCustomerTypesListJSON
- GetCustomerUserCustomerCodes
- GetCustomersByParams
- GetDTGroupInvoiceTerms
- GetDTInvoiceTerms
- GetDataAnalyticsByDateRange
- GetDataAnalyticsbyModule
- GetDataBaseSize
- GetDataFolderByParams
- GetDataFolderByParamsV1
- GetDataFolderItemWebPath
- GetDebtor
- GetDebtorsTransactionListJSON
- GetDebtorsTransactionListWP
- GetDebtorsTransactionsStatusesByCodeForUserJSON
- GetDebtorsTransactionsStatusesByCodeForUserWP
- GetDelegateAttendance
- GetDelegateConfirmationStatusListJSON
- GetDelegateCourseList
- GetDelegateListFromCodeStatusTypeDateJSON
- GetDelegateListFromCodeStatusTypeDatePlusCustomFieldsJSON
- GetDelegateListFromCodeStatusTypeDateWP
- GetDelegateQualificationsList
- GetDelegateStatusListBetweenDatesJSON
- GetDelegateStatusListBetweenDatesWP
- GetDelegateTypesListBetweenDatesJSON
- GetDelegateTypesListBetweenDatesWP
- GetDelegatesListByCustomer
- GetDiscountCodes
- GetDistanceBetweenPostcodes
- GetDocumentFromFileManager
- GetDocumentList
- GetDocumentTagList
- GetDocumentTagListJSON
- GetDownloadReport
- GetDrivesInfo
- GetDynamicDataByCase
- GetEmployeeListForAppointmentsJSON
- GetEquipmentScheduleSerialNumbersJSON
- GetFileManagerDocuments
- GetFileManagerFiles
- GetFinancialInfoSetting
- GetFinancialTransactions
- GetFinancialYearDetail
- GetFinancialYearSummary
- GetGroupCodeSettingForUserJSON
- GetGroupCodeTree
- GetInvoiceTerms
- GetInvoiceTransactions
- GetJobByREf
- GetJobProductLinesData
- GetJobStatuses
- GetJobsByFilerParams
- GetJobsByFilerParamsJSON
- GetJobsByParams
- GetJobsStatusesByJobCodeForUser
- GetJobsStatusesByJobCodeForUserJSON
- GetJobsStatusesByJobCodeForUserJSONNew
- GetJobsStatusesByJobCodeForUserNew
- GetLANBackupInfo
- GetLetterGroupsAssigned
- GetMatterTypes
- GetMonthlyExpenditureBlank
- GetMonthlyIncomeBlank
- GetNotes
- GetOAuth2ImapToken
- GetOAuth2TesterSettings
- GetOpenBankingStatus
- GetOtherAddresses
- GetPostcodeLookup
- GetPrimaryGroupDetail
- GetPrimaryGroupsJSON
- GetPrimaryGroupsWP
- GetProcessingStatusMessage
- GetProductAssembly
- GetProductDeliveryIn
- GetProductDeliveryInList
- GetProductDeliveryInPOProductList
- GetProductDeliveryPOList
- GetProductImages
- GetProductQuantityAdjustmentList
- GetProductQuantityAdjustmentSingle
- GetProductsBySearch
- GetProductsBySearchJSON
- GetProductsJSON
- GetProductsJSONV2
- GetProductsWP
- GetProductsWithNotes
- GetProviderProductDetails
- GetProviderProductFeesByTerm
- GetProviderProducts
- GetProviders
- GetRecordHistory
- GetRecordMultiContacts
- GetRecordsToCaptureForJob
- GetRecordsToCaptureForJobJSON
- GetReportDetails
- GetReports
- GetSalesByDate
- GetSalesOrders
- GetSalesProductLinesData
- GetSalesStageList
- GetSalesWalkOrder
- GetSecondaryGroupsJSON
- GetSecondaryGroupsWP
- GetServerPath
- GetSingleTrainingCourse
- GetSingleTrainingCourseJSON
- GetSingleTrainingProduct
- GetSingleTrainingProductJSON
- GetSiteInfo
- GetSmartphoneSettings
- GetSource
- GetSqlToCopyReport
- GetSqlToCreateView
- GetStaff
- GetStatusesAssigned
- GetSuperUserForCompany
- GetSupplierDetails
- GetSupplierList
- GetTableListWithRecordCount
- GetTakePayment
- GetTakePaymentTransaction
- GetTaskLoggingRecords
- GetTopXProducts
- GetTotalNumberOfSteps
- GetTrainingCoursesJSON
- GetTreeResults
- GetUserModulesSettingForUserJSON
- GetUserSettingForUserJSON
- GetUserStaffDetails
- GetVLEQuestions
- GetVLEQuestionsByTrainerSearch
- GetVLESettings
- GetViewColumnList
- GetViewDefinition
- GetWarehouseLocation
- GetWelcomeText
- GetWelcomeTextJSON
- GetWordDocuments
- GetWorkFlowGroup
- GetWorkSchedule
- GetWorkScheduleStatusesJSON
- GetWorkflowAnswers
- GetWorkflowQuestions
- GetWorkflowUpdateDates
- HasB2BClients
- HelloWorld
- InvokeADPCall
- IsAccessPaysuiteContractCreated
- IsAccessPaysuiteCustomerCreated
- IsAccessPaysuiteEnabled
- LogMobileError
- OpenBankingHandShakeInvoke
- OrdoCollectPayment
- OrdoDisbursePayment
- OrdoVRPCancelMandate
- OrdoVRPCreateMandate
- OrdoVRPGetMandateInfo
- PostCaseSettlementTransaction
- ReassignJobToUserJSON
- ReassignJobToUserWP
- RefreshDatabaseViews
- RollBackCompanyData
- SaveAppointmentDetailsMobile
- SaveJobContactDetails
- SaveJobProductBarcode
- SaveJobProductLinesData
- SaveJobProductLinesDataV2
- SaveProductAssemblyLine
- SaveProductDeliveryIn
- SaveProductDeliveryInBarcode
- SaveProductDeliveryInDetail
- SaveProductQuantityAdjustment
- SaveProductQuantityAdjustmentDetail
- SaveProductQuantityAdjustmentDetailBarcode
- SaveVLEQuestionsAnswer
- SearchBankCaseDetails
- SearchCases
- SearchCasesBySearchTypeAndUserPermissionsJSON
- SearchCasesBySearchTypeAndUserPermissionsJSONV2
- SearchCustomers
- SearchCustomersByDetails
- SearchDebtors
- SearchJobs
- SearchJobs2
- SearchJobsBySearchTypeAndUserPermissionsCountJSON
- SearchJobsBySearchTypeAndUserPermissionsCountWP
- SearchJobsBySearchTypeAndUserPermissionsJSON
- SearchJobsBySearchTypeAndUserPermissionsJSONV2
- SearchJobsBySearchTypeAndUserPermissionsWP
- SearchLearnerDelegatesJSON
- SendBrightSignSMS
- SendCustomerUserMFA
- SendSupportEmail
- SetGroupCode
- SetNewDBAsposeVersion
- SetStatusForApplicantID
- SetStatusForApplicantIDJSON
- SetStatusForDebtorsTransactionsJSON
- SetStatusForDebtorsTransactionsWP
- SetStatusForJob
- SetStatusForJobJSON
- SetStatusForJobJSONNew
- SetStatusForJobNew
- SetStatusForWorkScheduleJSON
- ShoppingCart_GetProductLineJobs
- ShoppingCart_ProductLineUpdate
- Smartphone_WriteErrorToTheCloud
- TestCase
- UpdateAnswer
- UpdateAnswerJSON
- UpdateApplicationTree
- UpdateAppointmentOutcomeForAppointment
- UpdateAppointmentStatusListForAppointmentCodeJSON
- UpdateBOUsersPasswords
- UpdateCase
- UpdateCaseAssessorJSON
- UpdateCaseGoCardlessMandateIdAndSubscriptionId
- UpdateCaseLockPaymentPlan
- UpdateCaseMultiple
- UpdateCaseSelectedValue
- UpdateCaseStatus
- UpdateCompany
- UpdateCompanyActiv
- UpdateConfigTables
- UpdateConfigTablesWithNewGroupName
- UpdateCreditCardDetailsStatus
- UpdateCustomer
- UpdateCustomerStatus
- UpdateDTGroupInvoiceTerms
- UpdateDataFolderList
- UpdateDebtor
- UpdateDebtorTransaction
- UpdateDelegateAttendance
- UpdateDelegateChangeTrainingCourse
- UpdateDelegateDetails
- UpdateDelegateOnTrainingCourse
- UpdateDelegateQualification
- UpdateJobDataFolder
- UpdateJobSalesRep
- UpdateJobsUploadedPhotoDTag
- UpdateJobsUploadedVideoDTag
- UpdateLastBackupDate
- UpdateLetterPaths
- UpdateMultiRecordsQuestionnaire
- UpdateMultiRecordsQuestionnaireJSON
- UpdatePaymentPlanCaseTermExtension
- UpdatePaymentPlanHolidays
- UpdateProductLinesData
- UpdateSalesData
- UpdateSalesWalkOrderStatus
- UpdateSalesWalkOrderWalkDate
- UpdateSmartphoneSettings
- UpdateSource
- UpdateVLEAnswersOutcome
- UploadBusinessFormSignature
- UploadBusinessFormSignatureV2
- UploadDatabase
- UploadLogo
- UploadPhotoToAccidentAlertsGPSWithDTag
- UploadPhotoToCustomer
- UploadPhotoToCustomerGPS
- UploadPhotoToJob
- UploadPhotoToJobGPS
- UploadPhotoToJobGPSWithDTag
- UploadVideoFile
- UploadVideoFileChunks
- UploadVideoFileWithDTag
- UploadWordDocs
- Website_CMSPages
This web service is using http://tempuri.org/ as its default namespace.
Recommendation: Change the default namespace before the XML Web service is made public.
Each XML Web service needs a unique namespace in order for client applications to distinguish it from other services on the Web. http://tempuri.org/ is available for XML Web services that are under development, but published XML Web services should use a more permanent namespace.
Your XML Web service should be identified by a namespace that you control. For example, you can use your company's Internet domain name as part of the namespace. Although many XML Web service namespaces look like URLs, they need not point to actual resources on the Web. (XML Web service namespaces are URIs.)
For XML Web services creating using ASP.NET, the default namespace can be changed using the WebService attribute's Namespace property. The WebService attribute is an attribute applied to the class that contains the XML Web service methods. Below is a code example that sets the namespace to "http://microsoft.com/webservices/":
C#
[WebService(Namespace="http://microsoft.com/webservices/")]
public class MyWebService {
// implementation
}
Visual Basic
<WebService(Namespace:="http://microsoft.com/webservices/")> Public Class MyWebService
' implementation
End Class
C++
[WebService(Namespace="http://microsoft.com/webservices/")]
public ref class MyWebService {
// implementation
};
For more details on XML namespaces, see the W3C recommendation on Namespaces in XML.
For more details on WSDL, see the WSDL Specification.
For more details on URIs, see RFC 2396.