General

Mandatory input for each operation

• Credentials - Web Service Client User authentication credentials
• extendedSettings - Extended Settings such as response format.

Each Operation returns -

• DefaultServiceResponse JavaBean container which stores the specific bean response for Web Services operation

Notes:

• 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.

getContact

Id: 33
Returns an excerpt pertaining to the specified the contact.

Input Parameters
Contact Id

Output
Business Segment, Time Zone, Contractor Contact ID, Contractor, Created By Contact ID, Created By, Created On, Department, Deputy/Alternate Contact ID, Deputy/Delegate, Email, Employee ID, End Date, Disable Service Feedbacks, First Name, HR Generalist Contact ID, HR Generalist, Enable Login, Job Title, Last Name, Office/Cube, Managed Entity, managed_entity, managed_function, Manager Contact ID, Manager, Middle Name, Modified By Contact ID, Modified By, Modified On, Title, Notification Mechanism, org_id, Details, Out of Office, Pager Email Address, Pager Type, Phone Type 1, Phone Type 2, Phone Type 3, Phone Type 4, phone1, phone2, phone3, phone4, Pin #, Status, Row ID, Start Date, User ID,  License Type, System User ID, VIP, 

listContacts

Id: 34
Returns the list of all the active contacts matching the specified search criteria.

Input Parameters
Search Text

Output
Email, Full Name, Job Title, Phone Details, Phone Number, ID

addContact

Id: 215
Adds a new contact with the supplied contact profile information.

Input Parameters
Title, First Name, Middle Name, Last Name, Email, Job Title, Department, Location, Pin, Timezone ID, TimezoneName, ocale, Locale ID, Is a VIP, Phone Number (1) Type, Phone Number (1), Phone Number (2) Type, Phone Number (2), Phone Number (3) Type, Phone Number (3), Phone Number (4) Type, Phone Number (4)

Output
Row Id

updateContact

Id: 216
Updates an existing contact profile identified by the Contact Row ID.

Input Parameters
Contact Id, Title, First Name, Middle Name, Last Name, Email, Job Title, Department, Location, Pin, Timezone ID, TimezoneName, ocale, Locale ID, Is a VIP, Phone Number (1) Type, Phone Number (1), Phone Number (2) Type, Phone Number (2), hone Number (3) Type, Phone Number (3), Phone Number (4) Type, Phone Number (4)

Output
Row Id

setContactStatus

Id: 217
Sets/updates the status of the existing contact i.e. marks the contact as either Active or Inactive. 

Input Parameters
Contact Id, Contact Status

Output
None

addLocation

Id: 230
Adds a new active Organization (Organization-Site-Location) for the specified Contact.

Input Parameters
Contact Id, Relationship. Organization Id, Site Id, Location Id

Output
contact_org_rel_id

listLocation

Id: 231
Returns a list of all the active Organization (Organization-Site-Location) for the specified Contact.

Input Parameters
Contact Id

Output
Address, Building, Contact Location ID, Floor, Organization, Organization ID, Primary Organization,Relationship, Site,Status,Suite

updateLocation

Id: 232
Updates an existing Organization (Organization-Site-Location) for the specified Contact.

Input Parameters
Contact ID, Contact_org_rel_id, Relationship, Organization ID, Site ID, Location ID

Output
contact_org_rel_id

unrelateLocation

Id: 233
Unrelates an existing Organization (Organization-Site-Location) for the specified Contact.

Input Parameters
Contact Id, Relationship. Organization Id, Site Id, Location Id, Contact_org_rel_id.

Output
None

listOpenItems

Id: 234
Returns a list of all the open support requests (tickets) that are related to the  specified Contact.

Input Parameters
Contact Id

Output
Case ID, Description, Reason Code, Row ID, Status, Type, ticket_type

setPrimaryLocationStatus

Id: 235
Marks an existing Organization (Organization-Site-Location) as primary Organization for the specified Contact.

Input Parameters
Contact Id, Contact_org_rel_id

Output
None

resetPassword

Id: 236
Resets the User password for the specified Contact.

Input Parameters
Contact Id

Output
None

addSupportGroup

Id: 237
Relates/associates an existing Support Group identified by the Row ID to the specified Contact.

Input Parameters
Contact Id, Support Group Id

Output
None

addRole

Id: 238
Relates/associates an existing Role identified by the Row ID to the specified Contact.

Input Parameters
Contact Id, Role Id

Output
None

setPrimaryGroupStatus

Id: 239
Sets a group as primary group for the contact.

Input Parameters
Contact Id, Support Group Id

Output
None

removeSupportGroup

Id: 240
Unrelates or removes the relationship with an existing Support Group identified by the Row ID from the specified Contact.

Input Parameters
Contact Id, Support Group Id

Output
None

removeRole

Id: 241
Unrelates or removes the relationship with an existing Role identified by the Row ID from the specified Contact.

Input Parameters
Contact Id, Role Id

Output
None

listNotes

Id: 242
Returns a list of all the special notes pertaining to a Contact.

Input Parameters
Contact Id

Output
Created By, Created Date, Modified By, Modified Date, Note, Row ID, State

listAttachments

Id: 243
Returns a list of all the related attachment document(s) pertaining to the specified Contact.

Input Parameters
Contact Id

Output
Created By, Created Date, Description, Row ID, Type, attach_file_name, attach_is_global

getNote

Id: 244
Retrieves note specified by row_id associated with the contact.

Input Parameters
Contact Id, Note Id

Output
Contact Id, Created By, Created Date, Modified By, Modified Date, Note, Row ID, State

addNote

Id: 245
Adds a new special note for the specified contact.

Input Parameters
Contact Id, Relationship State, Note

Output
Note Id

updateNote

Id: 246
Updates an existing special note identified by the Row ID associated with the specified contact.

Input Parameters
Contact ID, Note ID, Relationship State, Note

Output
Note Id

deleteNote

Id: 247
Deletes an existing special note identified by the Row ID associated with the specified contact.

Input Parameters
Contact Id, Note Id

Output
None

unrelateAttachment

Id: 248
Unrelates/dissociates an existing attachment document from the specified contact.

Input Parameters
Contact Id, Attachment Id

Output
None

relateAttachment

Id: 249
Relates/associates an existing attachment document to the specified contact.

Input Parameters
Contact Id, Attachment Id

Output
rel_attach_id

listRelatedCI

Id: 250
Returns a list of all the configuration items associated with the specified contact.

Input Parameters
Contact Id

Output
CI Name, Function, Identifier,Status, Class, category. Attribute 1, Attribute 2, Attribute 3

listDependentData

Id: 251
Returns a list of all the dependent data associated with the contact.

Input Parameters
Contact Id

Output
Entry Name, Description, Action On Termination, Count

updateUserLoginDetails

Id: 252
Updates user_login details, license type and disable service feedbacks for the specified contact.

Input Parameters
Contact ID, Login Enabled, User Login, License Type

Output
Row Id

listRoles

Id: 253
Returns a list of all the roles that are related to the specified Contact.

Input Parameters
Contact Id

Output
Primary Group, Role, Row ID

listSupportGroups

Id: 254
Returns a list of all the support group that are related to the specified Contact.

Input Parameters
Contact Id

Output
Primary Group,Row ID, Support Group