API Description
POST
17.0/app/accounts/getavailablecredits

Retrieves available credits for a specified bank account based on the provided request details. This endpoint processes the request to fetch credit information, populates a list of credit items, calculates the total amount, and returns an AvailableCreditItem object.

POST
17.0/app/accounts/paychargewithexistingcredit

Processes a payment for a charge using existing credits. Validates the request parameters, converts the CreditIds list to a Collection, and invokes the tenancy manager to apply credits.

GET
17.0/app/accounts/{bankaccountid}/amountfeestransfer

Retrieves the amount of fees available for transfer for the specified bank account, calculated as of the current date.

POST
17.0/app/accounts/createcreditnote

Creates a new credit note for the specified contact and product, validating essential parameters before invoking the transaction manager to process the creation.

POST
17.0/app/accounts/reveivepaymentforcharge

Receives a payment for the specified charge, validating essential parameters before invoking the tenancy manager to process the payment application.

PUT
17.0/app/accounts/{id}/updatetransactions

Updates an existing transaction by ID, applying business logic rules for status, dates, and flags based on the provided request data. Validates the transaction exists, saves changes, and syncs related linked transactions or account statuses as needed.

GET
17.0/app/accounts/{transactionid}/transactionunlinkchecker

Checks if a transaction can be unlinked and returns a list of unlink items (e.g., dependent records) if unlinking is not possible.

DELETE
17.0/app/accounts/{transactionid}/deletetransaction

Deletes a specified transaction after validation and handles any associated receipt undoing.

GET
17.0/app/accounts/{transactionid}/transactiondeletechecker

Checks if a transaction can be deleted and returns a list of info items (e.g., dependent records) if deletion is not possible.

GET
17.0/app/accounts/{transactionid}/voidtransaction

Voids a specified transaction after validation, overriding the site ID temporarily if needed.

POST
17.0/app/accounts/mergesplittransactions

Merges split credit transactions based on the provided request.

GET
17.0/app/accounts/{transactionid}/unlinktransaction

Unlinks a specified transaction after validation.

POST
17.0/app/accounts/createopeningbalance

Creates an opening balance entry for a bank account using the provided request details.

POST
17.0/app/accounts/getbankaccountforcompany

Retrieves the bank account ID for the specified company based on the provided bank account type.

POST
17.0/app/accounts/gettenancyforproperty

Retrieves the tenancy ID for the specified property and contact.

GET
17.0/app/accounts/{propertyid}/getcompanyforproperty

Retrieves the company ID associated with the specified property.

GET
17.0/app/accounts/{contactid}/defaulttenancyproperty

Retrieves the default tenancy property for the specified contact.

API Description
POST
17.0/app/addresslookup

Performs an address lookup based on the passed lookup query

API Description
POST
17.0/app/utilityswitching/addresslookup/match/property

No description available.

API Description
POST
17.0/app/utilityswitching/switches/council/allocation

No description available.

API Description
POST
17.0/app/applicants/list

Gets a list of Applicants that match the passed filters

POST
17.0/app/applicants/list/ids

Gets applicant details based on the passed ids

API Description
GET
17.0/app/contacts/{appointmentid}/appointment

Gets a list of Contacts by appointmentId

API Description
POST
17.0/app/appointments

Creates a new appointment with the passed details

GET
17.0/app/appointments/{id}

Gets details of an appointment

PUT
17.0/app/appointments/{id}

Updates an appointment

DELETE
17.0/app/appointments/{id}

Deletes an appointment

GET
17.0/app/appointments/{id}/letterrecords

Retrieves the relevant contact and property id for writing letters about the passed appointment

DELETE
17.0/app/appointments/{appointmentid}/futurerecurringappointments/{recurrenceappointmentid}/type/{typeid}

Deletes the selected appointment and all of the future recurring appointments of the selcted appoitment's series

API Description
GET
17.0/app/utilityswitching/addresslookup?query={query}

Performs an address lookup for the passed query text

GET
17.0/app/utilityswitching/addresslookup/{addressid}

Gets address details for the passed address id

POST
17.0/app/utilityswitching/addresslookup/format

Formats the passed address lookup result

API Description
POST
17.0/app/bankaccounts/lookup

Gets the Bank Account Id based on the passed request details

API Description
POST
17.0/app/utilityswitching/switches/council/buyer

No description available.

API Description
POST
17.0/app/certificates/list

Gets a list of Certificates that match the passed filters

POST
17.0/app/property/{propertyid}/certificates

Gets a list of Certificates for a property that match the passed filters

POST
17.0/app/contact/{contactid}/certificates

Gets a list of Certificates for a contact that match the passed filters

API Description
GET
17.0/app/system/configuration/company?companyid={companyid}

Retrieve a list of CompanyConfiguration settings

GET
17.0/app/system/configuration/company/{companyid}/{settingname}

Gets the value of a Company Configuration setting

POST
17.0/app/system/configuration/company/{companyid}/update

Updates the passed Company Configuration setting

API Description
POST
17.0/app/contacts/list

Gets a list of Contacts

POST
17.0/app/contacts/list/ids

Gets a list of Contacts based on the passed contact Ids

API Description
GET
17.0/app/contacts/{id}/name

Gets a formatted contact name

API Description
GET
17.0/app/contacts/{id}/requirements

Gets a Contact's Property Requirements

API Description
POST
17.0/app/contacts/{contactid}/changestatus

Changes the Status of a Contact

API Description
GET
17.0/app/contacts/{id}/summary

Gets basic information for a Contact and their Property Requirements

API Description
POST
17.0/app/contacts/{contactid}/changetype

Changes the Type of a Contact

GET
17.0/app/contacts/{contacttypeid}/systemcontacttype

Retrieves the system contact type ID corresponding to the specified contact type.

API Description
POST
17.0/app/properties/{id}/copy

Copies a property

API Description
POST
17.0/app/correspondence/letter

Creates a new merged letter using the passed mail merge ids

POST
17.0/app/correspondence/letter/bulk

Creates a new merged bulk letter using the passed mail merge ids

POST
17.0/app/correspondence/propertyparticulars

Creates a new merged letter using the passed mail merge ids

GET
17.0/app/correspondence/property/{propertyid}/particulars/{templateid}/exists

No description available.

POST
17.0/app/correspondence/documents/{id}/createpdf

Creates a PDF of the specified document

GET
17.0/app/correspondence/documents/mergefields

Gets all merge fields for document templates

API Description
GET
17.0/app/system/countries

Gets a list of all countries

API Description
GET
17.0/app/user/current

Retrieve details of the current user

API Description
POST
17.0/app/contacts/duplicatechecks/namecheck

Checks for duplicate contacts with the same name

POST
17.0/app/contacts/duplicatechecks/companycheck

Checks for duplicate contacts with the same company name

POST
17.0/app/contacts/duplicatechecks/emailcheck

Checks for duplicate contacts with the same email address

POST
17.0/app/contacts/duplicatechecks/mobilecheck

Checks for duplicate contacts with the same mobile number

API Description
POST
17.0/app/correspondence/email/preview/mergefields

Process merge fields in the email subject and body

POST
17.0/app/correspondence/email/queue

Adds the passed email to the send queue

POST
17.0/app/correspondence/email/propertybulletin

Creates a preview of a property bulletin email

POST
17.0/app/correspondence/email/propertydetails

Creates a preview of a property details email

POST
17.0/app/correspondence/email/newsletter

Creates a preview for a newsletter email

API Description
GET
17.0/app/properties/epc/lookup?postcode={postcode}&usage={usage}

Retrieves a list of EPCs

POST
17.0/app/properties/{id}/epc/{epcreference}

Creates an EPC on a Property

POST
17.0/app/properties/{id}/epc/attach

Creates an EPC record for the passed property from the uploaded EPC pdf

API Description
POST
17.0/app/keys/createkeyhistory

Creating a new key history record and updating its status.

POST
17.0/app/keys/updatekeyhistory

Updates an existing key history record to mark it as returned.

POST
17.0/app/keys/{id}/signoutpdf

Generates and returns a PDF report for a key sign-out record.

API Description
POST
17.0/app/utilityswitching/switches/landlord

Creates a new Landlord Utility Switch

API Description
PUT
17.0/app/correspondence/letterhead/{id}/file

Updates the letterhead file for the passed letterhead id

API Description
POST
17.0/app/auth/login

Logs in to an Acquaint database

POST
17.0/app/auth/logout

Logs out of an Acquaint database

POST
17.0/app/auth/forgotpassword

Creates a Forgot Password email for the User

POST
17.0/app/auth/validatepasswordreset

Validate User Forgot Password Token. Token is emailed to use via ForgotPassword

POST
17.0/app/auth/validate

No description available.

API Description
POST
17.0/app/maintenancerequests/list

Retrieves maintenance requests for a specified branch and status.

GET
17.0/app/maintenancerequests/{id}/setasoutstanding

Sets the specified maintenance request status to Outstanding.

GET
17.0/app/maintenancerequests/{id}/workorder/{workorderid}

Converts an existing maintenance request into a work order and migrates any associated images.

GET
17.0/app/maintenancerequests/{id}/setasrejected

No description available.

API Description
GET
17.0/app/marketing/emaildesigner/settings

Retrieves all system config settings used on the Marketing Email Designer screen

PUT
17.0/app/marketing/emaildesigner/settings

Updates system config settings used by the Marketing Email Designer screen with the passed settings

POST
17.0/app/marketing/emaildesigner/preview

Generates a preview of a marketing email using the settings passed in the request

API Description
POST
17.0/app/match/properties

No description available.

POST
17.0/app/match/contacts

No description available.

API Description
POST
17.0/app/contacts/{fromid}/merge/{toid}

Merges a contact with another contact

API Description
POST
17.0/app/properties/{fromid}/merge

Merges a property with another property

API Description
POST
17.0/app/utilityswitching/mprnlookup/{mprn}

Performs a property lookup based on the passed MPRN

API Description
POST
17.0/app/contacts

Creates a new Contact record

API Description
POST
17.0/app/marketing/news/{id}/picture

No description available.

API Description
GET
17.0/app/offerprogressionnotes/{propertyid}/{chainid}

No description available.

API Description
GET
17.0/app/office/authurl

Get auth url for Office 365

POST
17.0/app/office/{userid}/accesstoken

Get access token from auth code

API Description
POST
17.0/app/properties/deposit

Calculates the deposit using the passed property information

API Description
POST
17.0/app/properties/disinstruction/create

Creates a property disinstruction record and performs related updates

API Description
GET
17.0/app/properties/{id}/floorplan?type={type}

Gets the floor plan linked to the specified property

POST
17.0/app/properties/{id}/floorplan/{type}

Adds a floorplan to the specified property

API Description
POST
17.0/app/properties/list

Gets a list of Properties

POST
17.0/app/properties/list/ids

Get details for properties specified in POST body

API Description
GET
17.0/app/properties/{id}/pictures/{pictureid}?type={type}

Gets a Property Picture

