Creates or updates a provider field. If updating a field might result in invalid profiles for this provider, all profiles are disassociated from meetings.

For example, if you change a field from optional to mandatory, some existing profiles might not meet the new criteria. Therefore, Adobe Connect disassociates all this provider’s profiles from meetings. After updating the field or fields, you need to update profiles as needed and then re-associate them with meetings.

Syntax

http://server_name/api/xml?action=telephony-provider-field-update&provider-id=integer&input-type=input-type&display-in-meeting=display-in-meeting&required=boolean&user-specified=boolean&is-hidden=boolean

Parameters

Name

Required?

Description

provider-id

Y

Integer that specifies the provider whose fields need to be updated or created.

field-id

Y if you don’t specify a value for xml-name; otherwise N

Integer that specifies the ID of the field to be updated or created.

xml-name

Y if you don’t specify a value for field-id; otherwise N

String that specifies the XML name of the field to be updated or created. If a value is also specified for field-id, xml-name is ignored.

input-type

Y

Input type of this field. Acceptable values are text, password, textarea, and url.

display-in-meeting

N

String that specifies which participants can see this field in the Adobe Connect meeting room. Acceptable values are none and participants.

required

Y

Boolean value that specifies if this is a required field.

user-specified

N

Boolean value that specifies whether this is a field that the user specifies, such as password.

is-hidden

N

Boolean value that specifies whether this field can be displayed through a user interface.

Permission

You must have permission to modify the provider whose field you are creating or updating.

Example

Request (to create a provider field):

http://example.com/api/xml?action=telephony-provider-field-update&provider-id=11718&input-type=text&display-in-meeting=participants&required=true&user-specified=true&is-hidden=false

Response:

<results> 
    <status code="ok"/> 
    - 
    <telephony-provider provider-status="enabled" provider-type="user-conf" provider-id="12000"> 
        <name>my-provider</name> 
        <adaptor-id>12000-adaptor</adaptor-id> 
    </telephony-provider> 
</results>

Request (to update a provider field):

http://example.com/api/xml?action=telephony-provider-field-update&provider-id=11718&input-type=text&display-in-meeting=participants&required=false&user-specified=false&is-hidden=false&field-id=11829&xml-name=x-tel-11829

Response:

<results> 
    <status code="ok"/> 
</results>

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy