Date | Status | Changes | Marked | By |
|---|---|---|---|---|
| 29 MAY 2014 | To be reviewed | Created from previous Xwiki document | --- | Choksi |
| Table of Contents | ||||
|---|---|---|---|---|
|
General
...
Mandatory input for each operation
- Credeintials Credentials - Web Service Client User authentication credentials
- extendedSettings - Extended Settings such as response format.
...
- DefaultServiceResponse JavaBean container which stores the specific bean response for Web Services operation
- While creating an entity, values for fields such as Row ID (Unique system generated), Entity ID (System generated )should not be entered as input parameter values.
- While updating an entity, values for fields that already contain a Read only value should not be entered as input parameter values.
getSupportGroup
...
Id: 104
Returns an excerpt pertaining to the specified the support group.
Input Parameters
supportGroupId - Support Group Id for which details should be fetched fetched.
Output
Description, Disable Service Feedbacks, Group ID, Group Name, Organization ID, Refresh Table Every(Mins), Status, Sub Type, Type, Used For, View Organization Tickets.
listSupportGroups
...
Id: 105
Returns the list of all the active support groups matching the specified search criteria.
Input Parameters
searchText - String to match the Support Group Name, Type, Description etc.
Output
Description, Group ID, Group Name
addSupportGroup
...
Id: 218
Adds a support group with the specified group information.
Input Parameters
Group Name, Description, Group Email, Group Phone, Refresh Table Every(Mins), Disable Service Feedbacks, Type, Sub Type, Next Escalation Group Name, Next Escalation Group ID, View Organization Tickets, Used for,
Output
Row ID
updateSupportGroup
...
Id: 219
Updates an existing support group identified by the Row ID.
Input Parameters
Group Name, Description, Group Email, Group Phone, Refresh Table Every(Mins), Disable Service Feedbacks, Type, Sub Type, Next Escalation Group Name, Next Escalation Group ID, View Organization Tickets, Used for,
Output
Row Id
setSupportGroupStatus
...
Id: 220
Sets/updates the status of the existing support group i.e. marks the support group as either Active or Inactive.
Input Parameters
Group ID, Support Group Status
Output
None
listMembers
...
Id: 221
Returns a list of all contact members associated with specified Support Group identified by Row ID.
Input Parameters
Group Id
Output
Contact, Primary Group, Group Lead, Primary Group, Status
addMember
...
Id: 222
Adds specified contact identified by either the Row ID as member of specified Support Group identified by the Row ID.
Input Parameters
Group Id, Member Id
Output
None
removeMember
...
Id: 223
Removes a specified contact member identified by Row ID for the specified Support Group identified by the Row ID.
Input Parameters
Group Id, Member Id
Output
None
setGroupLeadStatus
...
Id: 224
Sets specified contact member identified by Row ID as a group lead for the specified Support Group identified by Row ID.
Input Parameters
Group ID, Member ID, Group Lead (??)
Output
None
listServiceAvailability
...
Id:225
Returns a list of all service availability schedule (timeslip) information related to the specified Support Group identified by Row ID.
Input Parameters
Group Id
Output
Schedule ID, Holiday List, rel_state, Status, End Date, End Time, Start Date, Start Time, Time Zone Id, Time Zone, Days of the Week
addAvailabilitySchedule
Id: 226
Adds service availability schedule (timeslip) information related to the specified Support Group identified by Row ID.
Input Parameters
Group ID, Start On, Start Time (Hrs,Min,Sec AM/PM), End By, End time (Hrs,Min,Sec AM/PM), Using this Time Zone (ID), Using this Time Zone (Name), Repeat On, Holiday List (Name), Holiday list (ID),
Output
Schedule Id ??
updateAvailabilitySchedule
Id: 227
Updates an existing service availability schedule (timeslip) information related to the specified Support Group identified by Row ID.
Input Parameters
Group ID, Schedule Id, Start On, Start Time (Hrs,Min,Sec AM/PM), End By, End time (Hrs,Min,Sec AM/PM), Using this Time Zone (ID), Using this Time Zone (Name), Repeat On, Holiday List (Name), Holiday list (ID),
Output
Schedule Id??
deleteAvailabilitySchedule
...
Id: 228
Deletes an existing service availability schedule (timeslip) information related to the specified Support Group identified by Row ID.
Input Parameters
Group Id, Schedule Id
Output
None
listLocation
...
Id: 260
Returns a list of all the active Organization (Organization-Site-Location) for the specified Support Group identified by Row ID.
Input Parameters
Group Id
Output
Address, Building, Organization, Floor, Relationship, Group Lead, IS PRIMARY?, Group Organization Relation ID, Organization ID, Status, Site, Suite
addLocation
...
Id: 261
Adds a new active Organization (Organization-Site-Location) for the specified Support Group identified by Row ID.
Input Parameters
Group ID, Relationship, Organization ID, Site ID, Location ID ID
Output
org_group_rel_id
updateLocation
Id: 262
Updates an existing Organization (Organization-Site-Location) for the specified Support Group identified by Row ID.
Input Parameters
Group ID, Group Organization Relation ID, Relationship, Organization ID, Site ID, Location ID
Output
org_group_rel_id
unrelateLocation
...
Id: 263
Unrelates an existing Organization (Organization-Site-Location) for the specified Support Group identified by Row ID.
Input Parameters
Group ID, Group Organization Relation ID
Output
None
setPrimaryLocationStatus
Id: 264
Marks an existing Organization (Organization-Site-Location) as primary Organization for the specified support group.
Input Parameters
Group ID, Group Organization Relation ID
Output
None
setPrimaryMember
...
Id: 265
Sets a member as primary member for the support group.
Input Parameters
Group ID, Member ID
Output
None