POST
17.0/app/properties/{id}/pictures

Adds a picture to the specified property

POST
17.0/app/properties/{id}/pictures/move

Moves a property picture from its current location to a new location

DELETE
17.0/app/properties/{id}/pictures/{picturenumber}

Deletes the specified picture from the specified property

API Description
GET
17.0/app/properties/{id}/applicablestatuses

Retrieves a list of Statuses a Property can change status to

API Description
GET
17.0/app/properties/{id}/summary

Gets basic information for a Contact and their Property Requirements

API Description
GET
17.0/app/properties/{id}/upload/status

Retrieves the upload status for the passed property id

API Description
POST
17.0/app/utilityswitching/switches/purchaser

Creates a new Purchaser Utility Switch

API Description
GET
17.0/app/qrcode/property/{propertyid}

Generates a QR code containing a URL to the passed property

GET
17.0/app/qrcode/custom?data={data}

Generates a QR code containing the passed data

API Description
GET
17.0/app/sendoffers/{id}

No description available.

API Description
GET
17.0/app/signable/senddocumentreminder/{asynckey}

Send a Reminder for a Signable document

GET
17.0/app/signable/cancelunsigneddocument/{asynckey}

Cancel a unsigned document

POST
17.0/app/signable/senddocument/{contactdocumentid}

This sends a contact document to signable.

GET
17.0/app/signable/getdocumenthistory/{asynckey}

Cancel a unsigned document

GET
17.0/app/signable/getcredits

Fetches the credits for a specific customer

GET
17.0/app/signable/getcontactandsignatoryroles/{contactdocumentid}

Get contacts and signatory roles for contact document

API Description
GET
17.0/app/correspondence/sms/credits

Retrieves number of SMS credits available

POST
17.0/app/correspondence/sms/preview

Process merge fields in the sms body

API Description
GET
17.0/app/utilityswitching/supportcase/{id}

Gets a Support Case from Property Button

POST
17.0/app/utilityswitching/supportcase

Creates a new Support Case in Property Button

POST
17.0/app/utilityswitching/supportcase/{supportcaseid}/reply

Adds a Reply to a Support Case to Property Button

API Description
GET
17.0/app/utilityswitching/supportcases/reasons

Gets all primary Support Case Reasons

GET
17.0/app/utilityswitching/supportcases/reasons/{primaryreasonsortindex}

Gets all secondary Support Case Reasons for the passed sort index of the primary Support Case Reason

API Description
POST
17.0/app/utilityswitching/supportcases/list

Gets a list of Support Cases from Property Button

API Description
POST
17.0/app/utilityswitching/switches/council/surrender

No description available.

API Description
POST
17.0/app/utilityswitching/switches/list

Gets a list of Switches from Property Button

API Description
GET
17.0/app/utilityswitching/switches/statuses

Gets a list of switch statuses

API Description
GET
17.0/app/system/codes

Gets a list of System Codes

API Description
GET
17.0/app/system/configuration/branch

Retrieve a list of non-sensitive SystemConfiguration settings

GET
17.0/app/system/configuration/branch/{settingname}

Gets the value of a System Configuration setting

GET
17.0/app/system/configuration/branch/{siteid}/{settingname}

Gets the value of a System Configuration setting

POST
17.0/app/system/configuration/branch/{siteid}/update

Updates the passed System Configuration setting

API Description
GET
17.0/app/system/info

No description available.

API Description
POST
17.0/app/tasks/list

Retrieves a List of Tasks

API Description
GET
17.0/app/tenancy/checkpropertytenancy/{propertyid}

Retrieves the contact id of the active tenancy associated with the specific property id

POST
17.0/app/tenancy/maxdeposit

No description available.

GET
17.0/app/tenancy/offer/{contactid}/contact

Retrieves a pre-tenancy offer item by contact ID.

GET
17.0/app/tenancy/offer/{propertyid}/property

Retrieves a pre-tenancy offer item by property ID.

POST
17.0/app/tenancy/createpretenancy

Creates a pre-tenancy item based on the provided request details.

POST
17.0/app/tenancy/adjustenddate

Adjusts and calculates the end date based on the provided request details.

GET
17.0/app/tenancy/{receiptid}/receiptpdf

Generates and returns a PDF receipt report for the specified receipt ID.

GET
17.0/app/tenancy/{companyid}/company/{invoiceid}/invoicepdf

Generates and returns a PDF invoice report for the specified invoice and company.

GET
17.0/app/tenancy/{tenancyid}/permittedoccupiers

No description available.

POST
17.0/app/tenancy/{tenancyid}/permittedoccupiers

No description available.

GET
17.0/app/tenancy/{tenancyid}/depositpretenancy

Retrieves the pre-tenancy deposit amount for the specified tenancy.

POST
17.0/app/tenancy/cancelpretenancy

Cancels the pre-tenancy process for the specified tenancy.

POST
17.0/app/tenancy/dailyrentamount

Calculates the daily rent amount from the given rent amount and property price frequency.

GET
17.0/app/tenancy/{propertyid}/property/{contactid}/contact/existingprepayments

Retrieves the existing pre-payment (unallocated deposit balance) for the specified contact and property.

POST
17.0/app/tenancy/depositoverlegalmax

Checks whether a tenancy deposit exceeds the legally allowed maximum based on the provided tenancy and property details.

DELETE
17.0/app/tenancy/deletetenancy/{tenancyid}

This deletes the selected tenancy record and and associated transactions

API Description
POST
17.0/app/utilityswitching/switches/tenant

Creates a new Tenant Utility Switch

API Description
POST
17.0/app/user

Creates a new User record

POST
17.0/app/user/record/{id}

Edits an Existing User record

GET
17.0/app/user/record/{id}

Gets a specific User's details with the corresponding ID

POST
17.0/app/user/generateusername/{userid}

No description available.

API Description
GET
17.0/app/user/announcements/{userid}

Gets a list of announcements for the logged in user.

POST
17.0/app/user/announcements/{userid}

This handles the user's response to an announcement.

API Description
POST
17.0/app/user/{id}/signature

Sets the image to use as the user's signature

POST
17.0/app/user/{id}/photo

Sets the image to use as the user's photo

API Description
POST
17.0/app/user/{id}/invite

Sends a welcome email to a user

API Description
POST
17.0/app/user/list

Gets a list of Users

API Description
POST
17.0/app/user/changepassword

Change the logged in user's password

API Description
GET
17.0/app/user/permissions

Retrieve all user permissions

API Description
GET
17.0/app/utilityswitching/account

Retrieves the account info for the utility switching integration

API Description
GET
17.0/app/utilityswitching/agents/list

Gets a list of utility switching agents

API Description
POST
17.0/app/workorders/{id}/createpdf

Create work order pdf file

GET
17.0/app/workorders/{id}/createquotepdf

Create work order quote pdf file

GET
17.0/app/workorders/{id}/pictures/{pictureid}

Get work order picture

POST
17.0/app/workorders/{id}/pictures

Adds a picture to the specified work order

DELETE
17.0/app/workorders/{id}/pictures/{picturenumber}

Deletes the specified picture from the specified work order

POST
17.0/app/workorders/{id}/pictures/rearrange

Moves a Work Order picture from its current location to a new location

GET
17.0/app/workorders/{propertyid}/accountbalance

Get account balance for specific property

GET
17.0/app/workorders/{id}/contacts

Gets contacts associated with a work order by its ID.

API Description
POST
17.0/auth/databasetoken

Logs in to an Acquaint database as the System User

API Description
POST
17.0/database/additionalclauses/list

Retrieve a list of Additional Clauses

GET
17.0/database/additionalclauses/{id}

Retrieve Additional Clauses

GET
17.0/database/additionalclauses/defaultmodel

Get a $Additional Clauses model with default values

POST
17.0/database/additionalclauses

Create Additional Clauses

PUT
17.0/database/additionalclauses/{id}

Update existing Additional Clauses

DELETE
17.0/database/additionalclauses/{id}

Delete Additional Clauses

POST
17.0/database/additionalclauses/{id}/lock

Lock/Unlock existing Additional Clauses

API Description
POST
17.0/database/appointmentnotifications/list

Retrieve a list of Appointment Notifications

GET
17.0/database/appointmentnotifications/{appointmentid}/{contactid}

Retrieve Appointment Notifications

GET
17.0/database/appointmentnotifications/defaultmodel

Get a $Appointment Notifications model with default values

POST
17.0/database/appointmentnotifications

Create Appointment Notifications

PUT
17.0/database/appointmentnotifications/{appointmentid}/{contactid}

Update existing Appointment Notifications

DELETE
17.0/database/appointmentnotifications/{appointmentid}/{contactid}

Delete Appointment Notifications

POST
17.0/database/appointmentnotifications/{appointmentid}/{contactid}/lock

Lock/Unlock existing Appointment Notifications

API Description
POST
17.0/database/appointments/list

Retrieve a list of Appointments

GET
17.0/database/appointments/{id}

Retrieve Appointments

GET
17.0/database/appointments/defaultmodel

Get a $Appointments model with default values

POST
17.0/database/appointments

Create Appointments

PUT
17.0/database/appointments/{id}

Update existing Appointments

DELETE
17.0/database/appointments/{id}

Delete Appointments

POST
17.0/database/appointments/{id}/lock

Lock/Unlock existing Appointments

API Description
POST
17.0/database/appointmenttypes/list

Retrieve a list of Appointment Types

GET
17.0/database/appointmenttypes/{id}

Retrieve Appointment Types

GET
17.0/database/appointmenttypes/defaultmodel

Get a $Appointment Types model with default values

POST
17.0/database/appointmenttypes

Create Appointment Types

PUT
17.0/database/appointmenttypes/{id}

Update existing Appointment Types

DELETE
17.0/database/appointmenttypes/{id}

Delete Appointment Types

POST
17.0/database/appointmenttypes/{id}/lock

Lock/Unlock existing Appointment Types

API Description
POST
17.0/database/backupscheduledirectories/list

Retrieve a list of Backup Schedule Directories

GET
17.0/database/backupscheduledirectories/{backupid}/{item}

Retrieve Backup Schedule Directories

GET
17.0/database/backupscheduledirectories/defaultmodel

Get a $Backup Schedule Directories model with default values

POST
17.0/database/backupscheduledirectories

Create Backup Schedule Directories

PUT
17.0/database/backupscheduledirectories/{backupid}/{item}

Update existing Backup Schedule Directories

DELETE
17.0/database/backupscheduledirectories/{backupid}/{item}

Delete Backup Schedule Directories

POST
17.0/database/backupscheduledirectories/{backupid}/{item}/lock

Lock/Unlock existing Backup Schedule Directories

API Description
POST
17.0/database/backupschedules/list

Retrieve a list of Backup Schedules

GET
17.0/database/backupschedules/{id}

Retrieve Backup Schedules

GET
17.0/database/backupschedules/defaultmodel

Get a $Backup Schedules model with default values

POST
17.0/database/backupschedules

