Home Page > Integration > SOAP API

SOAP API

API Update

We encourage all clients to use our REST API. While the legacy SOAP API still works, you will gain much more functionality (file upload, for example) and flexibility with the REST API. All API development moving forward will be on the REST API. 

SOAP APIs

Our APIs for pushing data into OpenAsset are accessed using SOAP, a standard pioneered by Microsoft. SOAP is a language independent way for two programs to communicate, often across a network. SOAP actually uses XML as the underlying format for transporting information, but it is not necessary to deal with the XML directly. All of the common languages have simple ways of working with SOAP, including .Net Java PHP and Perl. Example API usage code (PHP/VB/C# and Perl) can be downloaded here.
 

Projects

With the Projects SOAP API you can insert new projects using a code and name, and optionally set aliases for the project.

SOAP Procedure Calls

  • retrieveProject(  projectCode  )
Returns a data structure is returned for a single project containing:
 
code String
name String
codeAlias1 String
codeAlias2  String
nameAlias1 String
nameAlias2 String
enabled Integer 0 or 1

 

  • retrieveAllProjects(  )
Returns a data structure is returned for all projects in OpenAsset containing the fields described in retrieveProject(projectCode)
  • addNewProject(  projectCode,  name  )
  • renameProject (  projectCode,  name  )
  • setCodeAlias1(  projectCode,  codeAlias1  )
  • setCodeAlias2(  projectCode,  codeAlias2  )
  • setNameAlias1(  projectCode,  nameAlias1  )
  • setNameAlias2(  projectCode,  nameAlias2  )
  • setEnabled(  projectCode, enabled  ) 

Project Keywords

If you have a database or system that holds information about your projects, you can use the ProjectKeywords API to automatically import this data into OpenAsset. e.g. if you have a housing project, you could attach a keyword of Sector:Residential to it via the API. All files in the project would then have this keyword automatically applied.
 
Using the ProjectKeywords API you are able to:
  • Download all the project keywords in OpenAsset
  • Download the keywords for a particular project
  • Create and rename project keywords
  • Attach project keywords to projects
 

SOAP Procedure Calls

  • retrieveProjectKeywords(  projectCode  )
  • retrieveAllProjectKeywords(  )
  • setProjectKeywords( projectCode, categoryId[], keywordId[] ) 
If the keywords specified in keywordId are exactly the same as those already attached to the project it would do nothing. It won't delete them all and add them all back. It will remove any keywords attached to the project if the keywords are in the keyword categories in categoryId but aren't included in the list of keywords in keyword. It will attach any keywords in keywordId that aren't already attached to the project, as long as the keywords are in the keyword categories in category. 
  • attachProjectKeyword(  projectCode,  keywordId  )
  • removeProjectKeyword(  projectCode,  keywordId  )
  • moveProjectKeyword(  keywordId,  categoryId  )
  • renameProjectKeyword(  keywordId,  keywordName  )
  • renameProjectKeywordCategory( categoryId, categoryName  )
  • createProjectKeyword(  categoryId,  keywordName  )
  • createProjectKeywordCategory(  categoryName  )

Project Fields

If you have a database or system that holds information about your projects, you can use the ProjectFields API to automatically import this data into OpenAsset.
e.g. if you have a housing project, you could attach a short description of the project to it via the API. 
 
Using the ProjectFields API you are able to:
  • Download all the project fields defined in OpenAsset
  • Download the field values for a set of projects
  • Update the field values for a set of projects

SOAP Procedure Calls

  • retrieveProjectFields(  projectCode[]  )
  • retrieveAllProjectFields(  )
  • setProjectField( projectCode[], fieldCode, value[] )
Although this method takes an array of values for a field, OpenAsset currently only supports a single values for each field. Therefore, an array of length 1 should always be passed.
 

Images

With the Images SOAP API you can retrieve or set file information for a group of files using the filenames.
 
The methods below operate on an Array of filenames, and thus can be applied to more than one file at a time.

SOAP Procedure Calls

  • retrieveImages ( filename[] ) 
  • setPhotographer ( filename[], photographer ) 
  • setCopyrightHolder ( filename[], copyrightHolder ) 
  • setCaption ( filename[], caption ) 
  • setDescription ( filename[], description ) 
Last modified
06:39, 27 Apr 2017

Tags

Classifications

This page has no classifications.