Estás aquí: Planyo » Ayuda » API » add_resource

add_resource

Description:

Use this function to add a new resource to your Planyo site. The new resource is created by making an exact copy of an existing resource (it can be an unpublished resource which you can keep on your site free of charge just for this purpose), including custom resource properties (images are not duplicated). You can additionally use optional parameters to override base resource's settings. The only required parameter from this group is the name of the new resource.

Input:

ID of the resource used as a base for the new resource.Name of the new resourceQuantity of the new resourceIn case you want to use predefined durations (see time-related settings in resource settings or Q228), specify the number of durations in this parameter. You should also pass the actual durations and their descriptions in the parameters: predefined_duration_text_X and predefined_duration_hours_X (where X is a number from 1 to the value of predefined_duration_count). If you don't want to use predefined durations, or want to use the base resource's settings, don't pass this parameter.You can override the base resource's minimum rental time (expressed in hours) by specifying this parameter. This is ignored if you specified predefined_duration_countYou can override the base resource's maximum rental time (expressed in hours) by specifying this parameter. This is ignored if you specified predefined_duration_countYou can override the base resource's setting Available on working days from. This only applies to hour-based resources. This should be a single integer (using a 24-hour clock), e.g. 8 means 8am.You can override the base resource's setting Available on working days until. This only applies to hour-based resources. This should be a single integer (using a 24-hour clock), e.g. 18 means 6pm.You can override the base resource's setting Restrict starting times. This only applies to hour-based resources. The different times should be comma-separated.You can override the base resource's setting Min. time between reservation and rental. This is an integer, time is expressed in hours.You can override the base resource's setting Max. time between reservation and rental. This is an integer, time is expressed in days.You can override the base resource's default price (first row in the pricing manager). This can be also used to specify a new custom pricing script (see Q137 in the FAQ).You can override the base resource's resource admin ID. The new resource admin must be either an existing resource admin or moderator. New users without an administrative role in this Planyo site are not allowed to be admins.If you set this parameter, the resource will become an event-type resource. Here you can specify comma-separated start dates or start dates and times (in the same way as in resource settings).By default the new resource will be published. You can set this to false if you want it to be unpublished.Resource descriptionResource-specific properties (defined in the admin panel in: Site settings / Custom resource properties). E.g. for a custom property 'distance to sea', this would be prop_res_distance_to_sea (where '_' replaces all space characters).You can pass comma-separated full URLs (starting with http:// or https://) of images to be downloaded by Planyo and used for the new resource.must be set to add_resourceby specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returnedyour API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.

Output:

ID of the newly created resource (in case of success).

API playground:

Click here to test this function in the API playground.