Create Backup Schedules

PUT
17.0/database/backupschedules/{id}

Update existing Backup Schedules

DELETE
17.0/database/backupschedules/{id}

Delete Backup Schedules

POST
17.0/database/backupschedules/{id}/lock

Lock/Unlock existing Backup Schedules

API Description
POST
17.0/database/bankaccountbalances/list

Retrieve a list of Bank Account Balances

GET
17.0/database/bankaccountbalances/{id}

Retrieve Bank Account Balances

GET
17.0/database/bankaccountbalances/defaultmodel

Get a $Bank Account Balances model with default values

POST
17.0/database/bankaccountbalances

Create Bank Account Balances

PUT
17.0/database/bankaccountbalances/{id}

Update existing Bank Account Balances

DELETE
17.0/database/bankaccountbalances/{id}

Delete Bank Account Balances

POST
17.0/database/bankaccountbalances/{id}/lock

Lock/Unlock existing Bank Account Balances

API Description
POST
17.0/database/bankaccounts/list

Retrieve a list of Bank Accounts

GET
17.0/database/bankaccounts/{id}

Retrieve Bank Accounts

GET
17.0/database/bankaccounts/defaultmodel

Get a $Bank Accounts model with default values

POST
17.0/database/bankaccounts

Create Bank Accounts

PUT
17.0/database/bankaccounts/{id}

Update existing Bank Accounts

DELETE
17.0/database/bankaccounts/{id}

Delete Bank Accounts

POST
17.0/database/bankaccounts/{id}/lock

Lock/Unlock existing Bank Accounts

API Description
POST
17.0/database/bankreconciliations/list

Retrieve a list of Bank Reconciliations

GET
17.0/database/bankreconciliations/{id}

Retrieve Bank Reconciliations

GET
17.0/database/bankreconciliations/defaultmodel

Get a $Bank Reconciliations model with default values

POST
17.0/database/bankreconciliations

Create Bank Reconciliations

PUT
17.0/database/bankreconciliations/{id}

Update existing Bank Reconciliations

DELETE
17.0/database/bankreconciliations/{id}

Delete Bank Reconciliations

POST
17.0/database/bankreconciliations/{id}/lock

Lock/Unlock existing Bank Reconciliations

API Description
POST
17.0/database/billitems/list

Retrieve a list of Bill Items

GET
17.0/database/billitems/{id}

Retrieve Bill Items

GET
17.0/database/billitems/defaultmodel

Get a $Bill Items model with default values

POST
17.0/database/billitems

Create Bill Items

PUT
17.0/database/billitems/{id}

Update existing Bill Items

DELETE
17.0/database/billitems/{id}

Delete Bill Items

POST
17.0/database/billitems/{id}/lock

Lock/Unlock existing Bill Items

API Description
POST
17.0/database/bills/list

Retrieve a list of Bills

GET
17.0/database/bills/{id}

Retrieve Bills

GET
17.0/database/bills/defaultmodel

Get a $Bills model with default values

POST
17.0/database/bills

Create Bills

PUT
17.0/database/bills/{id}

Update existing Bills

DELETE
17.0/database/bills/{id}

Delete Bills

POST
17.0/database/bills/{id}/lock

Lock/Unlock existing Bills

API Description
POST
17.0/database/bulletpointtemplates/list

Retrieve a list of Bullet Point Templates

GET
17.0/database/bulletpointtemplates/{id}

Retrieve Bullet Point Templates

GET
17.0/database/bulletpointtemplates/defaultmodel

Get a $Bullet Point Templates model with default values

POST
17.0/database/bulletpointtemplates

Create Bullet Point Templates

PUT
17.0/database/bulletpointtemplates/{id}

Update existing Bullet Point Templates

DELETE
17.0/database/bulletpointtemplates/{id}

Delete Bullet Point Templates

POST
17.0/database/bulletpointtemplates/{id}/lock

Lock/Unlock existing Bullet Point Templates

API Description
POST
17.0/database/certificates/list

Retrieve a list of Certificates

GET
17.0/database/certificates/{id}

Retrieve Certificates

GET
17.0/database/certificates/defaultmodel

Get a $Certificates model with default values

POST
17.0/database/certificates

Create Certificates

PUT
17.0/database/certificates/{id}

Update existing Certificates

DELETE
17.0/database/certificates/{id}

Delete Certificates

POST
17.0/database/certificates/{id}/lock

Lock/Unlock existing Certificates

API Description
POST
17.0/database/certificatetypes/list

Retrieve a list of Certificate Types

GET
17.0/database/certificatetypes/{id}

Retrieve Certificate Types

GET
17.0/database/certificatetypes/defaultmodel

Get a $Certificate Types model with default values

POST
17.0/database/certificatetypes

Create Certificate Types

PUT
17.0/database/certificatetypes/{id}

Update existing Certificate Types

DELETE
17.0/database/certificatetypes/{id}

Delete Certificate Types

POST
17.0/database/certificatetypes/{id}/lock

Lock/Unlock existing Certificate Types

API Description
POST
17.0/database/companyconfiguration/list

Retrieve a list of Company Configuration

GET
17.0/database/companyconfiguration/{id}/{companyid}

Retrieve Company Configuration

GET
17.0/database/companyconfiguration/defaultmodel

Get a $Company Configuration model with default values

POST
17.0/database/companyconfiguration

Create Company Configuration

PUT
17.0/database/companyconfiguration/{id}/{companyid}

Update existing Company Configuration

DELETE
17.0/database/companyconfiguration/{id}/{companyid}

Delete Company Configuration

POST
17.0/database/companyconfiguration/{id}/{companyid}/lock

Lock/Unlock existing Company Configuration

API Description
POST
17.0/database/contactbankdetails/list

Retrieve a list of Contact Bank Details

GET
17.0/database/contactbankdetails/{contactid}/{bankid}

Retrieve Contact Bank Details

GET
17.0/database/contactbankdetails/defaultmodel

Get a $Contact Bank Details model with default values

POST
17.0/database/contactbankdetails

Create Contact Bank Details

PUT
17.0/database/contactbankdetails/{contactid}/{bankid}

Update existing Contact Bank Details

DELETE
17.0/database/contactbankdetails/{contactid}/{bankid}

Delete Contact Bank Details

POST
17.0/database/contactbankdetails/{contactid}/{bankid}/lock

Lock/Unlock existing Contact Bank Details

API Description
POST
17.0/database/contactcalllog/list

Retrieve a list of Contact Call Log

GET
17.0/database/contactcalllog/{id}

Retrieve Contact Call Log

GET
17.0/database/contactcalllog/defaultmodel

Get a $Contact Call Log model with default values

POST
17.0/database/contactcalllog

Create Contact Call Log

PUT
17.0/database/contactcalllog/{id}

Update existing Contact Call Log

DELETE
17.0/database/contactcalllog/{id}

Delete Contact Call Log

POST
17.0/database/contactcalllog/{id}/lock

Lock/Unlock existing Contact Call Log

API Description
POST
17.0/database/contactdocuments/list

Retrieve a list of Contact Documents

GET
17.0/database/contactdocuments/{id}

Retrieve Contact Documents

GET
17.0/database/contactdocuments/defaultmodel

Get a $Contact Documents model with default values

POST
17.0/database/contactdocuments

Create Contact Documents

PUT
17.0/database/contactdocuments/{id}

Update existing Contact Documents

DELETE
17.0/database/contactdocuments/{id}

Delete Contact Documents

POST
17.0/database/contactdocuments/{id}/lock

Lock/Unlock existing Contact Documents

API Description
POST
17.0/database/contactemailattachments/list

Retrieve a list of Contact Email Attachments

GET
17.0/database/contactemailattachments/{id}

Retrieve Contact Email Attachments

GET
17.0/database/contactemailattachments/defaultmodel

Get a $Contact Email Attachments model with default values

POST
17.0/database/contactemailattachments

Create Contact Email Attachments

PUT
17.0/database/contactemailattachments/{id}

Update existing Contact Email Attachments

DELETE
17.0/database/contactemailattachments/{id}

Delete Contact Email Attachments

POST
17.0/database/contactemailattachments/{id}/lock

Lock/Unlock existing Contact Email Attachments

API Description
POST
17.0/database/contactemailengagements/list

Retrieve a list of Contact Email Engagements

GET
17.0/database/contactemailengagements/{contactemailid}/{addeddate}

Retrieve Contact Email Engagements

GET
17.0/database/contactemailengagements/defaultmodel

Get a $Contact Email Engagements model with default values

POST
17.0/database/contactemailengagements

Create Contact Email Engagements

PUT
17.0/database/contactemailengagements/{contactemailid}/{addeddate}

Update existing Contact Email Engagements

DELETE
17.0/database/contactemailengagements/{contactemailid}/{addeddate}

Delete Contact Email Engagements

POST
17.0/database/contactemailengagements/{contactemailid}/{addeddate}/lock

Lock/Unlock existing Contact Email Engagements

API Description
POST
17.0/database/contactemailerrors/list

Retrieve a list of Contact Email Errors

GET
17.0/database/contactemailerrors/{id}

Retrieve Contact Email Errors

GET
17.0/database/contactemailerrors/defaultmodel

Get a $Contact Email Errors model with default values

POST
17.0/database/contactemailerrors

Create Contact Email Errors

PUT
17.0/database/contactemailerrors/{id}

Update existing Contact Email Errors

DELETE
17.0/database/contactemailerrors/{id}

Delete Contact Email Errors

POST
17.0/database/contactemailerrors/{id}/lock

Lock/Unlock existing Contact Email Errors

API Description
POST
17.0/database/contactemails/list

Retrieve a list of Contact Emails

GET
17.0/database/contactemails/{id}

Retrieve Contact Emails

GET
17.0/database/contactemails/defaultmodel

Get a $Contact Emails model with default values

POST
17.0/database/contactemails

Create Contact Emails

PUT
17.0/database/contactemails/{id}

Update existing Contact Emails

DELETE
17.0/database/contactemails/{id}

Delete Contact Emails

POST
17.0/database/contactemails/{id}/lock

Lock/Unlock existing Contact Emails

API Description
POST
17.0/database/contactpropertyfeatures/list

Retrieve a list of Contact Property Features

GET
17.0/database/contactpropertyfeatures/{contactid}/{featureid}/{type}

Retrieve Contact Property Features

GET
17.0/database/contactpropertyfeatures/defaultmodel

Get a $Contact Property Features model with default values

POST
17.0/database/contactpropertyfeatures

Create Contact Property Features

PUT
17.0/database/contactpropertyfeatures/{contactid}/{featureid}/{type}

Update existing Contact Property Features

DELETE
17.0/database/contactpropertyfeatures/{contactid}/{featureid}/{type}

Delete Contact Property Features

POST
17.0/database/contactpropertyfeatures/{contactid}/{featureid}/{type}/lock

Lock/Unlock existing Contact Property Features

API Description
POST
17.0/database/contactpropertyrequirements/list

