/ EUROPEAN COMMISSION
DIRECTORATE-GENERAL
INFORMATICS
Information systems Directorate

European Commission

XTC Webservice Data Dictionary

Date: / 04/01/2012
Version: / 1.0
Authors: / Francesco Amelio
Revised by:
Approved by:
Public:
Reference Number:

Table of contents

1. ReadCityRequest

2. ReadCityResponse

3. CreateCityRequest

4. CreateCityResponse

5. UpdateCityRequest

6. UpdateCityResponse

7. DeleteCityRequest

8. DeleteCityResponse

9. SubmitRequest

10. SubmitResponse

1.ReadCityRequest

1.1.Schema

1.2.Definition

1.2.1.ReadCityRequest

ID / Variable Name / Constraint / Definition / Description and Particularities / Data Type / Sample value
001 / ID / Mandatory / The ID of the City in Traces DB / Integer / 1

1.3.Sample

<impl:ReadCityRequest>
<impl:ID>1</impl:ID>
</impl:ReadCityRequest>

2.ReadCityResponse

2.1.Schema

2.2.Definition

2.2.1.ReadCityResponse

ID / Variable Name / Constraint / Definition / Description / Data Type / Sample value
001 / CITY / Mandatory / The CityType read with the call / CityType
002 / OP_RESULT / Mandatory / The result of the operation / OperationResult

2.2.2.CityType

ID / Variable Name / Constraint / Definition / Description / Data Type / Sample value
001 / ID / Mandatory / Traces City ID / Integer / 1
002 / CITY_URI / Optional / Text
003 / CITY_NAME / Mandatory / Name of the city / Text / Bruxelles
004 / AUTHORITY_CODE / Mandatory / Code of the local competent authority / Text / BE01202
005 / CITY_POSTAL_CODE / Mandatory / Postal code / Text / 1000
006 / CONTRY_CODE / Mandatory / Contry code / ISO 3166-1-alpha-2 code / Text / BE
007 / STATUS / Mandatory / valid | deleted / valid
008 / LATITUDE / Optional / Latitude / Decimal / 50,85217397
009 / LONGITUDE / Optional / Longitude / Decimal / 4,36122543

2.2.3.OperationResult

ID / Variable Name / Constraint / Definition / Description / Data Type / Sample value
001 / resultcode / Mandatory / The result of the operation / ResultCode / OK, KO
002 / errorcode / Optional / Error code, if any error happenes. / Text
003 / message / Optional / Message describing the error / Text

2.3.Sample

<impl:ReadCityResponse
<impl:CITY>
<impl:ID>34433</impl:ID>
<impl:CITY_URI/>
<impl:CITY_NAME>Margerie Chantagret</impl:CITY_NAME>
<impl:AUTHORITY_CODE>FR04200</impl:AUTHORITY_CODE>
<impl:CITY_POSTALCODE>42560</impl:CITY_POSTALCODE>
<impl:COUNTRY_CODE>FR</impl:COUNTRY_CODE>
<impl:LATITUDE>45.50829624</impl:LATITUDE>
<impl:LONGITUDE>4.04912217</impl:LONGITUDE>
</impl:CITY>
<impl:OP_RESULT resultcode="OK"/>
</impl:ReadCityResponse>

3.CreateCityRequest

3.1.Schema

3.2.Definitions

3.2.1.CityType

ID / Variable Name / Constraint / Definition / Description / Data Type / Sample value
001 / ID / Ignored / Traces City ID / Integer / 1
002 / CITY_URI / Optional / Text
003 / CITY_NAME / Mandatory / Name of the city / Text / Bruxelles
004 / AUTHORITY_CODE / Mandatory / Code of the local competent authority / Text / BE01202
005 / CITY_POSTAL_CODE / Mandatory / Postal code / Text / 1000
006 / CONTRY_CODE / Mandatory / Contry code / ISO 3166-1-alpha-2 code / Text / BE
007 / STATUS / Mandatory / valid | deleted / valid
008 / LATITUDE / Optional / Latitude / Decimal / 50,85217397
009 / LONGITUDE / Optional / Longitude / Decimal / 4,36122543

3.3.Sample

<impl:CreateCityRequest>
<impl:CITY>
<impl:CITY_NAME>VITORIA-GASTEIZ</impl:CITY_NAME>
<impl:AUTHORITY_CODE>ES39715</impl:AUTHORITY_CODE>
<impl:CITY_POSTALCODE>01003</impl:CITY_POSTALCODE>
<impl:COUNTRY_CODE>ES</impl:COUNTRY_CODE>
<impl:STATUS>valid</impl:STATUS>
<impl:LATITUDE>42.36</impl:LATITUDE>
<impl:LONGITUDE>13.44</impl:LONGITUDE>
</impl:CITY>
</impl:CreateCityRequest>

