This chapter describes the Web Services Admin API.
VidyoPortal Admin Service URL:
http://VIDYOPORTAL/services/v1_1/VidyoPortalAdminService?wsdl
Super Admins can also access Admin Web Services.
The following methods are described in this article as part of the Admin API package.
addClientVersion
Adds the endpoint upload as a CDN URL and Tag.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
ClientType | String | Specifies the type of client being requested:
|
Yes |
currentTag |
EndpointVersionPattern |
Specifies the tag of the endpoint version using a string pattern. Only a-z or A-Z or 0-9 or ‘.’ and ‘_’ are allowed. |
Yes |
installerURL | String | Specifies the URL where the endpoint can be downloaded from. Currently http and https are allowed as protocols. | Yes |
setActive | Boolean | Makes the new endpoint upload URL active. | No |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
EndpointUploadID |
Integer |
The endpoint upload ID of the newly created endpoint upload URL |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
ExternalModeFault | The external mode is not enabled by the Super Admin |
getEndpointBehavior
Retrieves the endpoint behavior at the tenant level.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
endpointBehaviorkey |
String |
The mapping of the endpoint behavior. |
Yes |
Response Parameter
Name | Type | Description |
---|---|---|
EndpointBehavior | Endpoint BehaviorType |
Contains the parameters for all endpoint behavior configurations. These parameters may include the following:
|
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NoEndpointBehaviorExistsFault |
The endpoint behavior does not exist for the tenant |
EndpointBehaviorDisabledFault | The endpoint behavior has been disabled for the tenant |
createEndpointBehavior
Adds new endpoint behavior at the tenant level.
This method can use the following parameters:
Request Parameter
Name | Type | Description |
---|---|---|
EndpointBehavior | Endpoint BehaviorType |
Contains the parameters for all endpoint behavior configurations. These parameters may include the following:
|
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
endpointBehaviorkey |
String |
The mapping of the endpoint behavior |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NoEndpointBehaviorExistsFault |
The endpoint behavior does not exist for the tenant |
EndpointBehaviorDisabledFault | The endpoint behavior has been disabled for the tenant |
updateEndpointBehavior
Updates the endpoint behavior at the tenant level.
This method can use the following parameters:
Request Parameter
Name | Type | Description |
---|---|---|
EndpointBehavior | Endpoint BehaviorType |
Contains the parameters for all endpoint behavior configurations. These parameters may include the following:
|
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK | String | Acknowledges that the operation was made successfully | Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NoEndpointBehaviorExistsFault |
The endpoint behavior does not exist for the tenant |
EndpointBehaviorDisabledFault | The endpoint behavior has been disabled for the tenant |
deleteEndpointBehavior
Gets the tenant details based on the tenant ID.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
endpointBehaviorkey |
String |
The mapping of the endpoint behavior. |
No |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NoEndpointBehaviorExistsFault |
The endpoint behavior does not exist for the tenant |
EndpointBehaviorDisabledFault | The endpoint behavior has been disabled for the tenant |
searchMembers
Optimizes searches for members.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
start |
integer |
Starting row number to return |
No |
limit |
integer |
Maximum number of results to return |
No |
sortBy |
string |
Field to sort by |
No |
sortDir |
sortDir |
Sort ascending ("ASC") or descending ("DESC") |
No |
MemberFilter |
MemberFilter |
A MemberFilter object containing:
|
No |
Response Parameters
Name | Type | Description | Required |
---|---|---|---|
start |
Integer |
Starting row number to return |
Yes |
limit |
Integer |
Maximum number of results to return |
Yes |
sortBy |
String |
Field to sort by |
Yes |
MemberFilter |
MemberFilter |
A MemberFilter object containing:
|
Yes |
total |
total |
The total number of possble results |
Yes |
Member |
Member |
The list of Member objects containing:
|
No |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NotLicensedFault | The API is not licensed |
GetMembers
Retrieves VidyoPortal members that meet the criteria specified in a filter (optional).
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
filter.<nnnn> | Filter | The filter type is used to trim down (filter) the search results. The value <nnnn> could be any of or all of the variables below. | Yes |
start |
Integer |
This is the beginning index of the search result. Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the start=30 value. |
No |
limit |
Integer |
This is the number of results that are being requested. Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the limit=10 value. |
No |
sortBy |
String:
|
This is the field by which the requestor is asking the results to be sorted by. Note: In the User API, entityID is used instead of memberID. Example: If the result has to be sorted in an ascending order by the extension number of the Entity, then the requestor provides the sortBy=extension/name/displayName or memeberID value. |
No |
dir |
String:
|
This is the field by which the requestor is asking the results to be sorted in a specific direction/order, ascending or descending. Example: If the result has to be sorted in an ascending order by the extension number of the Entity, then the requestor provides the dir=ASC value. |
No |
query |
String:
|
This is the search string that uses all the above filter criteria. Example: If the requestor is looking for all members that start with the letters “pau,” then query=pau would return the desired results. |
No |
Response Parameters
Name | Type | Description | Required |
---|---|---|---|
total |
Integer |
Total number of registered members |
Yes |
member |
member |
Member properties including name, display name, extension, email and others |
No |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NotLicensedFault | The API is not licensed |
MemberNotFoundFault |
Member not found |
GetMember
Retrieves the details of a single VidyoPortal member.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
memberID |
EntityID |
The filter type is used to trim down (filter) the search results |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
member |
Member |
Member properties including name, display name, extension, email, and others |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NotLicensedFault | The API is not licensed |
MemberAlreadyExistsFault | Member already exists |
AddMember
Adds a VidyoPortal member.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
memberID |
Member |
Member details |
Yes |
returnObjectInResponse |
String |
Sends a request to retrieve the object that has been created |
No |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NotLicensedFault | The API is not licensed |
MemberAlreadyExistsFault | Member already exists |
UpdateMember
Updates the details of a VidyoPortal member.
The UserName parameter can’t be changed using this method. In order to modify the user name, a new user should be created and all parameters copied.
All other member parameters can be modified using the UpdateMember method.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
memberID |
Member |
Member details |
Yes |
member |
Member |
New member’s properties |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NotLicensedFault | The API is not licensed |
MemberNotFoundFault |
Member not found |
DeleteMember
Deletes the details of a VidyoPortal member.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
memberID |
EntityID |
Unique member identifier |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NotLicensedFault | The API is not licensed |
MemberNotFoundFault |
Member not found |
GetRooms
Retrieves rooms that meet optional search criteria.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
filter.<nnnn> | Filter | The filter type is used to trim down (filter) the search results. The value <nnnn> could be any of or all of the variables below. | Yes |
start |
Integer |
This is the beginning index of the search result. Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the start=30 value. |
No |
limit |
Integer |
This is the number of results that are being requested. Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the limit=10 value. |
No |
sortBy |
String:
|
This is the field by which the requestor is asking the results to be sorted by. Note: In the User API, entityID is used instead of memberID. Example: If the result has to be sorted in an ascending order by the extension number of the Entity, then the requestor provides the sortBy=extension/name/displayName or memeberID value. |
No |
dir |
String
|
This is the field by which the requestor is asking the results to be sorted in a specific direction/order, ascending or descending. Example: If the result has to be sorted in an ascending order by the extension number of the Entity, then the requestor provides the dir=ASC value. |
No |
query |
String:
|
This is the search string that uses all the above filter criteria. Example: If the requestor is looking for all members that start with the letters “pau,” then query=pau would return the desired results. |
No |
Response Parameters
Name | Type | Description | Required |
---|---|---|---|
total |
Integer |
Total number of registered members |
Yes |
room | Room | Room description including room name, room owner and other properties |
No |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NotLicensedFault |
API is not licensed |
GetRoom
Retrieves a room's details.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
roomID | EntityID | Unique room identifier |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
room | Room | Room description including room name, room owner and other properties |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NotLicensedFault | The API is not licensed |
RoomNotFoundFault |
Room not found |
GetRoomProfile
Requests to get a profile for a room.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
roomID | EntityID | Unique room identifier |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
roomProfile |
RoomProfile |
Specifies the room profile |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NotLicensedFault | The API is not licensed |
SetRoomProfile
Requests to set a profile for a room.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
roomID | EntityID | Unique room identifier |
Yes |
roomProfileName |
String |
Specifies the auto mute configuration selection profiles. The new profiles are:
|
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NotLicensedFault | The API is not licensed |
RemoveRoomProfile
Requests to remove a profile from a specified room ID.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
roomID | EntityID | Unique room identifier |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NotLicensedFault | The API is not licensed |
GetRoomProfiles
Requests to get a profile for rooms.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
roomID | EntityID | Unique room identifier |
Yes |
Response Parameters
Name | Type | Description | Required |
---|---|---|---|
total |
Integer |
Total number of profiles that are available |
Yes |
roomProfile |
RoomProfile |
Specifies the room profile |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NotLicensedFault | The API is not licensed |
AddRoom
Adds a room.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
room | Room | Room description including room name, room owner and other properties |
Yes |
returnObjectInResponse |
String |
Sends a request to retrieve the object that has been created |
No |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
RoomAlreadyExistsFault | Room already exists |
UpdateRoom
Updates the details of a VidyoPortal room.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
roomID |
EntityID |
This is the ID of addressing room object in the VidyoPortal |
Yes |
room |
Room |
Room description including room name, room owner, and other properties |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
RoomNotFoundFault |
Room not found |
RoomAlreadyExistsFault | Room already exists |
DeleteRoom
Removes a VidyoPortal room.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
roomID |
EntityID |
This is the ID of addressing room object in the VidyoPortal |
Yes |
Response Parameter
Name | Type | Description |
---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
RoomNotFoundFault |
Room not found |
RoomAlreadyExistsFault | Room already exists |
enableRoom
Enables or disables the use of private or public rooms on the VidyoPortal.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
roomID |
EntityID |
The unique room identifier |
Yes |
Enabled |
Boolean |
Specifies whether the room will be enabled (True) or disabled (False) |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
RoomNotFoundFault |
Room not found |
RoomIsEnabled
Retrieves the enabled or disabled status of the private or personal room on the VidyoPortal.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
roomID |
EntityID |
The unique room identifier |
Yes |
Response Parameter
Name | Type | Description |
---|---|---|
Enabled |
Boolean |
Provides the status of the room as enabled (True) or disabled (False) |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
RoomNotFoundFault |
Room not found |
enableScheduledRoom
Enables or disables a Scheduled room in the VidyoPortal.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
extension | String | The room extension on the VidyoPortal |
Yes |
pin | String | The room’s randomly generated PIN. If the room was created with a PIN, this field is mandatory. |
Optional |
enabled | Boolean | Specifies whether the room will be enabled (True) or disabled (False) |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK | String | Acknowledges that the operation was made successfully | Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
RoomNotFoundFault |
Room not found |
ScheduledRoomIsEnabled
Retrieves the enabled or disabled status of the Scheduled room on the VidyoPortal.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
extension | String | The room extension on the VidyoPortal |
Yes |
pin | String | The room’s randomly generated PIN. If the room was created with a PIN, this field is mandatory. |
Optional |
Response Parameter
Name | Type | Description |
---|---|---|
Enabled |
Boolean |
Provides the status of the room as enabled (True) or disabled (False) |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
RoomNotFoundFault |
Room not found |
GetGroups
Retrieves VidyoPortal groups that meet optional search criteria.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
filter.<nnnn> | Filter | The filter type is used to trim down (filter) the search results. The value <nnnn> could be any of or all of the variables below. | Yes |
start |
Integer |
This is the beginning index of the search result. Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the start=30 value. |
No |
limit |
Integer |
This is the number of results that are being requested. Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the limit=10 value. |
No |
sortBy |
String:
|
This is the field by which the requestor is asking the results to be sorted by. Note: In the User API, entityID is used instead of memberID. Example: If the result has to be sorted in an ascending order by the extension number of the Entity, then the requestor provides the sortBy=extension/name/displayName or memeberID value. |
No |
dir |
String
|
This is the field by which the requestor is asking the results to be sorted in a specific direction/order, ascending or descending. Example: If the result has to be sorted in an ascending order by the extension number of the Entity, then the requestor provides the dir=ASC value. |
No |
query |
String:
|
This is the search string that uses all the above filter criteria. Example: If the requestor is looking for all members that start with the letters “pau,” then query=pau would return the desired results. |
No |
Response Parameters
Name | Type | Description | Required |
---|---|---|---|
total |
Integer |
Total number of registered members |
Yes |
group |
Group |
Group Description on the VidyoPortal including group name, max number of members, and other properties |
No |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
GetGroup
Retrieves the details of a VidyoPortal group.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
groupID |
EntityID |
This is an ID for addressing Group object in the VidyoPortal |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
group |
Group |
Group Description on the VidyoPortal including group name, max number of members, and other properties |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
AddGroup
Adds a VidyoPortal group.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
group |
Group |
Group Description on the VidyoPortal including group name, max number of members, and other properties |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
GroupAlreadyExistsFault | Group already exists |
UpdateGroup
Updates a VidyoPortal group.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
groupID |
EntityID |
This is an ID for addressing Group object in the VidyoPortal |
Yes |
group |
Group |
Group Description on the VidyoPortal including groupID, name, roomMaxUsers, userMaxBandWidthIn, userMaxBandWidthOut, description, allowRecording |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
GroupNotFoundFault | Group not found |
DeleteGroup
Deletes a VidyoPortal group.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
groupID |
EntityID |
This is an ID for addressing Group object in the VidyoPortal |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
GroupNotFoundFault | Group not found |
GetParticipants
Lists the participants in a VidyoPortal member's personal room. The entityID must be set to the VidyoPortal member's entityID.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
conference |
EntityID |
This is an ID for addressing the room object in the VidyoPortal where the conference is started |
Yes |
Response Parameters
Name | Type | Description | Required |
---|---|---|---|
Total |
Integer |
Total number of registered members |
Yes |
Entity |
EntityID |
This object is returned as a result of search for member, public room, or legacy device |
No |
LeaveConference
Removes a participant (endpoint) from a conference.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
conferenceID |
EntityID |
This is an ID for addressing the room object in the VidyoPortal where the conference is started |
Yes |
participantID |
EntityID |
This is an ID for addressing a Member object in the VidyoPortal |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
SeatLicenseExpiredFault |
Seat license expired and needs to be renewed |
MuteAudio
Mutes the audio for a given participant (endpoint) in the conference.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
conferenceID |
EntityID |
This is an ID for addressing the room object in the VidyoPortal where the conference is started |
Yes |
participantID |
EntityID |
This is an ID for addressing a Member object in the VidyoPortal |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
UnmuteAudio
Unmutes the audio for a given participant (endpoint) in a conference.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
conferenceID |
EntityID |
This is an ID for addressing the room object in the VidyoPortal where the conference is started |
Yes |
participantID |
EntityID |
This is an ID for addressing a Member object in the VidyoPortal |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
StartVideo
Starts the video for a given participant (endpoint) in a conference.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
conferenceID |
EntityID |
This is an ID for addressing the room object in the VidyoPortal where the conference is started |
Yes |
participantID |
EntityID |
This is an ID for addressing a Member object in the VidyoPortal |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
StopVideo
Stops the video for a given participant (endpoint) in a conference.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
conferenceID |
EntityID |
This is an ID for addressing the room object in the VidyoPortal where the conference is started |
Yes |
participantID |
EntityID |
This is an ID for addressing a Member object in the VidyoPortal |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
CreateRoomURL
Creates an URL for a room or VidyoPortal member's personal room.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
roomID |
EntityID |
This is an ID for addressing the room object in the VidyoPortal |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
RemoveRoomURL
Deletes an URL for a room or VidyoPortal member's personal room.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
roomID |
EntityID |
This is an ID for addressing the room object in the VidyoPortal |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
CreateRoomPIN
Creates a PIN for a room or VidyoPortal member's personal room.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
roomID |
EntityID |
This is an ID for addressing the room object in the VidyoPortal |
Yes |
pin |
String |
Room pin |
No |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
RemoveRoomPIN
Removes a PIN for a room or VidyoPortal member's personal room.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
roomID |
EntityID |
This is an ID for addressing the room object in the VidyoPortal |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
SeatLicenseExpiredFault |
Seat license expired and needs to be renewed |
GetLicenseData
Retrieves the VidyoPortal’s license data.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
(Always Empty) |
N/A |
Use only the HTTP Authentication header |
N/A |
Response Parameters
Name | Type | Description | Required |
---|---|---|---|
Name |
String |
Feature names Ports, Seats, and Installs |
Yes |
MaxValue |
String |
Maximum number of Ports, Seats, and Installs that are licensed |
Yes |
CurrentValue |
String |
Used number of the Ports, Seats, and Installs |
No |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
SeatLicenseExpiredFault |
Seat license expired and needs to be renewed |
createModeratorPIN
Creates a Moderator PIN for a room or a member's personal room.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
roomID |
EntityID |
This is an ID for addressing the room object in the VidyoPortal |
Yes |
pin |
String |
Specifies the Moderator PIN - used for creating and updating an existing PIN |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
InvalidModeratorPINFormatFault | The format of the Moderator PIN is not valid - either not right amount of digits, or invalid characters (PIN should be a 3-10 digit number) |
ControlMeetingFault | The user is not allowed to control the conference (only for User API) |
removeModeratorPIN
Creates a Moderator PIN for a room or a member's personal room.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
roomID |
EntityID |
This is an ID for addressing the room object in the VidyoPortal |
Yes |
pin |
String |
Specifies the Moderator PIN - used for creating and updating an existing PIN |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
ControlMeetingFault | The user is not allowed to control the conference (only for User API) |
GetPortalVersion
Gets the portal version.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
(Always Empty) |
N/A |
Use only the HTTP Authentication header |
N/A |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
SeatLicenseExpiredFault |
Seat license expired and needs to be renewed |
GetLocationTags
Gets the available Location Tags.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
filter.<nnnn> | Filter | The filter type is used to trim down (filter) the search results. The value <nnnn> could be any of or all of the variables below. | Yes |
start |
Integer |
This is the beginning index of the search result. Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the start=30 value. |
No |
limit |
Integer |
This is the number of results that are being requested. Example: If the result has 50 elements, and the requestor only wants 10 element from the 30th position, then the requestor provides the limit=10 value. |
No |
sortBy |
String:
|
This is the field by which the requestor is asking the results to be sorted by. Note: In the User API, entityID is used instead of memberID. Example: If the result has to be sorted in an ascending order by the extension number of the Entity, then the requestor provides the sortBy=extension/name/displayName or memeberID value. |
No |
dir |
String
|
This is the field by which the requestor is asking the results to be sorted in a specific direction/order, ascending or descending. Example: If the result has to be sorted in an ascending order by the extension number of the Entity, then the requestor provides the dir=ASC value. |
No |
query |
String:
|
This is the search string that uses all the above filter criteria. Example: If the requestor is looking for all members that start with the letters “pau,” then query=pau would return the desired results. |
No |
Response Parameters
Response containing available Location Tags.
Name | Type | Description | Required |
---|---|---|---|
total |
Integer |
Total number of entities |
Yes |
location |
Location |
Location tag name |
No |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
ScheduledRoomEnabled
Checks whether the Scheduled Rooms feature is enabled on the tenant level.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
(Always Empty) |
N/A |
Use only the HTTP Authentication header |
N/A |
Response Parameter
Name | Type | Description |
---|---|---|
scheduledRoomEnabled |
Boolean |
Indicates whether the Scheduled Room feature has been disabled on the tenant |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
disableScheduledRoom
Disables the Scheduled Room feature on the tenant per the tenant URL.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
disableScheduledRoom |
Boolean |
Set the Scheduled Room feature on the tenant: '1' | True (disable) '0' | False (enable) |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
cancelOutboundCall
Enables the moderator to cancel an outgoing user invite request.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
conferenceID |
EntityID |
Specifies the conference ID that the moderator is logged in to |
Yes |
entityID |
EntityID |
Indicates that the user that has been invited. User cannot invite an entity that is of type Legacy |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully | Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
SetChatStateAdmin
Sets whether the private and/or public chat options should be enabled or disabled on the tenant. Once disabled, Vidyo clients joining conferences on this VidyoPortal will not be able to engage in a chat conversation.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
setPrivateChatState |
Boolean |
Indicates whether the private chat is enabled (True) or disabled (False) on the tenant. Private chat is enabled by default. |
No |
setPublicChatState |
Boolean |
Indicates whether the public chat is enabled (True) or disabled (False) on the tenant. Public chat is enabled by default. |
No |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
ChatNotAvailableInSuperFault |
Chat was set to "Unavailable" by the Super Admin and therefore the chat states cannot be updated |
startLectureMode
Starts Presenter mode (a.k.a., Lecture mode) on the VidyoPortal and on the endpoints. All endpoints will go into Presenter mode.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
conferenceID |
EntityID |
Conference ID of the conference where the presentation is being held |
Yes |
Response Parameter
Name | Type | Description |
---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
stopLectureMode
Stops Presenter mode (a.k.a., Lecture mode) on the VidyoPortal and on the endpoints. All endpoints will exit Presenter mode.
This method can use the following parameters:
Request Parameter
Name | Type | Description | Required |
---|---|---|---|
conferenceID |
EntityID |
Conference ID of the conference where the presentation is being held |
Yes |
Response Parameter
Name | Type | Description |
---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
GetLectureModeParticipants
Requests to list the participants in a meeting as identified by EntityId (which is similar to GetParticipants but supports Presenter mode instead). To list the participants in a personal room belonging to a Member, the EntityID must be set to the Member.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
conferenceID |
EntityID |
Conference ID of the conference where the presentation is being held |
Yes |
filter.<nnnn> |
Filter |
The filter type is used to trim down (filter) the search results. The value <nnnn> could be any of or all of the variables below. |
No |
Response Parameters
Name | Type | Description |
---|---|---|
total |
Integer |
Number of participants |
recorderID |
Integer |
Recorder ID of the recorder active in the conference |
paused |
Boolean |
Recording status |
webcast |
Boolean |
Is webcast enabled for the conference |
lectureMode |
Boolean |
Is Lecture Mode on for this conference |
LectureMode |
LectureMode |
Object of the participants list |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
LectureModeParticipant is an object with the following parameters:
Name | Type | Description |
---|---|---|
entityID |
EntityID |
Entity ID |
participantID |
EntityID |
Entity ID |
EntityType |
EntityType |
EntityType object. There are three types of entities in VidyoPortal: Member, Room, and Legacy |
displayName |
String |
Display name |
extension |
String |
Extension |
audio |
Boolean |
Indicates whether the audio is muted |
video |
Boolean |
Indicates whether the video is muted |
appshare |
Boolean |
Indicates whether there is a content share |
handRaised |
Boolean |
Indicates whether a hand is raised |
presenter |
Boolean |
Indicates whether the participant is presenting |
DismissRaisedHand
Signals the dismissal of a hand from the moderator to the endpoint that had previously raised a hand.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
conferenceID |
EntityID |
Conference ID of the conference where the presentation is being held |
Yes |
participantID |
EntityID |
Participant ID of the participant who had raised hand that the moderator wishes to dismiss |
Yes |
Response Parameters
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
DismissAllRaisedHand
Dismisses all raised hands from the moderator.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
conferenceID |
EntityID |
Conference ID of the conference where the presentation is being held |
Yes |
Response Parameters
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
SetPresenter
Assigns a presenter to the conference during Presenter mode (a.k.a., Lecture mode).
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
conferenceID |
EntityID |
Conference ID of the conference where the presentation is being held |
Yes |
participantID |
EntityID |
Participant ID of the participant who had raised hand that the moderator wishes to dismiss |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
RemovePresenter
Removes a presenter from the conference during Presenter mode (a.k.a., Lecture mode).
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
conferenceID |
EntityID |
Conference ID of the conference where the presentation is being held |
Yes |
participantID |
EntityID |
Participant ID of the participant who had raised hand that the moderator wishes to dismiss |
Yes |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully | Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
SetTenantRoomAttributes
Sets the room attributes listed below and decides on the desired behavior for Presenter mode and Waiting Room for all the rooms on that tenant. These settings cannot be overridden by normal users.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
setWaitingRoomState |
Integer |
Indicates whether Waiting Room is:
The request parameter is optional, and no change will take place if a value is not provided. |
No |
supportedClientsOnly |
Boolean |
Specifies whether endpoints that do not support Presenter and Waiting Room modes cannot join the meeting (True) or are allowed in (False). The request parameter is optional, and no change will take place if a value is not provided. |
No |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
createPublicRoom
Allows an admin to create a public room for a particular user by specifying the Display Name. Auto-generates the Room Name and Extension, and enforces limitations on the number of public rooms that a User, Tenant, and Portal can create.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
displayName |
string |
Display name of the public room |
Yes |
ownerName |
string |
Owner name of the public room |
Yes |
setInMyContacts |
boolean |
Specifies whether to add the public room to contact list |
No |
setLocked |
boolean |
Indicates whether the public room is locked |
No |
setPIN |
string |
Indicates whether the public room is pinned |
No |
description |
string |
Description of the public room |
No |
Response Parameters
Name | Type | Description | Required |
---|---|---|---|
roomID |
EntityID |
EntityID of the newly created public room |
Yes |
extension |
string |
Extension of the public room. |
Yes |
roomURL |
anyURI |
URL for the public room. |
Yes |
inMyContacts |
boolean |
Indicates whether public room is in contact list |
No |
locked |
boolean |
Indicates whether public room is locked |
No |
hasPIN |
boolean |
Indicates whether public room has a PIN |
No |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
NotAllowedToCreateFault | Not authorized to create public room |
PublicRoomCreationFault | Failed to create a public room |
createScheduledRoom
Creates an ad-hoc conference room. Allows for specifying between 1 and 400 unused days after which the room will be garbage collected in the system. When specifying 0, the VidyoPortal currently auto-selects 100 days by default. As part of the response, the user receives a unique room link or extension and PIN to access this room.
The maximum number of scheduled rooms per user is 65K. Therefore, careful planning of room owner assignments is recommended.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
displayName |
string |
Display name of the public room |
Yes |
recurring |
Integer |
Unused days after which the room will be garbage collected |
Optional |
setPIN |
Boolean |
The room will be generated with a PIN |
Optional |
moderatorPIN |
String |
Specifies the Moderator PIN for the newly created room |
Optional |
Response Parameters
Name | Type | Description |
---|---|---|
extension |
String |
The room’s unique ID |
pin |
String |
The room’s randomly generated PIN |
inviteContent |
String |
Content of the invite text (will include the room URL, PIN, and extension) |
roomURL |
String |
The room’s URL |
inviteSubject |
String |
The email invitation subject |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault | The arguments that were passed into services were wrong |
InvalidModeratorPINFormat Fault |
Invalid Moderator PIN Fault |
ScheduledRoomCreationFault | Scheduled Room Creation Fault |
TransferParticipantRequest
Transfers a participant (identified by participantID) from their current conference to another conference (identified by conferenceID) with an optional PIN (roomPIN). If the destination conference is PIN-protected, the correct PIN must be provided.
This API only supports participants that are legacy endpoints connected via the VidyoGateway.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
participantID |
EntityID |
The participant to be transferred |
Yes |
conferenceID |
EntityID |
The destination conference |
Yes |
roomPIN |
String |
The PIN for the destination conference |
No |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | VidyoPortal is unable to communicate with the VidyoGateway |
NotLicensedFault |
The API is not licensed |
InvalidArgumentFault |
|
setLayout
Sets the display layout to Gallery View, Active Speaker, or Continuous Presence.
This API only supports participants that are legacy endpoints connected via the VidyoGateway.
This method can use the following parameters:
Request Parameters
Name | Type | Description | Required |
---|---|---|---|
participantID |
EntityID |
Obtained from getParticipants |
Yes |
layout |
String |
Not validated by the VidyoPortal. Valid choices include:
|
No |
maxParticipants |
Integer |
Not validated by the VidyoPortal. Valid choices include integers from 1 through 8. |
No |
Response Parameter
Name | Type | Description | Required |
---|---|---|---|
OK |
String |
Acknowledges that the operation was made successfully |
Yes |
Faults
Name | Description |
---|---|
GeneralFault | An unspecified error occurred |
InvalidArgumentFault | The arguments that were passed into services were wrong |
Comments
0 comments
Please sign in to leave a comment.