Retrieve a list of Contact Property Requirements

GET
17.0/database/contactpropertyrequirements/{contactid}

Retrieve Contact Property Requirements

GET
17.0/database/contactpropertyrequirements/defaultmodel

Get a $Contact Property Requirements model with default values

POST
17.0/database/contactpropertyrequirements

Create Contact Property Requirements

PUT
17.0/database/contactpropertyrequirements/{contactid}

Update existing Contact Property Requirements

DELETE
17.0/database/contactpropertyrequirements/{contactid}

Delete Contact Property Requirements

POST
17.0/database/contactpropertyrequirements/{contactid}/lock

Lock/Unlock existing Contact Property Requirements

API Description
POST
17.0/database/contactpropertytenures/list

Retrieve a list of Contact Property Tenures

GET
17.0/database/contactpropertytenures/{contactid}/{tenureid}

Retrieve Contact Property Tenures

GET
17.0/database/contactpropertytenures/defaultmodel

Get a $Contact Property Tenures model with default values

POST
17.0/database/contactpropertytenures

Create Contact Property Tenures

PUT
17.0/database/contactpropertytenures/{contactid}/{tenureid}

Update existing Contact Property Tenures

DELETE
17.0/database/contactpropertytenures/{contactid}/{tenureid}

Delete Contact Property Tenures

POST
17.0/database/contactpropertytenures/{contactid}/{tenureid}/lock

Lock/Unlock existing Contact Property Tenures

API Description
POST
17.0/database/contactreferences/list

Retrieve a list of Contact References

GET
17.0/database/contactreferences/{id}

Retrieve Contact References

GET
17.0/database/contactreferences/defaultmodel

Get a $Contact References model with default values

POST
17.0/database/contactreferences

Create Contact References

PUT
17.0/database/contactreferences/{id}

Update existing Contact References

DELETE
17.0/database/contactreferences/{id}

Delete Contact References

POST
17.0/database/contactreferences/{id}/lock

Lock/Unlock existing Contact References

API Description
POST
17.0/database/contacts/list

Retrieve a list of Contacts

GET
17.0/database/contacts/{id}

Retrieve Contacts

GET
17.0/database/contacts/defaultmodel

Get a $Contacts model with default values

POST
17.0/database/contacts

Create Contacts

PUT
17.0/database/contacts/{id}

Update existing Contacts

DELETE
17.0/database/contacts/{id}

Delete Contacts

POST
17.0/database/contacts/{id}/lock

Lock/Unlock existing Contacts

API Description
POST
17.0/database/contactsmstexts/list

Retrieve a list of Contact SMS Texts

GET
17.0/database/contactsmstexts/{id}

Retrieve Contact SMS Texts

GET
17.0/database/contactsmstexts/defaultmodel

Get a $Contact SMS Texts model with default values

POST
17.0/database/contactsmstexts

Create Contact SMS Texts

PUT
17.0/database/contactsmstexts/{id}

Update existing Contact SMS Texts

DELETE
17.0/database/contactsmstexts/{id}

Delete Contact SMS Texts

POST
17.0/database/contactsmstexts/{id}/lock

Lock/Unlock existing Contact SMS Texts

API Description
POST
17.0/database/contacttasks/list

Retrieve a list of Contact Tasks

GET
17.0/database/contacttasks/{id}

Retrieve Contact Tasks

GET
17.0/database/contacttasks/defaultmodel

Get a $Contact Tasks model with default values

POST
17.0/database/contacttasks

Create Contact Tasks

PUT
17.0/database/contacttasks/{id}

Update existing Contact Tasks

DELETE
17.0/database/contacttasks/{id}

Delete Contact Tasks

POST
17.0/database/contacttasks/{id}/lock

Lock/Unlock existing Contact Tasks

API Description
POST
17.0/database/costcentres/list

Retrieve a list of Cost Centres

GET
17.0/database/costcentres/{id}

Retrieve Cost Centres

GET
17.0/database/costcentres/defaultmodel

Get a $Cost Centres model with default values

POST
17.0/database/costcentres

Create Cost Centres

PUT
17.0/database/costcentres/{id}

Update existing Cost Centres

DELETE
17.0/database/costcentres/{id}

Delete Cost Centres

POST
17.0/database/costcentres/{id}/lock

Lock/Unlock existing Cost Centres

API Description
POST
17.0/database/custodialschemedepositrequests/list

Retrieve a list of Custodial Scheme Deposit Requests

GET
17.0/database/custodialschemedepositrequests/{id}

Retrieve Custodial Scheme Deposit Requests

GET
17.0/database/custodialschemedepositrequests/defaultmodel

Get a $Custodial Scheme Deposit Requests model with default values

POST
17.0/database/custodialschemedepositrequests

Create Custodial Scheme Deposit Requests

PUT
17.0/database/custodialschemedepositrequests/{id}

Update existing Custodial Scheme Deposit Requests

DELETE
17.0/database/custodialschemedepositrequests/{id}

Delete Custodial Scheme Deposit Requests

POST
17.0/database/custodialschemedepositrequests/{id}/lock

Lock/Unlock existing Custodial Scheme Deposit Requests

API Description
POST
17.0/database/definablefieldgroups/list

Retrieve a list of Definable Field Groups

GET
17.0/database/definablefieldgroups/{id}

Retrieve Definable Field Groups

GET
17.0/database/definablefieldgroups/defaultmodel

Get a $Definable Field Groups model with default values

POST
17.0/database/definablefieldgroups

Create Definable Field Groups

PUT
17.0/database/definablefieldgroups/{id}

Update existing Definable Field Groups

DELETE
17.0/database/definablefieldgroups/{id}

Delete Definable Field Groups

POST
17.0/database/definablefieldgroups/{id}/lock

Lock/Unlock existing Definable Field Groups

API Description
POST
17.0/database/definablefieldgrouptypes/list

Retrieve a list of Definable Field Group Types

GET
17.0/database/definablefieldgrouptypes/{definablefieldgroupid}/{typeid}

Retrieve Definable Field Group Types

GET
17.0/database/definablefieldgrouptypes/defaultmodel

Get a $Definable Field Group Types model with default values

POST
17.0/database/definablefieldgrouptypes

Create Definable Field Group Types

PUT
17.0/database/definablefieldgrouptypes/{definablefieldgroupid}/{typeid}

Update existing Definable Field Group Types

DELETE
17.0/database/definablefieldgrouptypes/{definablefieldgroupid}/{typeid}

Delete Definable Field Group Types

POST
17.0/database/definablefieldgrouptypes/{definablefieldgroupid}/{typeid}/lock

Lock/Unlock existing Definable Field Group Types

API Description
POST
17.0/database/definablefieldoptions/list

Retrieve a list of Definable Field Options

GET
17.0/database/definablefieldoptions/{definablefieldid}/{item}

Retrieve Definable Field Options

GET
17.0/database/definablefieldoptions/defaultmodel

Get a $Definable Field Options model with default values

POST
17.0/database/definablefieldoptions

Create Definable Field Options

PUT
17.0/database/definablefieldoptions/{definablefieldid}/{item}

Update existing Definable Field Options

DELETE
17.0/database/definablefieldoptions/{definablefieldid}/{item}

Delete Definable Field Options

POST
17.0/database/definablefieldoptions/{definablefieldid}/{item}/lock

Lock/Unlock existing Definable Field Options

API Description
POST
17.0/database/definablefields/list

Retrieve a list of Definable Fields

GET
17.0/database/definablefields/{id}

Retrieve Definable Fields

GET
17.0/database/definablefields/defaultmodel

Get a $Definable Fields model with default values

POST
17.0/database/definablefields

Create Definable Fields

PUT
17.0/database/definablefields/{id}

Update existing Definable Fields

DELETE
17.0/database/definablefields/{id}

Delete Definable Fields

POST
17.0/database/definablefields/{id}/lock

Lock/Unlock existing Definable Fields

API Description
POST
17.0/database/disinstructiontypes/list

Retrieve a list of Disinstruction Types

GET
17.0/database/disinstructiontypes/{id}

Retrieve Disinstruction Types

GET
17.0/database/disinstructiontypes/defaultmodel

Get a $Disinstruction Types model with default values

POST
17.0/database/disinstructiontypes

Create Disinstruction Types

PUT
17.0/database/disinstructiontypes/{id}

Update existing Disinstruction Types

DELETE
17.0/database/disinstructiontypes/{id}

Delete Disinstruction Types

POST
17.0/database/disinstructiontypes/{id}/lock

Lock/Unlock existing Disinstruction Types

API Description
POST
17.0/database/documents/list

Retrieve a list of Documents

GET
17.0/database/documents/{id}

Retrieve Documents

GET
17.0/database/documents/defaultmodel

Get a $Documents model with default values

POST
17.0/database/documents

Create Documents

PUT
17.0/database/documents/{id}

Update existing Documents

DELETE
17.0/database/documents/{id}

Delete Documents

POST
17.0/database/documents/{id}/lock

Lock/Unlock existing Documents

API Description
POST
17.0/database/emailattachments/list

Retrieve a list of Email Attachments

GET
17.0/database/emailattachments/{id}

Retrieve Email Attachments

GET
17.0/database/emailattachments/defaultmodel

Get a $Email Attachments model with default values

POST
17.0/database/emailattachments

Create Email Attachments

PUT
17.0/database/emailattachments/{id}

Update existing Email Attachments

DELETE
17.0/database/emailattachments/{id}

Delete Email Attachments

POST
17.0/database/emailattachments/{id}/lock

Lock/Unlock existing Email Attachments

API Description
POST
17.0/database/emailnewsletteritems/list

Retrieve a list of Email Newsletter Items

GET
17.0/database/emailnewsletteritems/{emailid}/{newsid}

Retrieve Email Newsletter Items

GET
17.0/database/emailnewsletteritems/defaultmodel

Get a $Email Newsletter Items model with default values

POST
17.0/database/emailnewsletteritems

Create Email Newsletter Items

PUT
17.0/database/emailnewsletteritems/{emailid}/{newsid}

Update existing Email Newsletter Items

DELETE
17.0/database/emailnewsletteritems/{emailid}/{newsid}

Delete Email Newsletter Items

POST
17.0/database/emailnewsletteritems/{emailid}/{newsid}/lock

Lock/Unlock existing Email Newsletter Items

API Description
POST
17.0/database/emails/list

Retrieve a list of Emails

GET
17.0/database/emails/{id}

Retrieve Emails

GET
17.0/database/emails/defaultmodel

Get a $Emails model with default values

POST
17.0/database/emails

Create Emails

PUT
17.0/database/emails/{id}

Update existing Emails

DELETE
17.0/database/emails/{id}

Delete Emails

POST
17.0/database/emails/{id}/lock

Lock/Unlock existing Emails

API Description
POST
17.0/database/emailsettings/list

Retrieve a list of Email Settings

GET
17.0/database/emailsettings/{id}

Retrieve Email Settings

GET
17.0/database/emailsettings/defaultmodel

