isave.API
These methods are for interacting with isave.DIALOG. Note that every method expects a username and encrypted password. Contact Isave for validation procedures!
The following operations are supported. For a formal definition, please review the Service Description.
-
AddContactToDatalist
Adds a contact to a datalist -
ChangeStock
Updates Stockinfo and amount -
CreateArticleElement
Inserts ArticleElement -
CreateCustomOutputOnElement
Creates output based on custom job for an already created element, the element must contain FormsInfo, returns path to generated files -
CreateElement
Inserts an element and returns ElementID (If keep = 1 or empty, the element and files will not be deleted after 14 days, ie NO will delete the element immediately -
CreateElementForContactAndGenerateOutput
Inserts an element and returns a path to a generated PDF -
CreateOutputOnElement
Creates output on already created element, the element must contain FormsInfo, returns path to generated files -
DeleteAddressByAddressID
Delete Address by AddressID -
DeleteContactsByDataListID
Deletes a Datalist and all contacts in this Datalist -
DeleteDatalistContactByExtPersonNumber
Delete DatalistContact from all lists with your PersonReference -
DeleteDatalistContactByPersonID
Delete DatalistContact from all lists with PersonID -
DeleteElementByElementID
Delete element by ElementID -
DeleteFolder
Delete a folder -
DeleteFolderByCompanyID
Delete a folder by companyid -
DeleteFromShoppingbasket
Deletes element(s) in Persons shoppingbasket, if ElementID = 0, all elements in Shoppingbasket will be deleted -
DeleteGroupByGroupID
Delete Group by GroupID -
DeleteOrderBYOrderID
Delete Order by OrderID -
DeleteOrderBYSupplierOrderID
Delete Order by SupplierOrderID -
DeleteOrderLineBySequence
Delete Orderline by sequence -
DisableDatalistContactByPersonID
Stops all communication with datalist contact (but keeps history) -
DoActivitiesByActivityID
Runs all jobs below one activity -
DoActivityByActionID
Creates an Activity job for a particular Action -
EDMNewsletterTrackBack
EDM TrackBack -
GetActions
Returns a list of your Activity Actions -
GetActivities
Returns a list of your Activities -
GetAddressByPersonID
Returns address by PersonID -
GetAddresses
Returns a list of your company's registered addresses -
GetAddressesByExtCompanyNumber
Returns a list of your company's registered addresses -
GetAgentCompanies
Returns a list of Companies registered under your company(agent) -
GetAgentCompaniesByExtCompanyNumber
Returns a Companies registered under your company(agent) by ExtCompanyNumber, Must be called from Agent API account -
GetAllStaticElements
Returns all static elements -
GetAllTemplateFields
Returns all active Templatefields on single template -
GetArticlesForOrder
Returns a list of Articles connected to elements in order -
GetAttachementFilesFromFTP
Uploads attachement files from ftp folder to Isave (ftpAddress example : ftp://x.x.x.x/tmp/images/) can be a zip file (isZip = true). An Email with status can be sent to emailadress in 'StatusEmailAddress' paramter, you can also set a 'Session' string to identify which process that failed (If you are uploading several files). Filenames must always be unique! -
GetAttachementFilesFromSFTP
Uploads attachement files from sftp server to Isave (sftpAddress = IP address), Foldername format 'bigcompany/files/images/', Filenames must always be unique!, can be a zip file (isZip = true) -
GetCompanyDataFields
Returns a list of your company data fields -
GetCompanyDataFieldsUsingExtCompanyNumber
Returns a list of your company data fields - using ExtCompanyNumber -
GetContactByContactID
Returns one contact -
GetContactByExtContactNumber
Returns a contact -
GetContactIDByEDMGuid
Get contactid for a specific EDMGUID -
GetContacts
Returns a list of your datalist contacts -
GetContactsByDatalistID
Returns a contact -
GetContactsByEMail
Returns a list of your datalist contacts with matching EMail -
GetContactsByExtGroupNumber
Returns a list of your datalist contacts with your GroupReference -
GetContactsByExtPersonNumber
Returns a list of your datalist contacts with your PersonReference -
GetContactsByMobile
Get contacts by Mobilenumber -
GetContactsByNewsletterID
Get a list recipients for a given newsletter -
GetContactsBySpecFieldValues
Returns contact(s) that matches Specfieldname AND SpecFieldValue -
GetContactsFromSFTP
Downloads file with contacts from (s)ftp server to isave.DIALOG (sftpAddress = IP address), Foldername (on sftp server, if located on root set foldername=NULL) format 'bigcompany/files/images/', Filename must always be unique and end with .csv/txt, unless if its a zip file (isZip = true, can only contain one file with .csv extention). ListName in isave.DIALOG will be the same as fileName. Delete = true : deletes file from sftp after download. Set DatalistID = 0 if you want a new datalist to be created, UpdateColumn : 1 = Email, 2 = ExtContactNumber -
GetContactsWithContactIDGreaterThan
Returns a list of your datalist contacts -
GetDatalists
Returns a list of your datalists -
GetDatalistsByContactID
Returns all datalists connected to a Contact -
GetDatalistsByExtReference
Returns a list of your datalists -
GetDemographicDataFields
Returns a list of your demographic data fields -
GetEDMArticles
Returns EDMArticles for a specific Element with a specific Module -
GetEDMLogByID
Returns an EDMLog record for a specific id -
GetEDMLogsByNewsletterID
Returns a list of edmlog records for a specific newsletterid. Use to get all recipients for a newsletter -
GetElementAccessByPersonID
Returns elements connected to user in -
GetElementByElementID
Returns an Element by ElementID -
GetElementByExtElementNumber
Returns an Element with your ExtElementNumber -
GetElementIDsBySpecFieldIDAndSpecFieldValue
Returns ElementSpecFieldValues -
GetElementSpecFieldValues
Returns ElementSpecFieldValues -
GetElements
Returns a list of company Elements -
GetElementsByCompanyID
Returns Folders With SpecFieldValues -
GetElementsByFolderID
Returns all elements in a folder -
GetElementsByTemplateFieldID
Returns Elements in selected folder behind image Templatefield -
GetElementsInFolder
Returns a list of elements in a folder -
GetFileFromFTP
Uploads attachement to ftp server, call this metod and the file will be downloaded and available within Isave.DIALOG, returns new elementID (ftpAddress = IPAddress, If elementID = 0, something went wrong (Only preview and hires will be available) -
GetFileFromFTP2
Uploads attachement to ftp server, call this metod and the file will be downloaded and available within Isave.DIALOG, returns new elementID (ftpAddress = IPAddress, If elementID = 0, something went wrong -
GetFolderPreview
Returns the path to the folder preview -
GetFoldersByCompanyID
Returns Folders With SpecFieldValues -
GetFoldersByMenuTypeID
GetFolderByMenuTypeID -- > MenuTypeID 1 = Print, MenuTypeID 3 = Ads, MenuTypeID 4 = Files, MenuTypeID 10 = eDM, MenuTypeID 11 = Forms/PURL, MenuTypeID 12 = Contacts -
GetFoldersByParentFolderID
Returns a list of Folders by Parent FolderID AND CompanyID -
GetFoldersInFiles
Returns a list of the folders under FILES -
GetGroupByExtGroupNumber
Returns a list of groups by ExtGroupNumber -
GetGroupByGroupID
Returns a group with given groupid -
GetGroups
Returns a list of your company's registered groups -
GetGroupsByCompanyID
Returns a list of groups by ActiveCompanyID -
GetImageUploadLink
Returns a link for use in an iframe, for uploading images to a templatefield -
GetNewsletterByNewsletterID
Returns one contact -
GetNotTransferredBounce
Returns a list of bouncedata that's not been tranferred. Use UpdateBounceToTransferred to prevent getting the same data again -
GetNotTransferredEdmOptOut
Returns a list of all (not earlier) unsubscribed Email -
GetNotTransferredNewsletterLogData
Returns log data from sent nerwsletters as XML string -
GetNotTransferredNewsletters
Returns a list of newsletters that's not been tranferred. Use UpdateNewsletterToTransferred to prevent getting the same newsletters -
GetNotTransferredOpenedNewsletters
Returns a list of opened newsletters that's not been tranferred. Use UpdateOpenedNewsletterToTransferred to prevent getting the same newsletters -
GetNotTransferredOrders
Returns a list of orders not marked with transferred -
GetNotTransferredSMSOptOut
Returns a list of all (not earlier) unsubscribed SMS -
GetNumberOfContactsByDatalistID
Returns the number of cantacts that belongs to a given datalist -
GetOnholdOrders
Returns a list of Orders on hold (Applies to Agents only) -
GetOptOutStatus
Return opt-out status When CompanyID has value opt-out = All list, else if ListID has value opt-out only counts for the current listID -
GetOrdersByCompanyID
Returns a list of Orders by CompanyID -
GetOrdersByCompanyIDAndDate
Returns a list of Orders by CompanyID between dates -
GetOrdersByPersonID
Returns a list of Orders ordered by one Person -
GetPersonByPersonID
Returns a person with given personid -
GetPersonByUserNameCompanyIDAndPassword
Returns a Person by username, password and the persons CompanyID -
GetPersons
Returns a list of your registered persons / web users -
GetPersonsByCompanyID
Returns Persons -
GetPersonsByCompanyIDAndEmail
Returns a Person -
GetPersonsByExtPersonNumber
Returns a person with your person reference -
GetPersonsInGroup
Returns a list of your registered persons / web users for a specific group -
GetPersonsInGroupByExtGroupNumber
Returns a list of your registered persons / web users for a specific group With your Group reference -
GetPriceByElementID
Returns Price(s) by Template ElementID -
GetPriceElements
Returns a list of Elements that can be priced -
GetSMScredits
Returns a available sms credits -
GetShoppingbasketBYPersonID
Returns a Persons ShoppingBasket -
GetSingleSignonLink
Returns a Single signon link (If PersonID is sent, ExtPersonNumber will be ignored) -
GetSingleSignonLinkAndCreateUserOnSpecificCompany
Returns a Single signon link and adds a user in the companyID sent in as parameter (If PersonID is sent, ExtPersonNumber will be ignored) -
GetSingleSignonLinkForNonAgent
Returns a Single signon link - use this if you're not an agent (If PersonID is sent, ExtPersonNumber will be ignored) -
GetSmsLog
Returns a list of your not earlier transferred Sent SmsMessages with stauts -
GetSpecFieldListBYSpecFieldID
Returns specfieldlist -
GetSpecFieldsByCompanyID
Returns Specfields -
GetSpecFieldsForContact
Returns specfields for contactID -
GetStockByElementID
Returns Stock Object -
GetSuppliersByCompanyID
Returns a list of your Suppliers -
GetTemplateElementID
Returns the TemplateElementID for a given element -
GetTemplateElements
Returns all TemplateElement by CompanyID -
GetTemplateFieldDDLValues
Return values for dropdown(type = 3) - checkbox(type = 7) and radiobuttons(type = 8) by TemplateFieldID -
GetTemplateFields
Returns all active Templatefields on single template -
GetTemplateFiles
Returns TemplateFiles by TemplateID -
ImportDatalistContactsFromSftpServer
Imports a csv file of contact from a url (ftp or http) | UpdateColumn: 0 = don't update, 1 = update with match on Email, 2 = Update with match on ExtContactNumber -
InsertAddress
Insert new Address, CompanyID is ID to Company The Address is connected to (DeliveryAddress and InvoiceAddress indicates whether an addresse is delivery = 1 and/ or invoice = 1) -
InsertContact
Inserts a contact to a list : demographicArray syntax = | separates parameters, name:value ie : demographicArray=height:180|haircolor:red|faceshape:oval -
InsertDatalist
Inserts a datalist -
InsertDatalistContact
Inserts a contact and connects it to a datalist - if you supply extContactNumber and the contact already exists, a new contact will NOT be created (data will be updated, fields in incoming object with no values will not delete already registered data) -
InsertDatalistContactNHO
Insert DatalistContact with Demographic data and DatalistID -
InsertDatalistContactNHO2
Insert DatalistContact with Demographic data and DatalistID, if email exists, contact will be updated. When updated and contact must be removed from list to trigger . -
InsertDatalistContactNoCheck
Insert DatalistContact with Demographic data and DatalistID, no check if already existing. -
InsertDatalistContactNoUpdate
Inserts a contact and connects it to a datalist -
InsertDatalistFromCRM
Inserts a CRM datalist -
InsertDatalistFromCRMWithExtReference
Inserts a CRM datalist -
InsertFolder
Insert a folder -- > MenuTypeID 1 = Print, MenuTypeID 3 = Ads, MenuTypeID 4 = Files, MenuTypeID 10 = eDM, MenuTypeID 11 = Forms/PURL, MenuTypeID 12 = Contacts -
InsertFolderByCompanyID
Create new Folder, CompanyID is ID to owner of folder --> MenuTypeID 1 = Print, MenuTypeID 4 = Files, MenuTypeID 10 = eDM, MenuTypeID 11 = Forms/PURL, MenuTypeID 12 = Contacts -
InsertGroup
Insert new Group, CompanyID is ID to Company The Group is connected to -
InsertIntoShoppingBasket
Inserts an element in shoppingbasket -
InsertPerson
Inserts a Person -
InsertSpecField
Inserts a specfield -
MoveElementToFolder
Move an element to another folder -
NewsletterSubscription
Insert DatalistContact -
OptInEDM
Opt-in edm -
OptInSMS
OptIn to SMS communication for this CompanyID. -
OptOutFromEDM
Opt-out from edm communication - OptoutFromAll = true will unsubscribe from all communication for this CompanyID. -
OptOutFromSMS
Opt-out/ unsubscribe from all SMS communication for this CompanyID. -
OrderShoppingbasketByPersonID
Creates Order FROM Elements in Persons shoppingbasket, if OnHold = 1 order will not be sent to supplier until it is updated by updateOnholdOrder -
RemoveContactFromDatalist
Removes a contact from a datalist -
ResendOrder
Resends order to supplier by SupplierOrderID (Not OrderID) -
SendExternalOrder
Sends a mail to the supplier containinng the elementID NB!! The domain in fromAddress (ie : myshop@myshoppingsenter.com) must be validated by Isave!! -
SendNewsletterIDToContact
Sends an already created newsletterID to an existing contact, if CreateCopy is true a new (identic) newsletter will be created -
SendNewsletterToDatalist
Sends a newsletter to selected datalist, returns sent newsletterID, you can specify time newsletter is sent (GMT +1) -
SendSMSToDatalist
Sends a SMS message to selected datalist, returns sent (SMS)newsletterID, you can specify time SMS is sent (GMT +1) -
SetImageFieldFromFTP
Uploads attachement to ftp server, call this metod and the file will be downloaded and available within Isave.DIALOG, returns new elementID (ftpAddress = IPAddress, If elementID = 0, something went wrong (Only preview and hires will be available) -
SetPreviewsForElement
Uploads attachement to ftp server, call this metod and the file will be downloaded and available as preview(s) ont the current ElementID -
UpdateAddressByAddressID
Update address by AddressID (user getAddresses for find AddressID) (Supply CompanyID when you want to change a specifix address for another company your an agent for) (DeliveryAddress and InvoiceAddress indicates whether an addresse is delivery = 1 and/ or invoice = 1) -
UpdateAddressByAddressIDUsingExtCompanyNumber
Update address by AddressID (user getAddresses for find AddressID) (Supply ExtCompanyNumber when you want to change a specifix address for another company your an agent for) (DeliveryAddress and InvoiceAddress indicates whether an addresse is delivery = 1 and/ or invoice = 1) -
UpdateBounceToTransferred
Update bouncedata to Transferred. Prevents it being selected from GetNotTransferredBounce -
UpdateCompanyByCompanyID
Updates Company info (empty fields are ignored) -
UpdateCompanyDataForCompany
Updates company data for a company -
UpdateCompanyDataForCompanyUsingExtCompanyNumber
Updates company data for a company - using ExtCompanyNumber -
UpdateCompanyElement
Updates an Element requires the whole object -
UpdateDatalistContactByExtPersonNumber
Update DatalistContact with your Person reference (If stop = 1 all commmunication with current contact will stop, but history will be kept). Empty or blank values will not overwrite current data. -
UpdateDatalistContactFixedFieldsByContactID
Update DatalistContact by ContactID (If stop = 1 all commmunication with current contact will stop, but history will be kept). Empty or blank values will not overwrite current data. -
UpdateDemographicDataForContact
Updates demographic data for a contact -
UpdateElement
Updates an Element requires the whole object -
UpdateElementByExtElementNumberORElementID
Updates an ElementName and/or ExtElementNumber with your ExtElementNumber or ElementID - set elementID = 0 to update by ExtElementNumber -
UpdateElementFormsInfo
Update FormsInfo on element -
UpdateFolder
Update a folder -
UpdateFolderByCompanyID
Update a folder -
UpdateGroupByGroupIDorExtGroupNumber
Updates Group data either by GroupID or By ExtGroupNumber, CompanyID is ID for Company Group belongs to (empty fields are ignored), GroupID is string here for practical reasons... -
UpdateNewsletterToTransferred
Update a newsletter to Transferred. Prevents it being selected from GetNotTransferredNewsletters -
UpdateOpenedNewsletterToTransferred
Update a opened newsletter to Transferred. Prevents it being selected from GetNotTransferredOpenedNewsletters -
UpdateOrder
Updates order object -
UpdateOrdersToNOTTransferred
Updates orders set to NOT transferred -
UpdateOrdersToTransferred
Updates orders set to transferred -
UpdateOrdersToTransferredBysupplierOrderID
Updates orders set to transferred by supplierOrderID -
UpdatePerson
Update Person - Person must belong to CompanyID. Pass in GroupID to change Group. UserTypeID in the Person object can be 1=user, 2=admin, 5=groupadmin. -
UpdatePrice
Updates Price -
UpdatePriceBySequence
Update Price by Sequence -
UpdateShoppingBasketObject
Updates shoppingbasket object -
UpdateShoppingBasketWithDeliveryInfo
Updates shoppingbasket with delivery info -
UpdateShoppingBasketWithInvoiceInfo
Updates shoppingbasket with Invoice info -
UpdateSpecfieldvaluesForPerson
Updates specfield values for aperson -
UpdateStock
Updates Stockobject -
UpdateStockForCompany
Updates Stockobject -
UploadTmpFile
Upload a File to Isave.DIALOG, returns Isave location and http location separated by semicolon. '1\MyFile.pdf;http://dialog.isave.no/isavefiles/1/TmpFiles/1/MyFile.pdf' -
ValidatePassword
Check Temporary username -
ZipElementArray
Creates Zip file of elements in ElementArray (SimiColon separated), all elements must be connected to logged in company, else they will be ignored. Resolution 0 = Hires, 1 = Preview, returns url for download of Zip file -
getActivityJobsBySequence
Get Specific activityJob -
getCropValues
Gets the cropping values for a specified image field (unique variablename for the template) for an element -
getFilePathsForTemplateFieldConnectedElements
Returns a semicolon separated string, containing paths to elements connected to the templatefield -
getGroupAdminRelationByPersonID
Get All Groups/ departements a person has adminn access to -
getImageVariableDimensions
Get the size for an image varaible - Used together with cropping -
getOrder
Get Order object -
getOutputPath
Returns the path to a generated output for an element -
getOutputPath2
Returns the path to a generated output for an element (added logic if more than one preview) -
insertElementAccess
Inserts access to element for PersonID -
updateCropValues
Sets the cropping values for a specified image field (unique variablename for the template) for an element -
updateExtOrderReference
Update ExtOrderReference -
updateOnholdOrder
Update OnholdOrder -
updateOrderReference
Update OrderReference -
updateStockAmountByElementID
Update StockAmount by ElementID