Evo Voice

ListSettingsObjects

Get all configurable settings objects for the authenticated user

**Requires Authentication**
Required role:	User

The following routes are available for this service:
GET	/app/settings-objects

**ListSettingsObjectsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
SettingsObjects	form	List<SettingsObject>	No

**SettingsObject** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
Description	form	string	No
ReadOnly	form	bool	No
Type	form	SettingsObjectTypes	No
EndpointType	form	EndpointTypes?	No
Fields	form	List<SettingsField>	No

**SettingsObjectTypes** Enum:
Endpoint
Customer

**EndpointTypes** Enum:
PhoneNumber
User
FaxNumber
EmailAddress
Unused_1
Unused_2
Unused_3
Unused_4
Unused_5
Team

**SettingsField** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
DisplayName	form	string	No
Type	form	ValueTypes	No
Value	form	Value	No
ReadOnly	form	bool	No
PossibleValues	form	List<SettingsPossibleValue>	No
DataField	form	DataField	No

**ValueTypes** Enum:
NotSpecified
String
Boolean
Number
List
Struct
Transition
Custom
Date
AudioFile
TimeZoneId
PhoneNumber
User
Endpoint
Time
File
FaxNumber
EmailAccount
Customer
Flow
Team
FlowReference
Integration

**Value** Parameters:
Name	Parameter	Data Type	Required
BoolValue	form	bool?	No
StringValue	form	string	No
NumberValue	form	double?	No
ListValue	form	List<Struct>	No
StructValue	form	Struct	No

**SettingsPossibleValue** Parameters:
Name	Parameter	Data Type	Required	Description
DisplayName	form	string	No
Value	form	Value	No

**DataField** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
Type	form	ValueTypes	No
UIHint	form	UIHints	No
UITab	form	string	No
IsAsync	form	bool	No
DisableBinding	form	bool	No
StructType	form	DataType	No
ListType	form	DataType	No
Description	form	string	No
PossibleValues	form	List<string>	No
IsOutput	form	bool	No
CustomFieldValuesUrl	form	string	No
DefaultValue	form	Value	No
TransitionNameFormat	form	string	No
Uniqueness	form	DataFieldUniqueness	No
VoiceOnly	form	bool	No
ConditionalVisibilityField	form	string	No
ConditionalVisibilityValue	form	string	No
NoEvalTemplate	form	bool	No
UserMode	form	UserDataFieldModes	No
AnyValueType	form	bool	No

**UIHints** Enum:
None
LargeText
InlineForm
Password
InlineStruct

**DataType** Parameters:
Name	Parameter	Data Type	Required	Description
TypeName	form	string	No
Fields	form	List<DataField>	No

**DataFieldUniqueness** Enum:
NotUnique
Unique
UniqueToCustomer