Get a $Email Settings model with default values

POST
17.0/database/emailsettings

Create Email Settings

PUT
17.0/database/emailsettings/{id}

Update existing Email Settings

DELETE
17.0/database/emailsettings/{id}

Delete Email Settings

POST
17.0/database/emailsettings/{id}/lock

Lock/Unlock existing Email Settings

API Description
POST
17.0/database/emailsignatures/list

Retrieve a list of Email Signatures

GET
17.0/database/emailsignatures/{id}

Retrieve Email Signatures

GET
17.0/database/emailsignatures/defaultmodel

Get a $Email Signatures model with default values

POST
17.0/database/emailsignatures

Create Email Signatures

PUT
17.0/database/emailsignatures/{id}

Update existing Email Signatures

DELETE
17.0/database/emailsignatures/{id}

Delete Email Signatures

POST
17.0/database/emailsignatures/{id}/lock

Lock/Unlock existing Email Signatures

API Description
POST
17.0/database/eventlog/list

Retrieve a list of Event Log

GET
17.0/database/eventlog/{id}

Retrieve Event Log

GET
17.0/database/eventlog/defaultmodel

Get a $Event Log model with default values

POST
17.0/database/eventlog

Create Event Log

PUT
17.0/database/eventlog/{id}

Update existing Event Log

DELETE
17.0/database/eventlog/{id}

Delete Event Log

POST
17.0/database/eventlog/{id}/lock

Lock/Unlock existing Event Log

API Description
POST
17.0/database/filetransfers/list

Retrieve a list of File Transfers

GET
17.0/database/filetransfers/{id}

Retrieve File Transfers

GET
17.0/database/filetransfers/defaultmodel

Get a $File Transfers model with default values

POST
17.0/database/filetransfers

Create File Transfers

PUT
17.0/database/filetransfers/{id}

Update existing File Transfers

DELETE
17.0/database/filetransfers/{id}

Delete File Transfers

POST
17.0/database/filetransfers/{id}/lock

Lock/Unlock existing File Transfers

API Description
POST
17.0/database/homepagecharts/list

Retrieve a list of Home Page Charts

GET
17.0/database/homepagecharts/{id}/{siteid}

Retrieve Home Page Charts

GET
17.0/database/homepagecharts/defaultmodel

Get a $Home Page Charts model with default values

POST
17.0/database/homepagecharts

Create Home Page Charts

PUT
17.0/database/homepagecharts/{id}/{siteid}

Update existing Home Page Charts

DELETE
17.0/database/homepagecharts/{id}/{siteid}

Delete Home Page Charts

POST
17.0/database/homepagecharts/{id}/{siteid}/lock

Lock/Unlock existing Home Page Charts

API Description
POST
17.0/database/journal/list

Retrieve a list of Journal

GET
17.0/database/journal/{id}

Retrieve Journal

GET
17.0/database/journal/defaultmodel

Get a $Journal model with default values

POST
17.0/database/journal

Create Journal

PUT
17.0/database/journal/{id}

Update existing Journal

DELETE
17.0/database/journal/{id}

Delete Journal

POST
17.0/database/journal/{id}/lock

Lock/Unlock existing Journal

API Description
POST
17.0/database/keyhistory/list

Retrieve a list of Key History

GET
17.0/database/keyhistory/{id}

Retrieve Key History

GET
17.0/database/keyhistory/defaultmodel

Get a $Key History model with default values

POST
17.0/database/keyhistory

Create Key History

PUT
17.0/database/keyhistory/{id}

Update existing Key History

DELETE
17.0/database/keyhistory/{id}

Delete Key History

POST
17.0/database/keyhistory/{id}/lock

Lock/Unlock existing Key History

API Description
POST
17.0/database/keys/list

Retrieve a list of Keys

GET
17.0/database/keys/{id}

Retrieve Keys

GET
17.0/database/keys/defaultmodel

Get a $Keys model with default values

POST
17.0/database/keys

Create Keys

PUT
17.0/database/keys/{id}

Update existing Keys

DELETE
17.0/database/keys/{id}

Delete Keys

POST
17.0/database/keys/{id}/lock

Lock/Unlock existing Keys

API Description
POST
17.0/database/letterheads/list

Retrieve a list of Letter Heads

GET
17.0/database/letterheads/{id}

Retrieve Letter Heads

GET
17.0/database/letterheads/defaultmodel

Get a $Letter Heads model with default values

POST
17.0/database/letterheads

Create Letter Heads

PUT
17.0/database/letterheads/{id}

Update existing Letter Heads

DELETE
17.0/database/letterheads/{id}

Delete Letter Heads

POST
17.0/database/letterheads/{id}/lock

Lock/Unlock existing Letter Heads

API Description
POST
17.0/database/mailshotgroups/list

Retrieve a list of Mailshot Groups

GET
17.0/database/mailshotgroups/{id}

Retrieve Mailshot Groups

GET
17.0/database/mailshotgroups/defaultmodel

Get a $Mailshot Groups model with default values

POST
17.0/database/mailshotgroups

Create Mailshot Groups

PUT
17.0/database/mailshotgroups/{id}

Update existing Mailshot Groups

DELETE
17.0/database/mailshotgroups/{id}

Delete Mailshot Groups

POST
17.0/database/mailshotgroups/{id}/lock

Lock/Unlock existing Mailshot Groups

API Description
POST
17.0/database/maintenancerequests/list

Retrieve a list of Maintenance Requests

GET
17.0/database/maintenancerequests/{id}

Retrieve Maintenance Requests

GET
17.0/database/maintenancerequests/defaultmodel

Get a $Maintenance Requests model with default values

POST
17.0/database/maintenancerequests

Create Maintenance Requests

PUT
17.0/database/maintenancerequests/{id}

Update existing Maintenance Requests

DELETE
17.0/database/maintenancerequests/{id}

Delete Maintenance Requests

POST
17.0/database/maintenancerequests/{id}/lock

Lock/Unlock existing Maintenance Requests

API Description
POST
17.0/database/managementtypes/list

Retrieve a list of Management Types

GET
17.0/database/managementtypes/{id}

Retrieve Management Types

GET
17.0/database/managementtypes/defaultmodel

Get a $Management Types model with default values

POST
17.0/database/managementtypes

Create Management Types

PUT
17.0/database/managementtypes/{id}

Update existing Management Types

DELETE
17.0/database/managementtypes/{id}

Delete Management Types

POST
17.0/database/managementtypes/{id}/lock

Lock/Unlock existing Management Types

API Description
POST
17.0/database/marketingemailitems/list

Retrieve a list of Marketing Email Items

GET
17.0/database/marketingemailitems/{id}

Retrieve Marketing Email Items

GET
17.0/database/marketingemailitems/defaultmodel

Get a $Marketing Email Items model with default values

POST
17.0/database/marketingemailitems

Create Marketing Email Items

PUT
17.0/database/marketingemailitems/{id}

Update existing Marketing Email Items

DELETE
17.0/database/marketingemailitems/{id}

Delete Marketing Email Items

POST
17.0/database/marketingemailitems/{id}/lock

Lock/Unlock existing Marketing Email Items

API Description
POST
17.0/database/messages/list

Retrieve a list of Messages

GET
17.0/database/messages/{id}

Retrieve Messages

GET
17.0/database/messages/defaultmodel

Get a $Messages model with default values

POST
17.0/database/messages

Create Messages

PUT
17.0/database/messages/{id}

Update existing Messages

DELETE
17.0/database/messages/{id}

Delete Messages

POST
17.0/database/messages/{id}/lock

Lock/Unlock existing Messages

API Description
POST
17.0/database/news/list

Retrieve a list of News

GET
17.0/database/news/{id}

Retrieve News

GET
17.0/database/news/defaultmodel

Get a $News model with default values

POST
17.0/database/news

Create News

PUT
17.0/database/news/{id}

Update existing News

DELETE
17.0/database/news/{id}

Delete News

POST
17.0/database/news/{id}/lock

Lock/Unlock existing News

API Description
POST
17.0/database/paymentcollections/list

Retrieve a list of Payment Collections

GET
17.0/database/paymentcollections/{id}

Retrieve Payment Collections

GET
17.0/database/paymentcollections/defaultmodel

Get a $Payment Collections model with default values

POST
17.0/database/paymentcollections

Create Payment Collections

PUT
17.0/database/paymentcollections/{id}

Update existing Payment Collections

DELETE
17.0/database/paymentcollections/{id}

Delete Payment Collections

POST
17.0/database/paymentcollections/{id}/lock

Lock/Unlock existing Payment Collections

API Description
POST
17.0/database/paymentmethods/list

Retrieve a list of Payment Methods

GET
17.0/database/paymentmethods/{id}

Retrieve Payment Methods

GET
17.0/database/paymentmethods/defaultmodel

Get a $Payment Methods model with default values

POST
17.0/database/paymentmethods

Create Payment Methods

PUT
17.0/database/paymentmethods/{id}

Update existing Payment Methods

DELETE
17.0/database/paymentmethods/{id}

Delete Payment Methods

POST
17.0/database/paymentmethods/{id}/lock

Lock/Unlock existing Payment Methods

API Description
POST
17.0/database/paymentruns/list

Retrieve a list of Payment Runs

GET
17.0/database/paymentruns/{id}

Retrieve Payment Runs

GET
17.0/database/paymentruns/defaultmodel

Get a $Payment Runs model with default values

POST
17.0/database/paymentruns

Create Payment Runs

PUT
17.0/database/paymentruns/{id}

Update existing Payment Runs

DELETE
17.0/database/paymentruns/{id}

Delete Payment Runs

POST
17.0/database/paymentruns/{id}/lock

Lock/Unlock existing Payment Runs

API Description
POST
17.0/database/pc/list

Retrieve a list of PC

GET
17.0/database/pc/{id}

Retrieve PC

GET
17.0/database/pc/defaultmodel

Get a $PC model with default values

POST
17.0/database/pc

Create PC

PUT
17.0/database/pc/{id}

Update existing PC

DELETE
17.0/database/pc/{id}

Delete PC

POST
17.0/database/pc/{id}/lock

Lock/Unlock existing PC

API Description
POST
17.0/database/products/list

Retrieve a list of Products

GET
17.0/database/products/{id}

Retrieve Products

GET
17.0/database/products/defaultmodel

Get a $Products model with default values

POST
17.0/database/products

Create Products

PUT
17.0/database/products/{id}

Update existing Products

DELETE
17.0/database/products/{id}

Delete Products

POST
17.0/database/products/{id}/lock

Lock/Unlock existing Products

API Description
POST
17.0/database/professions/list

Retrieve a list of Professions

GET
17.0/database/professions/{id}

Retrieve Professions

GET
17.0/database/professions/defaultmodel

Get a $Professions model with default values

POST
17.0/database/professions

Create Professions

PUT
17.0/database/professions/{id}

Update existing Professions

DELETE
17.0/database/professions/{id}

Delete Professions

