SOAP Action appendResource

The appendResource action creates and updates resources. Each resource name and internal_id must be unique within a collection otherwise the later resources will update the previous resources. The appendResource action is in general identical to the updateresource action. The only difference is that this action does not remove genes and terms that are currently associated with the resource but not present in the data submitted. This is for use primarily for resources with large numbers of genes or terms.

appendResource Parameters
name The name of the resource. Most characters are allowed. Some HTML tags are allowed but we recommend that you only use <sub> and <sup>. We do not convert {} or <> to superscript. Resource names in a collection must be unique otherwise the the later resources will update the previous resources instead of creating a new resource. For updates this is used as the identifying field.
internal_id The id that you use internally to identify your resource.
internal_url The URL where users can find out more information on this resource. If you have a template_url for the collection this field is optional and the template will be used instead. This field takes precedence over the template URL.
resourcetype The type of the resource. For the current list see here.
collection_name The collection that will contain this resource. The name here must match the name of the collection exactly.
gene_id The NCBI Gene ID of any genes that are associated with the resource. This field is optional and there can an unlimited number of gene_id fields passed in. Most search results are matched via gene id.
pubmed A publication associated to the resource. This consists of two sub elements: pubmed_id which is pubmed's id for the publication and citation which signifies that the publication is a citation of the resource as apposed to a reference.
term_identifier The identifier for an ontology term used to classify the resource. We have several ontologies currently imported via the Ontology Lookup Service. The general format is <symbol>:<term id> (e.g. GO:0061131). This field is optional and there can an unlimited number of term_identifier fields passed in.
description A description of the resource. Most characters are allowed. Some HTML tags are allowed but we recommend that you only use <sub> and <sup>. We do not convert {} or <> to superscript.
internal_create_date The date you created the resource. The format of the date must be in ISO 8601 format, which looks like "2004-02-12T15:19:21+00:00". We maintain dates representing when the resource was originally added to dkCOIN and last modified.
appendResource Result Fields
action The action taken on the resource.
name The name of the resource effected by the action.
internal_id The internal_id that you submitted with the resource.
collection_name The collection_name that the resource is in. This should also match the collection_name that you submitted.
messages Any error messages or notices related to the resource.

It is recommended for now that you do not cache the WSDL locally as it can change often in while we are developing and we have had issues with the new WSDL not replacing the cached version. Also compression should be enabled. For more detailed information you can find the action in the WSDL and the dkcoin.xsd Below are code samples you can view in PHP, C#, Java, or All

The SOAP request will look similar to the following.

The SOAP response will look similar to the following.

If an error occurs a SOAP Fault should be generated and returned to you. The fault will likely throw a similar error that you can catch. Most errors should be handled gracefully but will result in a PHP error dump being returned as the SOAP Fault message. Currently all errors are of code 'Sender'. The actor, detail, name, and header values of the error are currently set as their field names until we decide what to populate in those values.