**UserDataFieldModes** Enum:
Hidden
ReadOnly
ReadWrite

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /app/settings-objects HTTP/1.1 
Host: evovoice.io 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	settingsObjects: 
	[
		{
			id: String,
			name: String,
			description: String,
			readOnly: False,
			type: Endpoint,
			endpointType: PhoneNumber,
			fields: 
			[
				{
					name: String,
					displayName: String,
					type: NotSpecified,
					value: 
					{
						boolValue: False,
						stringValue: String,
						numberValue: 0,
						listValue: 
						[
							{
								String: 
								{
									boolValue: False,
									stringValue: String,
									numberValue: 0,
									listValue: 
									[
										{
											String: 
											{
												boolValue: False,
												stringValue: String,
												numberValue: 0,
												listValue: 
												[
													{
														
													}
												],
												structValue: {}
											}
										}
									],
									structValue: 
									{
										String: 
										{
											boolValue: False,
											stringValue: String,
											numberValue: 0,
											listValue: 
											[
												{
													
												}
											],
											structValue: {}
										}
									}
								}
							}
						],
						structValue: 
						{
							String: 
							{
								boolValue: False,
								stringValue: String,
								numberValue: 0,
								listValue: 
								[
									{
										String: 
										{
											boolValue: False,
											stringValue: String,
											numberValue: 0,
											listValue: 
											[
												{
													
												}
											],
											structValue: {}
										}
									}
								],
								structValue: 
								{
									String: 
									{
										boolValue: False,
										stringValue: String,
										numberValue: 0,
										listValue: 
										[
											{
												
											}
										],
										structValue: {}
									}
								}
							}
						}
					},
					readOnly: False,
					possibleValues: 
					[
						{
							displayName: String,
							value: 
							{
								boolValue: False,
								stringValue: String,
								numberValue: 0,
								listValue: 
								[
									{
										String: 
										{
											boolValue: False,
											stringValue: String,
											numberValue: 0,
											listValue: 
											[
												{
													String: 
													{
														boolValue: False,
														stringValue: String,
														numberValue: 0,
														listValue: 
														[
															{
																
															}
														],
														structValue: {}
													}
												}
											],
											structValue: 
											{
												String: 
												{
													boolValue: False,
													stringValue: String,
													numberValue: 0,
													listValue: 
													[
														{
															
														}
													],
													structValue: {}
												}
											}
										}
									}
								],
								structValue: 
								{
									String: 
									{
										boolValue: False,
										stringValue: String,
										numberValue: 0,
										listValue: 
										[
											{
												String: 
												{
													boolValue: False,
													stringValue: String,
													numberValue: 0,
													listValue: 
													[
														{
															
														}
													],
													structValue: {}
												}
											}
										],
										structValue: 
										{
											String: 
											{
												boolValue: False,
												stringValue: String,
												numberValue: 0,
												listValue: 
												[
													{
														
													}
												],
												structValue: {}
											}
										}
									}
								}
							}
						}
					],
					dataField: 
					{
						id: String,
						name: String,
						type: NotSpecified,
						uiHint: None,
						uiTab: String,
						isAsync: False,
						disableBinding: False,
						structType: 
						{
							typeName: String,
							fields: 
							[
								{
									id: String,
									name: String,
									type: NotSpecified,
									uiHint: None,
									uiTab: String,
									isAsync: False,
									disableBinding: False,
									structType: 
									{
										typeName: String,
										fields: 
										[
											{
												id: String,
												name: String,
												type: NotSpecified,
												uiHint: None,
												uiTab: String,
												isAsync: False,
												disableBinding: False,
												structType: 
												{
													typeName: String,
													fields: 
													[
														{
															
														}
													]
												},
												listType: 
												{
													typeName: String,
													fields: 
													[
														{
															
														}
													]
												},
												description: String,
												possibleValues: 
												[
													String
												],
												isOutput: False,
												customFieldValuesUrl: String,
												defaultValue: 
												{
													boolValue: False,
													stringValue: String,
													numberValue: 0,
													listValue: 
													[
														{
															String: 
															{
																boolValue: False,
																stringValue: String,
																numberValue: 0,
																listValue: 
																[
																	{
																		String: 
																		{
																			boolValue: False,
																			stringValue: String,
																			numberValue: 0,
																			listValue: 
																			[
																				{
																					
																				}
																			],
																			structValue: {}
																		}
																	}
																],
																structValue: 
																{
																	String: 
																	{
																		boolValue: False,
																		stringValue: String,
																		numberValue: 0,
																		listValue: 
																		[
																			{
																				
																			}
																		],
																		structValue: {}
																	}
																}
															}
														}
													],
													structValue: 
													{
														String: 
														{
															boolValue: False,
															stringValue: String,
															numberValue: 0,
															listValue: 
															[
																{
																	String: 
																	{
																		boolValue: False,
																		stringValue: String,
																		numberValue: 0,
																		listValue: 
																		[
																			{
																				
																			}
																		],
																		structValue: {}
																	}
																}
															],
															structValue: 
															{
																String: 
																{
																	boolValue: False,
																	stringValue: String,
																	numberValue: 0,
																	listValue: 
																	[
																		{
																			
																		}
																	],
																	structValue: {}
																}
															}
														}
													}
												},
												transitionNameFormat: String,
												uniqueness: NotUnique,
												voiceOnly: False,
												conditionalVisibilityField: String,
												conditionalVisibilityValue: String,
												noEvalTemplate: False,
												userMode: Hidden,
												anyValueType: False
											}
										]
									},
									listType: 
									{
										typeName: String,
										fields: 
										[
											{
												id: String,
												name: String,
												type: NotSpecified,
												uiHint: None,
												uiTab: String,
												isAsync: False,
												disableBinding: False,
												structType: 
												{
													typeName: String,
													fields: 
													[
														{
															
														}
													]
												},
												listType: 
												{
													typeName: String,
													fields: 
													[
														{
															
														}
													]
												},
												description: String,
												possibleValues: 
												[
													String
												],
												isOutput: False,
												customFieldValuesUrl: String,
												defaultValue: 
												{
													boolValue: False,
													stringValue: String,
													numberValue: 0,
													listValue: 
													[
														{
															String: 
															{
																boolValue: False,
																stringValue: String,
																numberValue: 0,
																listValue: 
																[
																	{
																		String: 
																		{
																			boolValue: False,
																			stringValue: String,
																			numberValue: 0,
																			listValue: 
																			[
																				{
																					
																				}
																			],
																			structValue: {}
																		}
																	}
																],
																structValue: 
																{
																	String: 
																	{
																		boolValue: False,
																		stringValue: String,
																		numberValue: 0,
																		listValue: 
																		[
																			{
																				
																			}
																		],
																		structValue: {}
																	}
																}
															}
														}
													],
													structValue: 
													{
														String: 
														{
															boolValue: False,
															stringValue: String,
															numberValue: 0,
															listValue: 
															[
																{
																	String: 
																	{
																		boolValue: False,
																		stringValue: String,
																		numberValue: 0,
																		listValue: 
																		[
																			{
																				
																			}
																		],
																		structValue: {}
																	}
																}
															],
															structValue: 
															{
																String: 
																{
																	boolValue: False,
																	stringValue: String,
																	numberValue: 0,
																	listValue: 
																	[
																		{
																			
																		}
																	],
																	structValue: {}
																}
															}
														}
													}
												},
												transitionNameFormat: String,
												uniqueness: NotUnique,
												voiceOnly: False,
												conditionalVisibilityField: String,
												conditionalVisibilityValue: String,
												noEvalTemplate: False,
												userMode: Hidden,
												anyValueType: False
											}
										]
									},
									description: String,
									possibleValues: 
									[
										String
									],
									isOutput: False,
									customFieldValuesUrl: String,
									defaultValue: 
									{
										boolValue: False,
										stringValue: String,
										numberValue: 0,
										listValue: 
										[
											{
												String: 
												{
													boolValue: False,
													stringValue: String,
													numberValue: 0,
													listValue: 
													[
														{
															String: 
															{
																boolValue: False,
																stringValue: String,
																numberValue: 0,
																listValue: 
																[
																	{
																		
																	}
																],
																structValue: {}
															}
														}
													],
													structValue: 
													{
														String: 
														{
															boolValue: False,
															stringValue: String,
															numberValue: 0,
															listValue: 
															[
																{
																	
																}
															],
															structValue: {}
														}
													}
												}
											}
										],
										structValue: 
										{
											String: 
											{
												boolValue: False,
												stringValue: String,
												numberValue: 0,
												listValue: 
												[
													{
														String: 
														{
															boolValue: False,
															stringValue: String,
															numberValue: 0,
															listValue: 
															[
																{
																	
																}
															],
															structValue: {}
														}
													}
												],
												structValue: 
												{
													String: 
													{
														boolValue: False,
														stringValue: String,
														numberValue: 0,
														listValue: 
														[
															{
																
															}
														],
														structValue: {}
													}
												}
											}
										}
									},
									transitionNameFormat: String,
									uniqueness: NotUnique,
									voiceOnly: False,
									conditionalVisibilityField: String,
									conditionalVisibilityValue: String,
									noEvalTemplate: False,
									userMode: Hidden,
									anyValueType: False
								}
							]
						},
						listType: 
						{
							typeName: String,
							fields: 
							[
								{
									id: String,
									name: String,
									type: NotSpecified,
									uiHint: None,
									uiTab: String,
									isAsync: False,
									disableBinding: False,
									structType: 
									{
										typeName: String,
										fields: 
										[
											{
												id: String,
												name: String,
												type: NotSpecified,
												uiHint: None,
												uiTab: String,
												isAsync: False,
												disableBinding: False,
												structType: 
												{
													typeName: String,
													fields: 
													[
														{
															
														}
													]
												},
												listType: 
												{
													typeName: String,
													fields: 
													[
														{
															
														}
													]
												},
												description: String,
												possibleValues: 
												[
													String
												],
												isOutput: False,
												customFieldValuesUrl: String,
												defaultValue: 
												{
													boolValue: False,
													stringValue: String,
													numberValue: 0,
													listValue: 
													[
														{
															String: 
															{
																boolValue: False,
																stringValue: String,
																numberValue: 0,
																listValue: 
																[
																	{
																		String: 
																		{
																			boolValue: False,
																			stringValue: String,
																			numberValue: 0,
																			listValue: 
																			[
																				{
																					
																				}
																			],
																			structValue: {}
																		}
																	}
																],
																structValue: 
																{
																	String: 
																	{
																		boolValue: False,
																		stringValue: String,
																		numberValue: 0,
																		listValue: 
																		[
																			{
																				
																			}
																		],
																		structValue: {}
																	}
																}
															}
														}
													],
													structValue: 
													{
														String: 
														{
															boolValue: False,
															stringValue: String,
															numberValue: 0,
															listValue: 
															[
																{
																	String: 
																	{
																		boolValue: False,
																		stringValue: String,
																		numberValue: 0,
																		listValue: 
																		[
																			{
																				
																			}
																		],
																		structValue: {}
																	}
																}
															],
															structValue: 
															{
																String: 
																{
																	boolValue: False,
																	stringValue: String,
																	numberValue: 0,
																	listValue: 
																	[
																		{
																			
																		}
																	],
																	structValue: {}
																}
															}
														}
													}
												},
												transitionNameFormat: String,
												uniqueness: NotUnique,
												voiceOnly: False,
												conditionalVisibilityField: String,
												conditionalVisibilityValue: String,
												noEvalTemplate: False,
												userMode: Hidden,
												anyValueType: False
											}
										]
									},
									listType: 
									{
										typeName: String,
										fields: 
										[
											{
												id: String,
												name: String,
												type: NotSpecified,
												uiHint: None,
												uiTab: String,
												isAsync: False,
												disableBinding: False,
												structType: 
												{
													typeName: String,
													fields: 
													[
														{
															
														}
													]
												},
												listType: 
												{
													typeName: String,
													fields: 
													[
														{
															
														}
													]
												},
												description: String,
												possibleValues: 
												[
													String
												],
												isOutput: False,
												customFieldValuesUrl: String,
												defaultValue: 
												{
													boolValue: False,
													stringValue: String,
													numberValue: 0,
													listValue: 
													[
														{
															String: 
															{
																boolValue: False,
																stringValue: String,
																numberValue: 0,
																listValue: 
																[
																	{
																		String: 
																		{
																			boolValue: False,
																			stringValue: String,
																			numberValue: 0,
																			listValue: 
																			[
																				{
																					
																				}
																			],
																			structValue: {}
																		}
																	}
																],
																structValue: 
																{
																	String: 
																	{
																		boolValue: False,
																		stringValue: String,
																		numberValue: 0,
																		listValue: 
																		[
																			{
																				
																			}
																		],
																		structValue: {}
																	}
																}
															}
														}
													],
													structValue: 
													{
														String: 
														{
															boolValue: False,
															stringValue: String,
															numberValue: 0,
															listValue: 
															[
																{
																	String: 
																	{
																		boolValue: False,
																		stringValue: String,
																		numberValue: 0,
																		listValue: 
																		[
																			{
																				
																			}
																		],
																		structValue: {}
																	}
																}
															],
															structValue: 
															{
																String: 
																{
																	boolValue: False,
																	stringValue: String,
																	numberValue: 0,
																	listValue: 
																	[
																		{
																			
																		}
																	],
																	structValue: {}
																}
															}
														}
													}
												},
												transitionNameFormat: String,
												uniqueness: NotUnique,
												voiceOnly: False,
												conditionalVisibilityField: String,
												conditionalVisibilityValue: String,
												noEvalTemplate: False,
												userMode: Hidden,
												anyValueType: False
											}
										]
									},
									description: String,
									possibleValues: 
									[
										String
									],
									isOutput: False,
									customFieldValuesUrl: String,
									defaultValue: 
									{
										boolValue: False,
										stringValue: String,
										numberValue: 0,
										listValue: 
										[
											{
												String: 
												{
													boolValue: False,
													stringValue: String,
													numberValue: 0,
													listValue: 
													[
														{
															String: 
															{
																boolValue: False,
																stringValue: String,
																numberValue: 0,
																listValue: 
																[
																	{
																		
																	}
																],
																structValue: {}
															}
														}
													],
													structValue: 
													{
														String: 
														{
															boolValue: False,
															stringValue: String,
															numberValue: 0,
															listValue: 
															[
																{
																	
																}
															],
															structValue: {}
														}
													}
												}
											}
										],
										structValue: 
										{
											String: 
											{
												boolValue: False,
												stringValue: String,
												numberValue: 0,
												listValue: 
												[
													{
														String: 
														{
															boolValue: False,
															stringValue: String,
															numberValue: 0,
															listValue: 
															[
																{
																	
																}
															],
															structValue: {}
														}
													}
												],
												structValue: 
												{
													String: 
													{
														boolValue: False,
														stringValue: String,
														numberValue: 0,
														listValue: 
														[
															{
																
															}
														],
														structValue: {}
													}
												}
											}
										}
									},
									transitionNameFormat: String,
									uniqueness: NotUnique,
									voiceOnly: False,
									conditionalVisibilityField: String,
									conditionalVisibilityValue: String,
									noEvalTemplate: False,
									userMode: Hidden,
									anyValueType: False
								}
							]
						},
						description: String,
						possibleValues: 
						[
							String
						],
						isOutput: False,
						customFieldValuesUrl: String,
						defaultValue: 
						{
							boolValue: False,
							stringValue: String,
							numberValue: 0,
							listValue: 
							[
								{
									String: 
									{
										boolValue: False,
										stringValue: String,
										numberValue: 0,
										listValue: 
										[
											{
												String: 
												{
													boolValue: False,
													stringValue: String,
													numberValue: 0,
													listValue: 
													[
														{
															
														}
													],
													structValue: {}
												}
											}
										],
										structValue: 
										{
											String: 
											{
												boolValue: False,
												stringValue: String,
												numberValue: 0,
												listValue: 
												[
													{
														
													}
												],
												structValue: {}
											}
										}
									}
								}
							],
							structValue: 
							{
								String: 
								{
									boolValue: False,
									stringValue: String,
									numberValue: 0,
									listValue: 
									[
										{
											String: 
											{
												boolValue: False,
												stringValue: String,
												numberValue: 0,
												listValue: 
												[
													{
														
													}
												],
												structValue: {}
											}
										}
									],
									structValue: 
									{
										String: 
										{
											boolValue: False,
											stringValue: String,
											numberValue: 0,
											listValue: 
											[
												{
													
												}
											],
											structValue: {}
										}
									}
								}
							}
						},
						transitionNameFormat: String,
						uniqueness: NotUnique,
						voiceOnly: False,
						conditionalVisibilityField: String,
						conditionalVisibilityValue: String,
						noEvalTemplate: False,
						userMode: Hidden,
						anyValueType: False
					}
				}
			]
		}
	]
}