ACP List Download - ABO

Back Office Integration Guide

Product
ABO
AFS_Version
7.9
Category
Reference Guides
language
English

This API returns the list of ACP available for a given instance. For more information, see AFS Back Office User Guide.

An "ACP List Download" API request takes the following form:

http://$HOST/bo-ws/service/$SERVICE_ID/instance/$SERVICE_STATUS/acp?afs:login=login://$USER:$PASSWORD@$AUTHENTICATION_AUTHORITY

The list of parameters and their possible values are enumerated below.

  • $HOST is the server hosting the Back Office.
  • $SERVICE_ID is the number of the desired service.
  • $SERVICE_STATUS is the status of the desired service.

API usage example:

  • $HOST: 10.61.8.175
  • $SERVICE_ID: 1
  • $SERVICE_STATUS: stable

http://10.61.8.175/bo-ws/service/1/instance/stable/acp?afs:login=login://$USER:$PASSWORD@$AUTHENTICATION_AUTHORITY

API responses are returned in the format indicated by the "Accept" header.

The XML result of the previous request is shown below:

<afs:value xmlns:afs="http://ref.antidot.net/v7/bo/output" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://ref.antidot.net/v7/bo/output http://ref.antidot.net/v7.4/bo/output.xsd" xsi:type="afs:ws.response">
[...]
<afs:result xsi:type="afs:ws.filtering.result">
[...]
<afs:values>
<afs:item xsi:type="afs:bows.acp" reference="/bo-ws/project/1/service/1/instance/stable/acp/fromHitParade%3Aacp.xml">
<afs:tracker xsi:type="afs:bows.tracker.publish">
<afs:lastUpdatedDate xsi:type="afs:date-time">2012-07-27T11:35:54+02:00</afs:lastUpdatedDate>
<afs:lastUpdatedUser>
<afs:userName>Root User</afs:userName>
<afs:userReference>/bo-ws/user/36</afs:userReference>
</afs:lastUpdatedUser>
<afs:lastPreviousPublishedDate xsi:type="afs:date-time">2012-03-28T14:21:26+02:00</afs:lastPreviousPublishedDate>
<afs:lastPreviousPublishedUser>
<afs:userName>Root User</afs:userName>
<afs:userReference>/bo-ws/user/36</afs:userReference>
</afs:lastPreviousPublishedUser>
<afs:lastPublishedDate xsi:type="afs:date-time">2012-07-27T11:35:54+02:00</afs:lastPublishedDate>
<afs:lastPublishedUser>
<afs:userName>Root User</afs:userName>
<afs:userReference>/bo-ws/user/36</afs:userReference>
</afs:lastPublishedUser>
</afs:tracker>
<afs:currentVersion>PUBLISH</afs:currentVersion>
<afs:hasBackupVersion>false</afs:hasBackupVersion>
<afs:hasPublishedVersion>true</afs:hasPublishedVersion>
<afs:description/>
<afs:generationStatus>SUCCESS</afs:generationStatus>
<afs:id>1</afs:id>
<afs:key xsi:type="afs:bows.acp.key">
<afs:feedFileName>fromHitParade:acp.xml</afs:feedFileName> <!-- ACP file name -->
<afs:serviceInstance xsi:type="afs:bows.admin.service.instance" partial="true" reference="/bo-ws/project/1/service/1/instance/stable">
<afs:clientUrls/>
<afs:id>1</afs:id>
<afs:key xsi:type="afs:bows.admin.service.instance.key" partial="true">
<afs:status>STABLE</afs:status>
</afs:key>
<afs:name>Technical Publications (1) STABLE</afs:name>
<afs:url>http://packaging-doc/</afs:url>
</afs:serviceInstance>
</afs:key>
<afs:lastFetch xsi:type="afs:date-time">2012-11-08T02:00:00+01:00</afs:lastFetch>
<afs:moderation>AUTO_VALIDATE</afs:moderation>
<afs:name>From Hit Parade</afs:name> <!-- ACP Name -->
<afs:nbBannedElements>0</afs:nbBannedElements>
<afs:nbElements>15</afs:nbElements>
<afs:nbFilteredElements>0</afs:nbFilteredElements>
<afs:nbIncludedElements>0</afs:nbIncludedElements>
<afs:nbNewElements>0</afs:nbNewElements>
<afs:source>HIT_PARADE</afs:source>
<afs:tags/>
</afs:item>
[...] <!-- There are as many afs:item node as there are available ACP -->
</afs:values>
</afs:result>
</afs:value>