4.CreateCityResponse

4.1.Schema

4.2.Definition

4.2.1.CreateCityResponse

ID / Variable Name / Constraint / Definition / Description / Data Type / Sample value
001 / REQUEST_ID / Mandatory / The RequestID for reference / Integer / 2270
002 / SUBMISSION_ID / Mandatory / The Submission ID for reference / Integer / 1
003 / ID / Mandatory / The ID of the created city / Integer / 21153707
004 / OP_RESULT / Mandatory / The result of the operation / OperationResult / OK

4.3.Sample

<impl:CreateCityResponse
<impl:REQUEST_ID>2270</impl:REQUEST_ID>
<impl:SUBMISSION_ID>1</impl:SUBMISSION_ID>
<impl:ID>21153707</impl:ID>
<impl:OP_RESULT resultcode="OK"/>
</impl:CreateCityResponse>

5.UpdateCityRequest

5.1.Schema

5.2.Definition

5.2.1.CityType

ID / Variable Name / Constraint / Definition / Description / Data Type / Sample value
001 / ID / Mandatory / Traces City ID / Integer / 1
002 / CITY_URI / Optional / Text
003 / CITY_NAME / Mandatory / Name of the city / Text / Bruxelles
004 / AUTHORITY_CODE / Mandatory / Code of the local competent authority / Text / BE01202
005 / CITY_POSTAL_CODE / Mandatory / Postal code / Text / 1000
006 / CONTRY_CODE / Mandatory / Contry code / ISO 3166-1-alpha-2 code / Text / BE
007 / STATUS / Ignored
008 / LATITUDE / Optional / Latitude / Decimal / 50,85217397
009 / LONGITUDE / Optional / Longitude / Decimal / 4,36122543

5.3.Sample

<impl:UpdateCityRequest>
<impl:CITY>
<impl:ID>21108040</impl:ID>
<impl:CITY_NAME>VITORIA-GASTEIZ</impl:CITY_NAME>
<impl:AUTHORITY_CODE>ES39715</impl:AUTHORITY_CODE>
<impl:CITY_POSTALCODE>01003</impl:CITY_POSTALCODE>
<impl:COUNTRY_CODE>ES</impl:COUNTRY_CODE>
<impl:STATUS>valid</impl:STATUS>
<impl:LATITUDE>42.36</impl:LATITUDE>
<impl:LONGITUDE>13.44</impl:LONGITUDE>
</impl:CITY>
</impl:UpdateCityRequest>

6.UpdateCityResponse

6.1.Schema

6.2.Definition

6.2.1.UpdateCityResponse

ID / Variable Name / Constraint / Definition / Description / Data Type / Sample value
001 / OP_RESULT / Mandatory / The result of the operation / OperationResult / OK

6.3.Sample

<impl:UpdateCityResponse
<impl:OP_RESULT resultcode="OK"/>
</impl:UpdateCityResponse>

7.DeleteCityRequest

7.1.Schema

7.2.Definition

ID / Variable Name / Constraint / Definition / Description and Particularities / Data Type / Sample value
001 / ID / Mandatory / The ID of the City in Traces / Integer / 1

7.3.Sample

<impl:DeleteCityRequest>
<impl:ID>1</impl:ID>
</impl:DeleteCityRequest>

8.DeleteCityResponse

8.1.Schema

8.2.Definition

ID / Variable Name / Constraint / Definition / Description / Data Type / Sample value
001 / OP_RESULT / Mandatory / The result of the operation / OperationResult / OK

8.3.Sample

<impl:DeleteCityResponse>

<impl:OP_RESULT resultcode="OK"/>

</impl:DeleteCityResponse>

9.SubmitRequest

9.1.Schema

9.2.Definition

9.2.1.Submission

ID / Variable Name / Constraint / Definition / Description and Particularities / Data Type / Sample value
001 / OPERATION / Mandatory / The operation to perform on the related City / Enumeration (NEW, UPD, DEL) / UPD
002 / CITY / Mandatory / CityType

9.2.2.CityType

See the CityType in the section ReadCityRequest, UpdateCityRequest and CreateCityRequest

9.3.Sample

