Method

rxc-occupanttypes-get

Description

This method return occupant types for the business that is currently logged in or for the business_id that is passed in.

Parameters

Name Input Value Type Description
business_id Integer (Optional) ID Number of the business to return details for. To return details for multiple businesses, call this method once for each business. Default value is the business of the logged in user.
withinactive Integer (Optional) When non-zero, all centrally defined occupant types are returned, with an "active" flag specifying which ones are active. If zero, or not passed, only the active occupants assigned to the business are reeturned.
format enumeration (optional) Set this value to "xml" for XML raw formatted output, "xml-clean" for XML tidy formatted output or "json" for JSON formatted output. If not passed, "xml" is used as a default

XML Encoded Request

URL Encoded Request





Result