Get Tagged Logical Element values within a job

This Web service submits a request for all the values that are used for a specific Tagged Logical Element (TLE) in a job. Both Page Level and Group Level TLE values are returned.

HTTP method

GET

URI

/aiwservices/v1/job/ID/TLE/tleName

Request headers

ippdcredential

<credential token="value" />

Accept-Language (optional)

lang

Supported language values:

de German
en US English (default)
es Spanish
fr French
it Italian
ja Japanese
pt_BR Brazilian Portuguese

Return codes

  • 200 OK
  • 401 Unauthorized
  • 404 Not Found
  • 500 Internal Server Error
  • 501 Not Implemented

Response body on success

A <resultset> containing one <result> for each TLE value in the job. Each <result> contains one <tle> element with these attributes:

name

The job ID specified in the URI

tleName

The TLE specified in the URI

tleValue

One of the values used in the job for the specified TLE

page

The page of the job where the TLE is used

  • Null values are represented as self-closing <property> elements with no value attribute.
  • Empty values are represented as <property> elements with no value attribute and no embedded <value> tags. They are not self-closing.

Examples

Sample request

Get all TLE values of the TLE Customer name for job 10000000.

http://hostname:15080/aiwservices/v1/job/10000000/TLE/Customer+name

Sample response

<resultset>
	<result>
		<tle name="10000000" tleName="Customer name" tleValue="Pamela Clark-Anders" page="15"/>
	</result>
	<result>
		<tle name="10000000" tleName="Customer name" tleValue="Carlos Ferreira" page="18"/>
	</result>
</resultset>
 
Copyright © 2015, 2018