POST
17.0/database/professions/{id}/lock

Lock/Unlock existing Professions

API Description
POST
17.0/database/properties/list

Retrieve a list of Properties

GET
17.0/database/properties/{id}

Retrieve Properties

GET
17.0/database/properties/defaultmodel

Get a $Properties model with default values

POST
17.0/database/properties

Create Properties

PUT
17.0/database/properties/{id}

Update existing Properties

DELETE
17.0/database/properties/{id}

Delete Properties

POST
17.0/database/properties/{id}/lock

Lock/Unlock existing Properties

API Description
POST
17.0/database/propertyareas/list

Retrieve a list of Property Areas

GET
17.0/database/propertyareas/{id}

Retrieve Property Areas

GET
17.0/database/propertyareas/defaultmodel

Get a $Property Areas model with default values

POST
17.0/database/propertyareas

Create Property Areas

PUT
17.0/database/propertyareas/{id}

Update existing Property Areas

DELETE
17.0/database/propertyareas/{id}

Delete Property Areas

POST
17.0/database/propertyareas/{id}/lock

Lock/Unlock existing Property Areas

API Description
POST
17.0/database/propertybuyingposition/list

Retrieve a list of Property Buying Position

GET
17.0/database/propertybuyingposition/{id}

Retrieve Property Buying Position

GET
17.0/database/propertybuyingposition/defaultmodel

Get a $Property Buying Position model with default values

POST
17.0/database/propertybuyingposition

Create Property Buying Position

PUT
17.0/database/propertybuyingposition/{id}

Update existing Property Buying Position

DELETE
17.0/database/propertybuyingposition/{id}

Delete Property Buying Position

POST
17.0/database/propertybuyingposition/{id}/lock

Lock/Unlock existing Property Buying Position

API Description
POST
17.0/database/propertychain/list

Retrieve a list of Property Chain

GET
17.0/database/propertychain/{id}

Retrieve Property Chain

GET
17.0/database/propertychain/defaultmodel

Get a $Property Chain model with default values

POST
17.0/database/propertychain

Create Property Chain

PUT
17.0/database/propertychain/{id}

Update existing Property Chain

DELETE
17.0/database/propertychain/{id}

Delete Property Chain

POST
17.0/database/propertychain/{id}/lock

Lock/Unlock existing Property Chain

API Description
POST
17.0/database/propertychainitems/list

Retrieve a list of Property Chain Items

GET
17.0/database/propertychainitems/{id}

Retrieve Property Chain Items

GET
17.0/database/propertychainitems/defaultmodel

Get a $Property Chain Items model with default values

POST
17.0/database/propertychainitems

Create Property Chain Items

PUT
17.0/database/propertychainitems/{id}

Update existing Property Chain Items

DELETE
17.0/database/propertychainitems/{id}

Delete Property Chain Items

POST
17.0/database/propertychainitems/{id}/lock

Lock/Unlock existing Property Chain Items

API Description
POST
17.0/database/propertychainstatuses/list

Retrieve a list of Property Chain Statuses

GET
17.0/database/propertychainstatuses/{id}

Retrieve Property Chain Statuses

GET
17.0/database/propertychainstatuses/defaultmodel

Get a $Property Chain Statuses model with default values

POST
17.0/database/propertychainstatuses

Create Property Chain Statuses

PUT
17.0/database/propertychainstatuses/{id}

Update existing Property Chain Statuses

DELETE
17.0/database/propertychainstatuses/{id}

Delete Property Chain Statuses

POST
17.0/database/propertychainstatuses/{id}/lock

Lock/Unlock existing Property Chain Statuses

API Description
POST
17.0/database/propertydetailssent/list

Retrieve a list of Property Details Sent

GET
17.0/database/propertydetailssent/{contactid}/{propertyid}

Retrieve Property Details Sent

GET
17.0/database/propertydetailssent/defaultmodel

Get a $Property Details Sent model with default values

POST
17.0/database/propertydetailssent

Create Property Details Sent

PUT
17.0/database/propertydetailssent/{contactid}/{propertyid}

Update existing Property Details Sent

DELETE
17.0/database/propertydetailssent/{contactid}/{propertyid}

Delete Property Details Sent

POST
17.0/database/propertydetailssent/{contactid}/{propertyid}/lock

Lock/Unlock existing Property Details Sent

API Description
POST
17.0/database/propertydevelopments/list

Retrieve a list of Property Developments

GET
17.0/database/propertydevelopments/{id}

Retrieve Property Developments

GET
17.0/database/propertydevelopments/defaultmodel

Get a $Property Developments model with default values

POST
17.0/database/propertydevelopments

Create Property Developments

PUT
17.0/database/propertydevelopments/{id}

Update existing Property Developments

DELETE
17.0/database/propertydevelopments/{id}

Delete Property Developments

POST
17.0/database/propertydevelopments/{id}/lock

Lock/Unlock existing Property Developments

API Description
POST
17.0/database/propertylandlordsplits/list

Retrieve a list of Property Landlord Splits

GET
17.0/database/propertylandlordsplits/{propertyid}/{contactid}

Retrieve Property Landlord Splits

GET
17.0/database/propertylandlordsplits/defaultmodel

Get a $Property Landlord Splits model with default values

POST
17.0/database/propertylandlordsplits

Create Property Landlord Splits

PUT
17.0/database/propertylandlordsplits/{propertyid}/{contactid}

Update existing Property Landlord Splits

DELETE
17.0/database/propertylandlordsplits/{propertyid}/{contactid}

Delete Property Landlord Splits

POST
17.0/database/propertylandlordsplits/{propertyid}/{contactid}/lock

Lock/Unlock existing Property Landlord Splits

API Description
POST
17.0/database/propertylandusage/list

Retrieve a list of Property Land Usage

GET
17.0/database/propertylandusage/{id}

Retrieve Property Land Usage

GET
17.0/database/propertylandusage/defaultmodel

Get a $Property Land Usage model with default values

POST
17.0/database/propertylandusage

Create Property Land Usage

PUT
17.0/database/propertylandusage/{id}

Update existing Property Land Usage

DELETE
17.0/database/propertylandusage/{id}

Delete Property Land Usage

POST
17.0/database/propertylandusage/{id}/lock

Lock/Unlock existing Property Land Usage

API Description
POST
17.0/database/propertylisttemplates/list

Retrieve a list of Property List Templates

GET
17.0/database/propertylisttemplates/{id}

Retrieve Property List Templates

GET
17.0/database/propertylisttemplates/defaultmodel

Get a $Property List Templates model with default values

POST
17.0/database/propertylisttemplates

Create Property List Templates

PUT
17.0/database/propertylisttemplates/{id}

Update existing Property List Templates

DELETE
17.0/database/propertylisttemplates/{id}

Delete Property List Templates

POST
17.0/database/propertylisttemplates/{id}/lock

Lock/Unlock existing Property List Templates

API Description
POST
17.0/database/propertyoffers/list

Retrieve a list of Property Offers

GET
17.0/database/propertyoffers/{id}

Retrieve Property Offers

GET
17.0/database/propertyoffers/defaultmodel

Get a $Property Offers model with default values

POST
17.0/database/propertyoffers

Create Property Offers

PUT
17.0/database/propertyoffers/{id}

Update existing Property Offers

DELETE
17.0/database/propertyoffers/{id}

Delete Property Offers

POST
17.0/database/propertyoffers/{id}/lock

Lock/Unlock existing Property Offers

API Description
POST
17.0/database/propertyparticularstemplates/list

Retrieve a list of Property Particulars Templates

GET
17.0/database/propertyparticularstemplates/{id}

Retrieve Property Particulars Templates

GET
17.0/database/propertyparticularstemplates/defaultmodel

Get a $Property Particulars Templates model with default values

POST
17.0/database/propertyparticularstemplates

Create Property Particulars Templates

PUT
17.0/database/propertyparticularstemplates/{id}

Update existing Property Particulars Templates

DELETE
17.0/database/propertyparticularstemplates/{id}

Delete Property Particulars Templates

POST
17.0/database/propertyparticularstemplates/{id}/lock

Lock/Unlock existing Property Particulars Templates

API Description
POST
17.0/database/propertyportalexclusions/list

Retrieve a list of Property Portal Exclusions

GET
17.0/database/propertyportalexclusions/{propertyid}/{propertyportalid}

Retrieve Property Portal Exclusions

GET
17.0/database/propertyportalexclusions/defaultmodel

Get a $Property Portal Exclusions model with default values

POST
17.0/database/propertyportalexclusions

Create Property Portal Exclusions

PUT
17.0/database/propertyportalexclusions/{propertyid}/{propertyportalid}

Update existing Property Portal Exclusions

DELETE
17.0/database/propertyportalexclusions/{propertyid}/{propertyportalid}

Delete Property Portal Exclusions

POST
17.0/database/propertyportalexclusions/{propertyid}/{propertyportalid}/lock

Lock/Unlock existing Property Portal Exclusions

API Description
POST
17.0/database/propertypresentationitems/list

Retrieve a list of Property Presentation Items

GET
17.0/database/propertypresentationitems/{id}

Retrieve Property Presentation Items

GET
17.0/database/propertypresentationitems/defaultmodel

Get a $Property Presentation Items model with default values

POST
17.0/database/propertypresentationitems

Create Property Presentation Items

PUT
17.0/database/propertypresentationitems/{id}

Update existing Property Presentation Items

DELETE
17.0/database/propertypresentationitems/{id}

Delete Property Presentation Items

POST
17.0/database/propertypresentationitems/{id}/lock

Lock/Unlock existing Property Presentation Items

API Description
POST
17.0/database/propertypresentationitemsequence/list

Retrieve a list of Property Presentation Item Sequence

GET
17.0/database/propertypresentationitemsequence/{propertypresentationid}/{sequence}

Retrieve Property Presentation Item Sequence

GET
17.0/database/propertypresentationitemsequence/defaultmodel

Get a $Property Presentation Item Sequence model with default values

POST
17.0/database/propertypresentationitemsequence

Create Property Presentation Item Sequence

PUT
17.0/database/propertypresentationitemsequence/{propertypresentationid}/{sequence}

Update existing Property Presentation Item Sequence

DELETE
17.0/database/propertypresentationitemsequence/{propertypresentationid}/{sequence}

Delete Property Presentation Item Sequence

POST
17.0/database/propertypresentationitemsequence/{propertypresentationid}/{sequence}/lock

Lock/Unlock existing Property Presentation Item Sequence

API Description
POST
17.0/database/propertypresentations/list

Retrieve a list of Property Presentations

GET
17.0/database/propertypresentations/{id}

Retrieve Property Presentations

GET
17.0/database/propertypresentations/defaultmodel

Get a $Property Presentations model with default values

POST
17.0/database/propertypresentations

Create Property Presentations

PUT
17.0/database/propertypresentations/{id}

Update existing Property Presentations

DELETE
17.0/database/propertypresentations/{id}

Delete Property Presentations

