All Verbs | /portal/system-settings |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AccountId | query | string | No | |
CustomerId | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
EndpointFields | form | List<EndpointDataField> | No | |
IsHostedSuiteCustomer | form | bool | No | Is this customer a HostedSuite customer? |
CustomerTimeZoneId | form | string | No | The customer's time zone |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ShowInSearch | form | bool | No | |
ShowInLists | form | bool | No | |
EndpointType | form | EndpointTypes? | No | |
IsCallerId | form | bool | No | |
IsKnob | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
NotSpecified | |
String | |
Boolean | |
Number | |
List | |
Struct | |
Transition | |
Custom | |
Date | |
AudioFile | |
TimeZoneId | |
PhoneNumber | |
User | |
Endpoint | |
Time | |
File | |
FaxNumber | |
EmailAccount | |
Customer | |
Flow | |
Team | |
FlowReference | |
Integration | |
Assistant |
None | |
LargeText | |
InlineForm | |
Password | |
InlineStruct |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TypeName | form | string | No | |
Fields | form | List<DataField> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BoolValue | form | bool? | No | |
StringValue | form | string | No | |
NumberValue | form | double? | No | |
ListValue | form | List<Struct> | No | |
StructValue | form | Struct | No |
NotUnique | |
Unique | |
UniqueToCustomer |
Hidden | |
ReadOnly | |
ReadWrite |
PhoneNumber | |
User | |
FaxNumber | |
EmailAddress | |
Unused_1 | |
Unused_2 | |
Unused_3 | |
Unused_4 | |
Unused_5 | |
Team | |
Assistant |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /portal/system-settings HTTP/1.1
Host: team.evovoice.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
accountId: String,
customerId: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { endpointFields: [ { showInSearch: False, showInLists: False, endpointType: PhoneNumber, isCallerId: False, isKnob: False, id: String, name: String, type: NotSpecified, uiHint: None, uiTab: String, isAsync: False, disableBinding: False, description: String, possibleValues: [ String ], isOutput: False, customFieldValuesUrl: String, defaultValue: { boolValue: False, stringValue: String, numberValue: 0, listValue: [ null ] }, transitionNameFormat: String, uniqueness: NotUnique, voiceOnly: False, conditionalVisibilityField: String, conditionalVisibilityValue: String, noEvalTemplate: False, userMode: Hidden, anyValueType: False } ], isHostedSuiteCustomer: False, customerTimeZoneId: String }