Organization Web-services

Owned by priti.hota (Deactivated)
Last updated: Sept 20, 2017
4 min read

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

getOrganization

Id: 62 
Returns an excerpt pertaining to the specified the organization.


Input Parameters
organizationId - Organization Id for which details should be fetched.


Output
Account Manager ID, Account Manager, Attachment File Name, Attachment ID, Attachment Name, City, Organization Type, Hierarchical path, Country, Exclude from Surveys, Main Fax, Main Phone, Web URL, Name, rel_attach_id, Status, Status, Row ID,  , State, State Code, Street Address, Support E-Mail, Support Note, Support Phone, Zip Code

listOrganizations

Id: 63 
Returns the list of all the active organizations matching the specified search criteria.


Input Parameters
searchText - String to match the Organization Name, building, address, city, zip code, country etc. 


Output
ID, Name, Address, Main Fax, Main Phone, Web URL

addOrganization

Id: 186  
Adds a new organization with the supplied company profile information.


Input Parameters
organization - Organization Bean containing details which must be used to create the Organization
Name(mandatory), Organization Type, Web URL, Street Address, City, State Code, State, Zip Code, Main Phone Number, Main Fax Number, Country Code, Country,Account Manager ID, Support Note, Support Phone Number, Support Email, Exclude from Surveys, Timezone id, Holiday Id, Parent Organization Id.


Output  
org_id

updateOrganization

Id: 187 
Updates an existing organization profile identified by the Organization Row ID.


Input Parameters
organization - Organization Bean containing details which must be used to update the Organization Organization ID(mandatory), Name, Organization Type, Web URL, Street Address, City, State Code, State, Zip Code, Main Phone Number, Main Fax Number, Country Code, Country,Account Manager ID, Support Note, Support Phone Number, Support Email, Exclude from Surveys, Timezone id, Holiday Id

Output  
org_id

relateOrganizationIcon

Id: 188 
Relates the logo (ideogram) image file (graphic) identified by the Row ID with the specified organization that represents an organization visually in public.


Input Parameters
orgID - Row ID for organization
logoImageID - ID of the attachment that should be related to organization its logo.


Output
rel_attach_id

unrelateOrganizationIcon

Id: 189
Unrelates or removes the relationship for the logo (ideogram) image file (graphic) identified by the Row ID from the associated organization.


Input Parameters
orgID - Row ID for organization


Output 
None

setOrganizationStatus

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


Input Parameters
orgID - Row ID for organization
status - New status (Active/Inactive) of the organization


Output
None - If set to Inactive
org_id - if set to Active

addNote

Id: 198 
Adds a new special note for the specified organization.


Input Parameters
orgID - Row ID for Organization.
relationshipState - Relationship State of the note.
noteDescription - Note which should be added to the organization. 


Output 
note_id

updateNote

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


Input Parameters
noteID - Row ID for the note.
relationshipState - Relationship State of the note.
noteDescription - Updated note text.

 
Output 
note_id

deleteNote

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


Input Parameters
orgID - Row ID for Organization.
noteID - Row ID for the note that should be deleted


Output   
None

relateAttachment

Id: 201
Relates/associates an existing attachment document to the specified organization.


Input Parameters
orgID - Row ID for Organization.
attachmentID - Attachment Id which needs to be related to Organization. 


Output 
rel_attach_id

unrelateAttachment

Id: 202   
Unrelates or removes the relationship for an attachment document from its parent organization.


Input Parameters
Org row id - Row ID for Organization
attachmentID - Attachment Id which needs to be un-related from Organization.


Output 
None

relateContact

ID: 203   
Relates/associates an existing Contact identified by the Row ID to the Organization.


Input Parameters
Org Row Id- Row ID for Organization
Relationship -
Contact row Id - Row Id for Contact to be related to the Organization.


Output 
None

unrelateContact

Id: 204 
Unrelates or removes the contact relationship Contact ID from its parent organization for the specified Contact Row ID.


Input Parameters
orgID - Row ID for Organization.
Contact Row Id - Row Id for Contact to be un-related from the Organization


Output 
None

getNote

Id: 210  
Returns special note details pertaining to an organization identified by the Note.


Input Parameters
noteID - Row ID for note.

 
Output 
Created By, Created Date, Modified By, Modified Date, Organization ID, Relationship State, Special Note

listNotes

Id: 211 
Returns a list of all the special notes pertaining to an organization.


Input Parameters
orgID - Row ID for Organization.
searchText - String to match the Created By, Modified By, Note Description and Relationship State. 


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

listAttachments

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


Input Parameters
orgID - Row ID for Organization


Output 
Created Date, Description, Attachment File Name, Type, Is Global, Attachment Name, Created By, Attachment ID] 

listRelatedContacts

Id: 213 
Returns a list of all the contact persons associated with the specified Organization.


Input Parameters
orgID - Row ID for the organization


Output 
Contact ID, Contact, Relationship

listSupportGroups

Id: 272 
Returns a list of all the support group for the specified organization.


Input Parameters
orgID - Row ID for the organization


Output 
Group, Relationship, is_primary, Primary Oganization

relateSupportGroup

Id:273 
Relates a new active support group for the specified organization.


Input Parameters
Org Row Id - Row Id for Organization
Group Row Id- Row ID for Group to be related to Organization
Relationship - Relationship of Group with Organization


Output
None 

unrelateSupportGroup

Id: 274
Unrelates or removes the relationship with an existing support group identified by the Row ID from the specified organization.


Input Parameters
Org Row Id - Row Id for Organization
Group Row Id- Row ID for Group to be un-related from Organization


Output 
None

setPrimaryOrganization

Id: 275
Marks an existing support group as primary support group for the specified Organization.


Input Parameters
Org Row Id -Row Id for Organization
Group Id - Row Id of Related group for which the Organization is to be the primary organization.


Output 
None

© 2019 Serviceaide 1-650-206-8988 http://www.serviceaide.com info@serviceaide.com