POST
17.0/database/propertypresentations/{id}/lock

Lock/Unlock existing Property Presentations

API Description
POST
17.0/database/propertypublicationreferences/list

Retrieve a list of Property Publication References

GET
17.0/database/propertypublicationreferences/{propertyid}/{publicationid}

Retrieve Property Publication References

GET
17.0/database/propertypublicationreferences/defaultmodel

Get a $Property Publication References model with default values

POST
17.0/database/propertypublicationreferences

Create Property Publication References

PUT
17.0/database/propertypublicationreferences/{propertyid}/{publicationid}

Update existing Property Publication References

DELETE
17.0/database/propertypublicationreferences/{propertyid}/{publicationid}

Delete Property Publication References

POST
17.0/database/propertypublicationreferences/{propertyid}/{publicationid}/lock

Lock/Unlock existing Property Publication References

API Description
POST
17.0/database/propertyrooms/list

Retrieve a list of Property Rooms

GET
17.0/database/propertyrooms/{propertyid}/{id}

Retrieve Property Rooms

GET
17.0/database/propertyrooms/defaultmodel

Get a $Property Rooms model with default values

POST
17.0/database/propertyrooms

Create Property Rooms

PUT
17.0/database/propertyrooms/{propertyid}/{id}

Update existing Property Rooms

DELETE
17.0/database/propertyrooms/{propertyid}/{id}

Delete Property Rooms

POST
17.0/database/propertyrooms/{propertyid}/{id}/lock

Lock/Unlock existing Property Rooms

API Description
POST
17.0/database/propertyroomtemplates/list

Retrieve a list of Property Room Templates

GET
17.0/database/propertyroomtemplates/{id}

Retrieve Property Room Templates

GET
17.0/database/propertyroomtemplates/defaultmodel

Get a $Property Room Templates model with default values

POST
17.0/database/propertyroomtemplates

Create Property Room Templates

PUT
17.0/database/propertyroomtemplates/{id}

Update existing Property Room Templates

DELETE
17.0/database/propertyroomtemplates/{id}

Delete Property Room Templates

POST
17.0/database/propertyroomtemplates/{id}/lock

Lock/Unlock existing Property Room Templates

API Description
POST
17.0/database/propertytaxbands/list

Retrieve a list of Property Tax Bands

GET
17.0/database/propertytaxbands/{id}

Retrieve Property Tax Bands

GET
17.0/database/propertytaxbands/defaultmodel

Get a $Property Tax Bands model with default values

POST
17.0/database/propertytaxbands

Create Property Tax Bands

PUT
17.0/database/propertytaxbands/{id}

Update existing Property Tax Bands

DELETE
17.0/database/propertytaxbands/{id}

Delete Property Tax Bands

POST
17.0/database/propertytaxbands/{id}/lock

Lock/Unlock existing Property Tax Bands

API Description
POST
17.0/database/propertytypes/list

Retrieve a list of Property Types

GET
17.0/database/propertytypes/{id}

Retrieve Property Types

GET
17.0/database/propertytypes/defaultmodel

Get a $Property Types model with default values

POST
17.0/database/propertytypes

Create Property Types

PUT
17.0/database/propertytypes/{id}

Update existing Property Types

DELETE
17.0/database/propertytypes/{id}

Delete Property Types

POST
17.0/database/propertytypes/{id}/lock

Lock/Unlock existing Property Types

API Description
POST
17.0/database/propertywebviewings/list

Retrieve a list of Property Web Viewings

GET
17.0/database/propertywebviewings/{propertyid}/{viewdate}

Retrieve Property Web Viewings

GET
17.0/database/propertywebviewings/defaultmodel

Get a $Property Web Viewings model with default values

POST
17.0/database/propertywebviewings

Create Property Web Viewings

PUT
17.0/database/propertywebviewings/{propertyid}/{viewdate}

Update existing Property Web Viewings

DELETE
17.0/database/propertywebviewings/{propertyid}/{viewdate}

Delete Property Web Viewings

POST
17.0/database/propertywebviewings/{propertyid}/{viewdate}/lock

Lock/Unlock existing Property Web Viewings

API Description
POST
17.0/database/receipts/list

Retrieve a list of Receipts

GET
17.0/database/receipts/{id}

Retrieve Receipts

GET
17.0/database/receipts/defaultmodel

Get a $Receipts model with default values

POST
17.0/database/receipts

Create Receipts

PUT
17.0/database/receipts/{id}

Update existing Receipts

DELETE
17.0/database/receipts/{id}

Delete Receipts

POST
17.0/database/receipts/{id}/lock

Lock/Unlock existing Receipts

API Description
POST
17.0/database/recordupdatenotifications/list

Retrieve a list of Record Update Notifications

GET
17.0/database/recordupdatenotifications/{id}/{type}

Retrieve Record Update Notifications

GET
17.0/database/recordupdatenotifications/defaultmodel

Get a $Record Update Notifications model with default values

POST
17.0/database/recordupdatenotifications

Create Record Update Notifications

PUT
17.0/database/recordupdatenotifications/{id}/{type}

Update existing Record Update Notifications

DELETE
17.0/database/recordupdatenotifications/{id}/{type}

Delete Record Update Notifications

POST
17.0/database/recordupdatenotifications/{id}/{type}/lock

Lock/Unlock existing Record Update Notifications

API Description
POST
17.0/database/recurringfees/list

Retrieve a list of Recurring Fees

GET
17.0/database/recurringfees/{id}

Retrieve Recurring Fees

GET
17.0/database/recurringfees/defaultmodel

Get a $Recurring Fees model with default values

POST
17.0/database/recurringfees

Create Recurring Fees

PUT
17.0/database/recurringfees/{id}

Update existing Recurring Fees

DELETE
17.0/database/recurringfees/{id}

Delete Recurring Fees

POST
17.0/database/recurringfees/{id}/lock

Lock/Unlock existing Recurring Fees

API Description
POST
17.0/database/rentguarantees/list

Retrieve a list of Rent Guarantees

GET
17.0/database/rentguarantees/{id}

Retrieve Rent Guarantees

GET
17.0/database/rentguarantees/defaultmodel

Get a $Rent Guarantees model with default values

POST
17.0/database/rentguarantees

Create Rent Guarantees

PUT
17.0/database/rentguarantees/{id}

Update existing Rent Guarantees

DELETE
17.0/database/rentguarantees/{id}

Delete Rent Guarantees

POST
17.0/database/rentguarantees/{id}/lock

Lock/Unlock existing Rent Guarantees

API Description
POST
17.0/database/reportmacrofilters/list

Retrieve a list of Report Macro Filters

GET
17.0/database/reportmacrofilters/{reportmacroid}/{itemid}

Retrieve Report Macro Filters

GET
17.0/database/reportmacrofilters/defaultmodel

Get a $Report Macro Filters model with default values

POST
17.0/database/reportmacrofilters

Create Report Macro Filters

PUT
17.0/database/reportmacrofilters/{reportmacroid}/{itemid}

Update existing Report Macro Filters

DELETE
17.0/database/reportmacrofilters/{reportmacroid}/{itemid}

Delete Report Macro Filters

POST
17.0/database/reportmacrofilters/{reportmacroid}/{itemid}/lock

Lock/Unlock existing Report Macro Filters

API Description
POST
17.0/database/reportmacros/list

Retrieve a list of Report Macros

GET
17.0/database/reportmacros/{id}

Retrieve Report Macros

GET
17.0/database/reportmacros/defaultmodel

Get a $Report Macros model with default values

POST
17.0/database/reportmacros

Create Report Macros

PUT
17.0/database/reportmacros/{id}

Update existing Report Macros

DELETE
17.0/database/reportmacros/{id}

Delete Report Macros

POST
17.0/database/reportmacros/{id}/lock

Lock/Unlock existing Report Macros

API Description
POST
17.0/database/sites/list

Retrieve a list of Sites

GET
17.0/database/sites/{id}

Retrieve Sites

GET
17.0/database/sites/defaultmodel

Get a $Sites model with default values

POST
17.0/database/sites

Create Sites

PUT
17.0/database/sites/{id}

Update existing Sites

DELETE
17.0/database/sites/{id}

Delete Sites

POST
17.0/database/sites/{id}/lock

Lock/Unlock existing Sites

API Description
POST
17.0/database/smstexts/list

Retrieve a list of SMS Texts

GET
17.0/database/smstexts/{id}

Retrieve SMS Texts

GET
17.0/database/smstexts/defaultmodel

Get a $SMS Texts model with default values

POST
17.0/database/smstexts

Create SMS Texts

PUT
17.0/database/smstexts/{id}

Update existing SMS Texts

DELETE
17.0/database/smstexts/{id}

Delete SMS Texts

POST
17.0/database/smstexts/{id}/lock

Lock/Unlock existing SMS Texts

API Description
POST
17.0/database/sources/list

Retrieve a list of Sources

GET
17.0/database/sources/{id}

Retrieve Sources

GET
17.0/database/sources/defaultmodel

Get a $Sources model with default values

POST
17.0/database/sources

Create Sources

PUT
17.0/database/sources/{id}

Update existing Sources

DELETE
17.0/database/sources/{id}

Delete Sources

POST
17.0/database/sources/{id}/lock

Lock/Unlock existing Sources

API Description
POST
17.0/database/statements/list

Retrieve a list of Statements

GET
17.0/database/statements/{id}

Retrieve Statements

GET
17.0/database/statements/defaultmodel

Get a $Statements model with default values

POST
17.0/database/statements

Create Statements

PUT
17.0/database/statements/{id}

Update existing Statements

DELETE
17.0/database/statements/{id}

Delete Statements

POST
17.0/database/statements/{id}/lock

Lock/Unlock existing Statements

API Description
POST
17.0/database/statuses/list

Retrieve a list of Statuses

GET
17.0/database/statuses/{id}

Retrieve Statuses

GET
17.0/database/statuses/defaultmodel

Get a $Statuses model with default values

POST
17.0/database/statuses

Create Statuses

PUT
17.0/database/statuses/{id}

Update existing Statuses

DELETE
17.0/database/statuses/{id}

Delete Statuses

POST
17.0/database/statuses/{id}/lock

Lock/Unlock existing Statuses

API Description
POST
17.0/database/systemconfiguration/list

Retrieve a list of System Configuration

GET
17.0/database/systemconfiguration/{id}/{siteid}

Retrieve System Configuration

GET
17.0/database/systemconfiguration/defaultmodel

Get a $System Configuration model with default values

POST
17.0/database/systemconfiguration

Create System Configuration

PUT
17.0/database/systemconfiguration/{id}/{siteid}

Update existing System Configuration

DELETE
17.0/database/systemconfiguration/{id}/{siteid}

Delete System Configuration

POST
17.0/database/systemconfiguration/{id}/{siteid}/lock

Lock/Unlock existing System Configuration

API Description
POST
17.0/database/systemlocks/list

Retrieve a list of System Locks

GET
17.0/database/systemlocks/{id}

Retrieve System Locks