<impl:SubmitRequest>
<impl:SUBMISSIONS>
<impl:SUBMISSION>
<impl:OPERATION>NEW</impl:OPERATION>
<impl:CITY>
<impl:CITY_NAME>LOGROÑO</impl:CITY_NAME>
<impl:AUTHORITY_CODE>ES35016</impl:AUTHORITY_CODE>
<impl:CITY_POSTALCODE>26004</impl:CITY_POSTALCODE>
<impl:COUNTRY_CODE>ES</impl:COUNTRY_CODE>
</impl:CITY>
</impl:SUBMISSION>
<impl:SUBMISSION>
<impl:OPERATION>UPD</impl:OPERATION>
<impl:CITY>
<impl:ID>358965</impl:ID>
<impl:CITY_NAME>ABADIANO</impl:CITY_NAME>
<impl:AUTHORITY_CODE>ES39915</impl:AUTHORITY_CODE>
<impl:CITY_POSTALCODE>48220</impl:CITY_POSTALCODE>
<impl:COUNTRY_CODE>ES</impl:COUNTRY_CODE>
</impl:CITY>
</impl:SUBMISSION>
<impl:SUBMISSION>
<impl:OPERATION>DEL</impl:OPERATION>
<impl:CITY>
<impl:ID>356414</impl:ID>
</impl:CITY>
</impl:SUBMISSION>
</impl:SUBMISSIONS>
</impl:SubmitRequest>

10.SubmitResponse

10.1.Schema

10.2.Definition

10.2.1.SubmitResponse

ID / Variable Name / Constraint / Definition / Description / Data Type / Sample value
001 / SUBMISSION_RESPONSE_LIST / Mandatory / SubmissionResponseListType
002 / OP_RESULT / Mandatory / The result of the operation / OperationResult / OK

10.2.2.SubmissionResponseListType

ID / Variable Name / Constraint / Definition / Description / Data Type / Sample value
001 / SUBMISSION_RESPONSE / Mandatory / SubmissionResponseType
002 / OP_RESULT / Mandatory / The result of the operation / OperationResult / OK

10.2.3.SubmissionResponseType

ID / Variable Name / Constraint / Definition / Description / Data Type / Sample value
001 / REQUEST_ID / Mandatory / The Request ID for reference / Integer / 2270
002 / SUBMISSION_ID / Mandatory / The Submission ID for reference / Integer / 1
003 / OPERATION / Mandatory / The operation performed. / Integer / 21153707
004 / CITY_NAME / Optional / The name of the city modified.
005 / ID / Mandatory / The ID of the created / updated / deleted city
006 / OP_RESULT / Mandatory / The result of the operation / OperationResult / OK

10.3.Sample

<impl:SubmitResponse>

<impl:SUBMISSION_RESPONSE_LIST>

<impl:SUBMISSION_RESPONSE>
<impl:REQUEST_ID>4196</impl:REQUEST_ID>
<impl:SUBMISSION_ID>1</impl:SUBMISSION_ID>
<impl:OPERATION>NEW</impl:OPERATION>
<impl:CITY_NAME>VITORIA-GASTEIZ</impl:CITY_NAME>
<impl:ID>21188782</impl:ID>
<impl:OP_RESULT resultcode="OK"/>
</impl:SUBMISSION_RESPONSE>
<impl:SUBMISSION_RESPONSE>
<impl:REQUEST_ID>0</impl:REQUEST_ID>

<impl:SUBMISSION_ID>0</impl:SUBMISSION_ID>
<impl:OPERATION>UPD</impl:OPERATION>
<impl:CITY_NAME>ADINO (GURIEZO)</impl:CITY_NAME>
<impl:ID>357123</impl:ID>
<impl:OP_RESULT resultcode="OK"/>
</impl:SUBMISSION_RESPONSE>
<impl:SUBMISSION_RESPONSE>
<impl:REQUEST_ID>0</impl:REQUEST_ID>
<impl:SUBMISSION_ID>0</impl:SUBMISSION_ID>
<impl:OPERATION>DEL</impl:OPERATION>
<impl:CITY_NAME xsi:nil="true"/>
<impl:ID>356414</impl:ID>
<impl:OP_RESULT resultcode="OK"/>
</impl:SUBMISSION_RESPONSE>

</impl:SUBMISSION_RESPONSE_LIST>

<impl:OP_RESULT resultcode="OK"

message="All the cities submitted were accepted."/>

</impl:SubmitResponse>

Bovine Exchange Data Dictionnary - Page 1 / 16

Document Version 1.0 dated 30/11/2009