Find a Project Number from a Service Number - ABO

Back Office Integration Guide

Product
ABO
AFS_Version
7.9
Category
Reference Guide
language
English

This API returns a Project Number from a Service Number. Project Number is used in other Back Office APIs.

A "Find Project Number" API request takes the following form:

http://$HOST/bo-ws/service/instance?afs:filter=serviceId=$SERVICE_ID%20and%20status=$SERVICE_STATUS&result=full

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

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

Method: GET

API usage example:

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

http://10.61.8.175/bo-ws/service/instance?afs:filter=serviceId=1%20and%20status=STABLE&result=full&afs:login=login://$USER:$PASSWORD@$AUTHENTICATION_AUTHORITY

The Project Number can be found at XPath:

/value/result/values/item/key/service/project/id

The XML result of the previous request is shown below:

<?xml version="1.0" standalone='yes'?>

<afs:value xsi:schemaLocation="http://ref.antidot.net/v7/bo/output http://ref.antidot.net/v7.4/bo/output.xsd" xsi:type="afs:ws.response" xmlns:afs="http://ref.antidot.net/v7/bo/output" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<afs:query xsi:type="afs:ws.response.query">
<afs:locale>fr_FR</afs:locale>
<afs:parameters>
<afs:parameter name="afs:filter" value="serviceId=1 and status=STABLE"></afs:parameter>
<afs:parameter name="result" value="full"></afs:parameter>
</afs:parameters>
<afs:properties xsi:type="afs:dynamic"></afs:properties>
</afs:query>
<afs:result xsi:type="afs:ws.filtering.result">
<afs:count>1</afs:count>
<afs:request>
<afs:elementsPerPage>0</afs:elementsPerPage>
<afs:page>1</afs:page>
</afs:request>
<afs:totalCount>1</afs:totalCount>
<afs:values>
<afs:item xsi:type="afs:bows.admin.service.instance" reference="/bo-ws/project/1/service/1/instance/stable">
<afs:clientUrls></afs:clientUrls>
<afs:id>1</afs:id>
<afs:key xsi:type="afs:bows.admin.service.instance.key">
<afs:service xsi:type="afs:bows.admin.service" partial="true" reference="/bo-ws/project/1/service/1">
<afs:companyPluginModulesPermissions>
<afs:item xsi:type="afs:bows.admin.perm.company.apps">
<afs:applications>
<!-- list of activated applications -->
</afs:applications>
<afs:company xsi:type="afs:bows.model.company" partial="true" reference="/bo-ws/company/1">
<afs:id>1</afs:id>
<afs:host>true</afs:host>
<afs:name>Doc</afs:name>
</afs:company>
<afs:id>13</afs:id>
</afs:item>
</afs:companyPluginModulesPermissions>
<afs:id>1</afs:id>
<afs:name>Technical Publications (1)</afs:name>
<afs:project xsi:type="afs:bows.model.project" partial="true" reference="/bo-ws/project/1">
<afs:id>1</afs:id> <!-- This is the Project Number -->
<afs:name>Technical Publications</afs:name>
</afs:project>
<afs:serviceId>1</afs:serviceId>
<afs:url>http://sandbox-doc/</afs:url>
</afs:service>
<afs:status>STABLE</afs:status>
</afs:key>
<afs:name>Technical Publications (1) STABLE</afs:name>
<afs:settings xsi:type="afs:bows.admin.service.instance.settings">
<!-- Instance Specific Settings -->
</afs:settings>
<afs:url>http://packaging-doc/</afs:url>
</afs:item>
</afs:values>
</afs:result>
</afs:value>