GET
17.0/database/systemlocks/defaultmodel

Get a $System Locks model with default values

POST
17.0/database/systemlocks

Create System Locks

PUT
17.0/database/systemlocks/{id}

Update existing System Locks

DELETE
17.0/database/systemlocks/{id}

Delete System Locks

POST
17.0/database/systemlocks/{id}/lock

Lock/Unlock existing System Locks

API Description
POST
17.0/database/tasktemplates/list

Retrieve a list of Task Templates

GET
17.0/database/tasktemplates/{id}

Retrieve Task Templates

GET
17.0/database/tasktemplates/defaultmodel

Get a $Task Templates model with default values

POST
17.0/database/tasktemplates

Create Task Templates

PUT
17.0/database/tasktemplates/{id}

Update existing Task Templates

DELETE
17.0/database/tasktemplates/{id}

Delete Task Templates

POST
17.0/database/tasktemplates/{id}/lock

Lock/Unlock existing Task Templates

API Description
POST
17.0/database/tasktypes/list

Retrieve a list of Task Types

GET
17.0/database/tasktypes/{id}

Retrieve Task Types

GET
17.0/database/tasktypes/defaultmodel

Get a $Task Types model with default values

POST
17.0/database/tasktypes

Create Task Types

PUT
17.0/database/tasktypes/{id}

Update existing Task Types

DELETE
17.0/database/tasktypes/{id}

Delete Task Types

POST
17.0/database/tasktypes/{id}/lock

Lock/Unlock existing Task Types

API Description
POST
17.0/database/taxrates/list

Retrieve a list of Tax Rates

GET
17.0/database/taxrates/{id}

Retrieve Tax Rates

GET
17.0/database/taxrates/defaultmodel

Get a $Tax Rates model with default values

POST
17.0/database/taxrates

Create Tax Rates

PUT
17.0/database/taxrates/{id}

Update existing Tax Rates

DELETE
17.0/database/taxrates/{id}

Delete Tax Rates

POST
17.0/database/taxrates/{id}/lock

Lock/Unlock existing Tax Rates

API Description
POST
17.0/database/tenancies/list

Retrieve a list of Tenancies

GET
17.0/database/tenancies/{id}

Retrieve Tenancies

GET
17.0/database/tenancies/defaultmodel

Get a $Tenancies model with default values

POST
17.0/database/tenancies

Create Tenancies

PUT
17.0/database/tenancies/{id}

Update existing Tenancies

DELETE
17.0/database/tenancies/{id}

Delete Tenancies

POST
17.0/database/tenancies/{id}/lock

Lock/Unlock existing Tenancies

API Description
POST
17.0/database/tenancyadditionalclauses/list

Retrieve a list of Tenancy Additional Clauses

GET
17.0/database/tenancyadditionalclauses/{id}

Retrieve Tenancy Additional Clauses

GET
17.0/database/tenancyadditionalclauses/defaultmodel

Get a $Tenancy Additional Clauses model with default values

POST
17.0/database/tenancyadditionalclauses

Create Tenancy Additional Clauses

PUT
17.0/database/tenancyadditionalclauses/{id}

Update existing Tenancy Additional Clauses

DELETE
17.0/database/tenancyadditionalclauses/{id}

Delete Tenancy Additional Clauses

POST
17.0/database/tenancyadditionalclauses/{id}/lock

Lock/Unlock existing Tenancy Additional Clauses

API Description
POST
17.0/database/tenancypermittedoccupiers/list

Retrieve a list of Tenancy Permitted Occupiers

GET
17.0/database/tenancypermittedoccupiers/{tenancyid}/{contactid}

Retrieve Tenancy Permitted Occupiers

GET
17.0/database/tenancypermittedoccupiers/defaultmodel

Get a $Tenancy Permitted Occupiers model with default values

POST
17.0/database/tenancypermittedoccupiers

Create Tenancy Permitted Occupiers

PUT
17.0/database/tenancypermittedoccupiers/{tenancyid}/{contactid}

Update existing Tenancy Permitted Occupiers

DELETE
17.0/database/tenancypermittedoccupiers/{tenancyid}/{contactid}

Delete Tenancy Permitted Occupiers

POST
17.0/database/tenancypermittedoccupiers/{tenancyid}/{contactid}/lock

Lock/Unlock existing Tenancy Permitted Occupiers

API Description
POST
17.0/database/testimonials/list

Retrieve a list of Testimonials

GET
17.0/database/testimonials/{id}

Retrieve Testimonials

GET
17.0/database/testimonials/defaultmodel

Get a $Testimonials model with default values

POST
17.0/database/testimonials

Create Testimonials

PUT
17.0/database/testimonials/{id}

Update existing Testimonials

DELETE
17.0/database/testimonials/{id}

Delete Testimonials

POST
17.0/database/testimonials/{id}/lock

Lock/Unlock existing Testimonials

API Description
POST
17.0/database/titles/list

Retrieve a list of Titles

GET
17.0/database/titles/{id}

Retrieve Titles

GET
17.0/database/titles/defaultmodel

Get a $Titles model with default values

POST
17.0/database/titles

Create Titles

PUT
17.0/database/titles/{id}

Update existing Titles

DELETE
17.0/database/titles/{id}

Delete Titles

POST
17.0/database/titles/{id}/lock

Lock/Unlock existing Titles

API Description
POST
17.0/database/transactions/list

Retrieve a list of Transactions

GET
17.0/database/transactions/{id}

Retrieve Transactions

GET
17.0/database/transactions/defaultmodel

Get a $Transactions model with default values

POST
17.0/database/transactions

Create Transactions

PUT
17.0/database/transactions/{id}

Update existing Transactions

DELETE
17.0/database/transactions/{id}

Delete Transactions

POST
17.0/database/transactions/{id}/lock

Lock/Unlock existing Transactions

API Description
POST
17.0/database/types/list

Retrieve a list of Types

GET
17.0/database/types/{id}

Retrieve Types

GET
17.0/database/types/defaultmodel

Get a $Types model with default values

POST
17.0/database/types

Create Types

PUT
17.0/database/types/{id}

Update existing Types

DELETE
17.0/database/types/{id}

Delete Types

POST
17.0/database/types/{id}/lock

Lock/Unlock existing Types

API Description
POST
17.0/database/userdepartments/list

Retrieve a list of User Departments

GET
17.0/database/userdepartments/{id}

Retrieve User Departments

GET
17.0/database/userdepartments/defaultmodel

Get a $User Departments model with default values

POST
17.0/database/userdepartments

Create User Departments

PUT
17.0/database/userdepartments/{id}

Update existing User Departments

DELETE
17.0/database/userdepartments/{id}

Delete User Departments

POST
17.0/database/userdepartments/{id}/lock

Lock/Unlock existing User Departments

API Description
POST
17.0/database/userdesktopalerts/list

Retrieve a list of User Desktop Alerts

GET
17.0/database/userdesktopalerts/{userid}/{type}

Retrieve User Desktop Alerts

GET
17.0/database/userdesktopalerts/defaultmodel

Get a $User Desktop Alerts model with default values

POST
17.0/database/userdesktopalerts

Create User Desktop Alerts

PUT
17.0/database/userdesktopalerts/{userid}/{type}

Update existing User Desktop Alerts

DELETE
17.0/database/userdesktopalerts/{userid}/{type}

Delete User Desktop Alerts

POST
17.0/database/userdesktopalerts/{userid}/{type}/lock

Lock/Unlock existing User Desktop Alerts

API Description
POST
17.0/database/userlogins/list

Retrieve a list of User Logins

GET
17.0/database/userlogins/{pcid}/{userid}

Retrieve User Logins

GET
17.0/database/userlogins/defaultmodel

Get a $User Logins model with default values

POST
17.0/database/userlogins

Create User Logins

PUT
17.0/database/userlogins/{pcid}/{userid}

Update existing User Logins

DELETE
17.0/database/userlogins/{pcid}/{userid}

Delete User Logins

POST
17.0/database/userlogins/{pcid}/{userid}/lock

Lock/Unlock existing User Logins

API Description
POST
17.0/database/users/list

Retrieve a list of Users

GET
17.0/database/users/{id}

Retrieve Users

GET
17.0/database/users/defaultmodel

Get a $Users model with default values

POST
17.0/database/users

Create Users

PUT
17.0/database/users/{id}

Update existing Users

DELETE
17.0/database/users/{id}

Delete Users

POST
17.0/database/users/{id}/lock

Lock/Unlock existing Users

API Description
POST
17.0/database/usertypes/list

Retrieve a list of User Types

GET
17.0/database/usertypes/{id}

Retrieve User Types

GET
17.0/database/usertypes/defaultmodel

Get a $User Types model with default values

POST
17.0/database/usertypes

Create User Types

PUT
17.0/database/usertypes/{id}

Update existing User Types

DELETE
17.0/database/usertypes/{id}

Delete User Types

POST
17.0/database/usertypes/{id}/lock

Lock/Unlock existing User Types

API Description
POST
17.0/database/viewingarrangements/list

Retrieve a list of Viewing Arrangements

GET
17.0/database/viewingarrangements/{id}

Retrieve Viewing Arrangements

GET
17.0/database/viewingarrangements/defaultmodel

Get a $Viewing Arrangements model with default values

POST
17.0/database/viewingarrangements

Create Viewing Arrangements

PUT
17.0/database/viewingarrangements/{id}

Update existing Viewing Arrangements

DELETE
17.0/database/viewingarrangements/{id}

Delete Viewing Arrangements

POST
17.0/database/viewingarrangements/{id}/lock

Lock/Unlock existing Viewing Arrangements

API Description
POST
17.0/database/workorders/list

Retrieve a list of Work Orders

GET
17.0/database/workorders/{id}

Retrieve Work Orders

GET
17.0/database/workorders/defaultmodel

Get a $Work Orders model with default values

POST
17.0/database/workorders

Create Work Orders

PUT
17.0/database/workorders/{id}

Update existing Work Orders

DELETE
17.0/database/workorders/{id}

Delete Work Orders

POST
17.0/database/workorders/{id}/lock

Lock/Unlock existing Work Orders

API Description
POST
17.0/database/workordertypes/list

Retrieve a list of Work Order Types

GET
17.0/database/workordertypes/{id}

Retrieve Work Order Types

GET
17.0/database/workordertypes/defaultmodel

Get a $Work Order Types model with default values

POST
17.0/database/workordertypes

Create Work Order Types

PUT
17.0/database/workordertypes/{id}

Update existing Work Order Types

DELETE
17.0/database/workordertypes/{id}

Delete Work Order Types

POST
17.0/database/workordertypes/{id}/lock

Lock/Unlock existing Work Order Types

API Description
POST
17.0/find/contact

Finds contact records based on the passed query

POST
17.0/find/contact/count

Gets number of contacts that match passed query

API Description
POST
17.0/find/property

Finds property records based on the passed query

POST
17.0/find/property/count

Gets the number of Properties that match the passed query