version 1.0 - omint mar16.pdf · wcf specification i.t. omint version 1.0.0 date: 01/09/2015...

42
WCF Specification Version 1.0.1

Upload: others

Post on 28-Jun-2020

4 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification Version 1.0.1

Page 2: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

2/42

1 Introduction ................................................................................................................

2 WebService’s Details ................................................................................................. 3 How to Access ............................................................................................................ 4 Functions descriptions ................................................................................................ 5 References .................................................................................................................. 6 Development ...............................................................................................................

7 Access Function. .........................................................................................................

7.1 Function Name: GetLoginToken. ........................................................................

7.1.1 Functional Description. ................................................................................ 7.1.2 Implementation. ............................................................................................ 7.1.3 Parameters Description and Results Descriptions. .......................................

7.2 Function Name: GetSession. ................................................................................ 7.2.1 Functional Description. ................................................................................ 7.2.2 Implementation. ............................................................................................

7.2.3 Parameters Description and Results Descriptions. .......................................

8 General Functions. ......................................................................................................

8.1 Function Name: GetProductList. .........................................................................

8.1.1 Functional Description. ................................................................................ 8.1.2 Implemetation. ..............................................................................................

8.1.3 Parameters description and results description. ............................................

8.2 Function Name: GetProduct. ............................................................................... 8.2.1 Functional Description. ................................................................................ 8.2.2 Implementation. ............................................................................................

8.2.3 Parameters description and results description. ............................................

8.3 Function Name: GetDeparturePoints. .................................................................. 8.3.1 Functional Description. ................................................................................ 8.3.2 Implementation. ............................................................................................

8.3.3 Parameters and results description. ..............................................................

8.4 Funcion Name: GetDestinations. ......................................................................... 8.4.1 Functional Description. ................................................................................

8.4.2 Implementation. ............................................................................................ 8.4.3 Parameters and results description. ..............................................................

8.5 Funcion Name: GetPurposesOfTrip. ................................................................... 8.5.1 Functional Description. ................................................................................

8.5.2 Implementation. ............................................................................................ 8.5.3 Parameters and results description. ..............................................................

Page 3: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

3/42

8.6 Funcion Name: GetPurposeOfTrip.. ....................................................................

8.6.1 Functional Description. ................................................................................ 8.6.2 Implementation. ............................................................................................ 8.6.3 Parameters and results description. ..............................................................

8.7 Funcion Name: GetAdditionalCoverage.. ...........................................................

8.7.1 Functional Description. ................................................................................ 8.7.2 Implementation. ............................................................................................ 8.7.3 Parameters and results description. ..............................................................

8.8 Funcion Name: GetRelativeRelationship... ......................................................... 8.8.1 Functional Description. ................................................................................ 8.8.2 Implementation. ............................................................................................

8.8.3 Parameters and results description. ..............................................................

8.9 Funcion Name: GetFormsOfPaymentByCompany... .......................................... 8.9.1 Functional Description. ................................................................................

8.9.2 Implementation. ............................................................................................ 8.9.3 Parameters and results description. ..............................................................

8.10 Funcion Name: GetFormsOfPayment.................................................................. 8.10.1 Functional Description. ................................................................................

8.10.2 Implementation. ............................................................................................ 8.10.3 Parameters and results description. ..............................................................

8.11 Funcion Name: GetExchangeRate... ....................................................................

8.11.1 Functional Description. ................................................................................ 8.11.2 Implementation. ............................................................................................ 8.11.3 Parameters and results description. ..............................................................

8.12 Funcion Name: GetCities.. ...................................................................................

8.12.1 Functional Description. ................................................................................ 8.12.2 Implementation. ............................................................................................ 8.12.3 Parameters and results description. ..............................................................

8.13 Funcion Name: GetAddressByZipCode.. ............................................................ 8.13.1 Functional Description. ................................................................................ 8.13.2 Implementation. ............................................................................................

8.13.3 Parameters and results description. ..............................................................

9 Sales's Functions. ........................................................................................................

9.1 Function Name: GetQuote. ..................................................................................

9.1.1 Functional Description. ................................................................................ 9.1.2 Implementation. ............................................................................................ 9.1.3 Parameters description and results description. ............................................

Page 4: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

4/42

9.2 Function Name: CreateVoucher. .........................................................................

9.2.1 Functional Description. ................................................................................ 9.2.2 Implementation. ............................................................................................ 9.2.3 Parameters description and results description. ............................................

9.6 Function Name: CancelVoucher. .........................................................................

9.6.1 Functional Description. ................................................................................ 9.6.2 Implementation. ............................................................................................ 9.6.3 Parameters description and results description. ............................................ 9.6.4 WSDL Specification. ....................................................................................

9.8 Function Name: QueryVouchers. ........................................................................ 9.8.1 Functional Description. ................................................................................

9.8.2 Implementation. ............................................................................................ 9.8.3 Parameters description and results description. ............................................

9.12 Function Name: ExtensionAuthorize. ..............................................................

9.12.1 Functional Description. ................................................................................ 9.12.2 Implementation. ............................................................................................ 9.12.3 WSDL Specification. ....................................................................................

9.13 Function Name: ExtensionOfCoverage. ..........................................................

9.13.1 Functional Description. ................................................................................ 9.13.2 Implementation. ............................................................................................

9.13.3 WSDL Specification. ....................................................................................

10 Appendix – References Tables. ..................................................................................

10.1 Document types table. ......................................................................................

10.2 Currency table .................................................................................................. 10.3 Relationship table .............................................................................................

10.4 Tax Conditions Table ....................................................................................... 10.5 Method of payment / Sale conditions - Table .................................................. 10.6 Invoice types table ............................................................................................

10.7 Table of Group Companies .............................................................................. 10.8 Table of Credit Card types ............................................................................... 10.9 Table of Credit Cards .......................................................................................

10.10 Table of P.P.E...................................................................................................

10.11 Table of Error Codes ........................................................................................

Page 5: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

5/42

1 Introduction This document it is a reference for developers and aims to explain how to use the WCFthat will exchange information between Omint Travel and any external information system. This guide also presents theirs methods and how to accesss it. All examples in this document use the VB.NET language but for being a WebServices can be user in others languages that support the XML format.

2 WebService’s Details This WCF will be used to support customer business functions of travel insurance such as quotes, emission and backoffice functions.

3 How to Access To access the WCF is necessary to create a reference (Web Reference) to the following address: http://p1.omintseguroviagem.com.br:7211/

Adress – Projetcs Test environment: http://h.omintseguroviagem.com.br:7211/Session.svc?wsdl

http://h.omintseguroviagem.com.br:7211/Quotation.svc?wsdl

http://h.omintseguroviagem.com.br:7211/Emission.svc?wsdl

http://h.omintseguroviagem.com.br:7211/Currency.svc?wsdl

http://h.omintseguroviagem.com.br:7211/Payment.svc?wsdl

Adress – Projetcs Production environment “To be confirmed”: https://www.omintseguroviagem.com.br/Session.svc?wsdl

https://www.omintseguroviagem.com.br/Quotation.svc?wsdl

https://www.omintseguroviagem.com.br/Emission.svc?wsdl

https://www.omintseguroviagem.com.br/Currency.svc?wsdl

https://www.omintseguroviagem.com.br/Payment.svc?wsdl

WCF for tests. After the WCF is referenced in the project, is necessary to create an instance to user the methods. Find below an example of code to create the instance of WCF assuming that the instance name is “Service”. VB.Net

Dim myService As Service.IntegrationService = New Service.IntegrationService()

4 Functions descriptions It is possible to classify each function in one of the following categories:

1. Access Functions. 2. General Information Functions. 3. Sales Functions. 4. Integration Functions with Back office (Billing – Customer’s Payments – Customers).

Page 6: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

6/42

5 References For a better interpretation of this functional specification, it’s recommended to be familiar with the following standards:

XML: http://www.w3.org/TR/XML/

SOAP: http://www.w3.org/TR/soap/

WSDL: http://www.w3.org/TR/wsdl/

6 Development This document describes the following items:

WCF functional description of functions mentioned in point 4.

Parameters descriptions and results descriptions for each webservice.

The WSDL specification for each WCF (this description will be completed in details in its own function description).

This document is also based on the following premises:

1. Every WS will be located in the owner information system where the information is managed. 2. Every information system will send its own information through WS and will not send receptor’s

information. 3. Every system will send only those transactions that it knows because the information is generated

by it. For example, during the billing process, Omint Travel System wants to bill so, if the client doesn’t

exist in the ERP system, the billing process have to know how create it.

Page 7: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

7/42

7 Access Function.

7.1 Function Name: GetLoginToken. http://p1.omintseguroviagem.com.br:7211/Session.svc?wsdl

7.1.1 Functional Description.

This method allows an external system requesting a token for access to webservices. The returned token will be valid until another one will generated to replace it.

7.1.2 Implementation.

This method is implemented on Omint Insurance System (OIS).

7.1.3 Parameters Description and Results Descriptions.

Req. Data Types Examples

Input Parameters

Country Yes String – Country where the company or client Works.

ARG, BRA

Language Yes String

PT

Password Yes String

1234567890

SalesChannelCode No String

ARG, BRA

SalesChannelType Yes String

OLN

UserName Yes String

****@******.com.br

Response

Token String - Token that should be inform during the GetSession operation.

cES0SSuWIIPlfe5/dLtb0Qeg2jQuvYuuSEDOrz+w2EnAQiEeS86gzYf7ehiU3UaYit5FRb9z/3zq

MessageCode int – This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 8: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

8/42

7.2 Function Name: GetSession. http://p1.omintseguroviagem.com.br:7211/Session.svc?wsdl

7.2.1 Functional Description.

This method allows an external system requests a session to manage other web services. This session contains valid credentials for a given time and should be reported in each subsequent transaction. Expiration of the period of validity must apply for credentials.

7.2.2 Implementation.

This method will be implemented on OIS platform.

7.2.3 Parameters Description and Results Descriptions.

Req. Data Types Examples

Input Parameters (GetSessionRequest)

Token Yes string – Token identification obtained for a given company by GetLoginToken method.

cES0SSuWIIPlfe5/dLtb0Qeg2jQuvYuuSEDOrz+w2EnAQiEeS86gzYf7ehiU3UaYit5FRb9z/3zq

Response (GetSessionResponse)

Country String – Country where the company or client Works.

ARG, BRA

Language String

PT

Profiles String

SalesChannelCode String

SalesChannelType String

SessionEndTime DateTime - Time when the session expires. 20110525T14: 00:02-03: 00

SessionID string – Session ID that should be inform in the following operations.

a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

SessionStartTime DateTime - Time when the session was opened. 20110525T12: 00:02-03: 00

Token String

UserName String

MessageCode int – This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 9: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

9/42

8 General Functions.

8.1 Function Name: GetProductList. http://p1.omintseguroviagem.com.br:7211/Quotation.svc?wsdl

8.1.1 Functional Description.

After the company code has been identified, this method returns the products list available for this company.

8.1.2 Implemetation.

This method will be implemented on OIS platform.

8.1.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters (GetProductList Request)

SessionID Yes string – Session ID obtained by GetSession method.

a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

DestinationCode No String – Country where the company or client Works.

ARG, BRA

IncludesEurope No int 1 “Yes” 0 “No”

PurposeOfTrip Yes string L I E

Response (GetProductListResponse)

ProductList - Product[]

Code string – Product code. EURO GD AU

Description string – Product Description Euro Gold Anual

Name string – Product Type Simple Anual

AdditionalsCoverages - AdditionalCoverage []

Code string – AdditionalCoverage.

CompanyAmount decimal

Description string

EnglishName string

Name string

Services string

MessageCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 10: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

10/42

8.2 Function Name: GetProduct. http://p1.omintseguroviagem.com.br:7211/Quotation.svc?wsdl

8.2.1 Functional Description.

After the company code and the product code have been identified, this method returns all the attributes of a product including its coverage as a list of additional services and benefits.

8.2.2 Implementation.

This method will be implemented on OIS platform.

8.2.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters(GetProductRequest)

SessionID Yes string – Session ID obtained by GetSession method.

a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

ProductCode Yes string – Product code. GOLD CLIP01

Response (GetProductResponse)

ProductInfo - Product ProductCode string – Product code GB

Description string – Product Description Euro Gold Anual

MaxDays int 120

MinDays int 5

MinPrice double 64.5

Name string Global

ScopeOfCoverage string INTERNACIONAL

AgeLimit int 0

Services – Service[] Code string – Service code EM01 DB03

Description string – Service Description Medical Assistance. Luggage Insurance.

MainFeature

Max decimal – Service Limit 20.000 5

Units string - Unit that it used to measure the service or benefit

D – Dias M - Dinero

Benefits – Benefit[] Code string – Benefit Code BA004 BA005

Description string – Benefit Description Legal assistance

MainFeature

Max

Units

ShowCase – ShowCase[] Name String

Price Decimal

ProductCode String

ProductId

ValidFrom Datetime

ValidUntil

MessageCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is

Page 11: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

11/42

not applied, otherwise it reports the error message.

8.3 Function Name: GetDeparturePoints. http://p1.omintseguroviagem.com.br:7211/Quotation.svc?wsdl

8.3.1 Functional Description.

Gets the departure points for a company code and a native country.

8.3.2 Implementation.

This method is implemented on OIS.

8.3.3 Parameters and results description.

Req. Data Type Examples

Input Parameters

SessionID Yes string – session ID obtainded from GetSession. a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

Response

Points – DeparturePoint[] ID int – departure point ID 1

Code string – Code SAO

Description string – Description

Sao Paulo

MessageCode int – This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 12: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

12/42

8.4 Funcion Name: GetDestinations. http://p1.omintseguroviagem.com.br:7211/Quotation.svc?wsdl

8.4.1 Functional Description.

Gets the available destinations by product code.

8.4.2 Implementation.

This method is implemented OIS.

8.4.3 Parameters and results description.

Req. Data Type Examples

Input Parameters

SessionID Yes string – Session ID obtained from GetSession. a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

Response

Destinations – Destination[]

ID int – Destination ID 1

Code string – Code FR

Euro Int 1 0

Description string – Description

Francia

MessageCode int - – This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 13: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

13/42

8.5 Function Name: GetPurposesOfTrip. http://p1.omintseguroviagem.com.br:7211/Quotation.svc?wsdl

8.5.1 Functional Description.

After the company code has been identified, this method returns the Purposes Of Trip list available for this company.

8.5.2 Implemetation.

This method will be implemented on OIS platform.

8.5.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters

SessionID Yes String – Session ID obtained by GetSession method.

a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

Response

GetPurposesOfTrip – PurposeOfTrip –

Code String L I E

Description String Lazer / Negócios Intercambio Esportes de competição

MaxQuantityOfDays Int 120 365

AgeRanges – AgeRange[] AgeMax int 70 85

AgeMin Int 0 71

Code String MN MY

MessageCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 14: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

14/42

8.6 Function Name: GetPurposeOfTrip. http://p1.omintseguroviagem.com.br:7211/Quotation.svc?wsdl

8.6.1 Functional Description.

After the company code has been identified, this method returns the Purposes Of Trip list available for this company.

8.6.2 Implemetation.

This method will be implemented on OIS platform.

8.6.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters

SessionID Yes String – Session ID obtained by GetSession method.

a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

Code Yes String - Purposes Of Trip L I E

Response

PurposeOfTrip Code String L I E

Description String Lazer / Negócios Intercambio Esportes de competição

MaxQuantityOfDays Int 120 365

AgeRanges – AgeRange[] AgeMax int 70 85

AgeMin Int 0 71

Code String MN MY

MessageCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 15: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

15/42

8.7 Function Name: GetAdditionalCoverage. http://p1.omintseguroviagem.com.br:7211/Quotation.svc?wsdl

8.7.1 Functional Description.

After the company code has been identified, this method returns the Additional Coverage list available for this company.

8.7.2 Implemetation.

This method will be implemented on OIS platform.

8.7.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters

SessionID Yes String – Session ID obtained by GetSession method.

a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

AdditionalCoverageCode Yes String - Additional Coverage PP BG

Response

AdditionalCoverage Code String PP

CompanyAmount Decimal 10

Description String Compra Protegida

EnglishName String Protected Purchase

Name String Compra Protegida

Services String

MessageCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 16: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

16/42

8.8 Function Name: GetRelativeRelationship. http://p1.omintseguroviagem.com.br:7211/Quotation.svc?wsdl

8.8.1 Functional Description.

After the company code has been identified, this method returns the Relationship (P.P.E) list available for this company.

8.8.2 Implemetation.

This method will be implemented on OIS platform.

8.8.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters

SessionID Yes String – Session ID obtained by GetSession method.

a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

Response

RelativeRelationship - RelativeRelationship

Code String 1 16

Name String Avô/Avó Estipulante

MessageCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 17: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

17/42

8.9 Function Name: GetFormsOfPaymentByCompany. http://p1.omintseguroviagem.com.br:7211/Payment.svc?wsdl

8.9.1 Functional Description.

After the company code has been identified, this method returns the Forms of Payment list available for this company.

8.9.2 Implemetation.

This method will be implemented on OIS platform.

8.9.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters

SessionID Yes String – Session ID obtained by GetSession method.

a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

DiscountCoupon No Int

ProductCode Yes String GB GBS

ValidFrom Yes Datime 2015-08-31 “Today”

Response

FormsOfPayment – FormOfPaymentBase []

Code String TVI

Description String Visa

ImageURL String /Portals/_default/Skins/OmintSkin/cont/visa.jpg

Type String T

MessageCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 18: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

18/42

8.10 Function Name: GetFormsOfPayment. http://p1.omintseguroviagem.com.br:7211/Payment.svc?wsdl

8.10.1 Functional Description.

After the company code has been identified, this method returns the Forms of Payment list available for this company.

8.10.2 Implemetation.

This method will be implemented on OIS platform.

8.10.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters

SessionID Yes String – Session ID obtained by GetSession method.

a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

VoucherNumber Yes String 3000805683

Response

FormsOfPayment – FormOfPayment[]

Code String TVI

Description String Visa

ImageURL String /Portals/_default/Skins/OmintSkin/cont/visa.jpg

Type String T

Installments - Installment NumberOfPayments Int 1

PaymentsAmount Decimal 100

MessageCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 19: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

19/42

8.11 Function Name: GetExchangeRate. http://p1.omintseguroviagem.com.br:7211/Currency.svc?wsdl

8.11.1 Functional Description.

After the company code has been identified, this method returns the Exchange Rate.

8.11.2 Implemetation.

This method will be implemented on OIS platform.

8.11.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters

SessionID Yes String – Session ID obtained by GetSession method.

a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

CurrencyCode Yes String USD

Date Yes Datetime 2015-08-31

Response

ExchangeRate ExchangeRate Decimal 3.58

MessageCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 20: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

20/42

8.12 Function Name: GetCities. http://p1.omintseguroviagem.com.br:7211/Emission.svc?wsdl

8.12.1 Functional Description.

After the company code has been identified, this method returns the Cities.

8.12.2 Implemetation.

This method will be implemented on OIS platform.

8.12.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters

SessionID Yes String – Session ID obtained by GetSession method.

a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

DestinationCode Yes String ARG BRA

Response

MessageCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 21: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

21/42

8.13 Function Name: GetAddressByZipCode. http://p1.omintseguroviagem.com.br:7211/Emission.svc?wsdl

8.13.1 Functional Description.

After the company code has been identified, this method returns the ZipCodes.

8.13.2 Implemetation.

This method will be implemented on OIS platform.

8.13.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters

SessionID Yes String – Session ID obtained by GetSession method.

a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

ZipCode Yes String 01454-020

Response

Address City String SAO PAULO

Neighborhood String JARDIM PAULISTANO

StateCode String SP

Street String FRANZ SCHUBERT

MessageCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 22: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

22/42

8.14 Function Name: GetVoucher http://p1.omintseguroviagem.com.br:7211/Emission.svc?wsdl

8.14.1 Functional Description.

Gets the certificate URL fot a emited Voucher.

8.14.2 Implementation.

This method is implemented on OIS.

8.14.3 Parameters and results description.

Req. Data Type Examples

Input Parameters

SessionID Yes String - Session ID obtainded from GetSession.

a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

VoucherNumber Yes string – voucher number 3000805683

Response

VoucherInfo - Voucher CompanyAmount Double 0

CompanyID Int 104

DateCreated Datetime 2015-08-24T14:12:53.693

DiscountCoupon String

HashCode String 8044013615253760

ProductCode String EU

SalesChannelCode String 002

SalesChannelType String OLN

SalesManFile String

TotalAmount Decimal 350.00

ValidFrom Datetime 2015-08-25T03:00:00

ValidTo Datetime 2015-08-31T03:00:00

VoidDate Datetime 0001-01-01T00:00:00

VoucherNumber String 3000804408

AdditionalCoverages – AdditionalCoverage[]

Code String PP

CompanyAmount Decimal 0.09

Description String Compra Protegida

EnglishName String Protected Purchase

Name String Compra Protegida

Services String

Buyer – Buyer DateOfBirth Datetime 1940-08-01T00:00:00

FirstName String LUIS

Page 23: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

23/42

Gender String M F

LastName String SILVA

IncludeInNewsLetters Int 0

Buyer - IdentityDocuments – IdentityDocument

Code String CPF

Number String 416.308.026-03

Buyer - Address City String SAO PAULO

Neighborhood String JARDIM PAULISTANO

StateCode String SP

Street String FRANZ SCHUBERT

CountryCode String

Floor String

Number String 33

OfficeOrAppartment String

ZipCode String 01454-020

Buyer - EmailAddress Email String ***@***.com.br

Buyer - Phones - Phone AreaCode String 11

Number String 99998888

Type String TELEF CELUL

DeparturePoint Code String ES

Description String Espírito Santo

ID Int 32

Destination Code String FRA

Description String França

Euro Int 1

ID 10

EmergencyContact FirstName String LUIS

LastName String SILVA

SendCopyOfVouchers Int 0

EmergencyContact - EmailAddress

Email String ***@***.com.br

EmergencyContact - Phones – Phone[]

AreaCode String 11

Number String 99998888

Type String TELEF CELUL

Payment CCExpirationDate String

CCHolder String

CCNumber String

CCSecurityCode String

FormOfPaymentCode String TMA

NumberOfPayments Int 1

BraspagTransactionID String 23618c49-c11a-44bd-b87f-02c5c6aca94a

PurposeOfTrip Code String L

Description String Lazer / Negócios

MaxQuantityOfDays Int 120

AgeRanges – AgeRange[] AgeMax Int 70

AgeMin Int 0

Code String MN MY

Travelers – TravelerBase[] FirstName String LUIS

LastName String SILVA

DateOfBirth Datetime 1940-08-01T00:00:00

Number String 1

PPE boolean 1 0

PPERelationshipCode String 1

VoucherURL String http://p1.omintseguroviagem.com.br:7219/300080440813615217445.pdf

TravelerBase - dentityDocuments - IdentityDocument

Code String CPF

Number String 416.308.026-03

Page 24: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

24/42

MessageCode int This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string - Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

9 Sales's Functions. These methods are permitted access to companies that integrate their systems with OIS.

9.1 Function Name: GetQuote. http://p1.omintseguroviagem.com.br:7211/Quotation.svc?wsdl

9.1.1 Functional Description.

Quotation. After the company code and others additional input parameters have been identified this method returns the product’s quotation.

9.1.2 Implementation.

This method will be implemented on OIS platform.

9.1.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters(GetQuoteRequest)

SessionID Yes string – Session ID obtained by GetSession method.

a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

DeparturePointCode Yes SP (São Paulo) RJ (Rio de Janeiro)

DestinationCode Yes string – Country code according to ISO 3166. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-3

ARG (Argentina) BRA (Brasil) Etc.

DiscountCoupon No

FromDate Yes DateTime - Initial day of the trip. 01/05/2011

IncludesEurope Yes Int 1 0

ProductCode Yes string – Product code. If this field is empty, this method have to quote the complete product’s list available for the requested destination.

GOLD CLIP01

PurposeOfTripCode Yes L I E

ToDate Yes DateTime – Last day of the trip. 15/05/2011

AdditionalCode- AdditionalCoverageCode[]

Code - No string 1 0

TravelersQuantity - TravelersQuantity

AgeRangeCode string MN MY

Quantity int – Age of the Passanger 1

Response (GetQuoteResponse) If the product is not given the response will be a quote’s repetitive group for each product.

GetQuoteResult - Info Amount double - Total quotation price 455.50

Page 25: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

25/42

NumberOfPayments int 1

PaymentsAmount double 455.50

QuoteUpSell String

AddicionalCoveragePrices – AdditionalCoveragePrice[]

Amount double 10

Code string PP SB

FormsOfPayment – FormOfPayment[]

Code string TVI

Description string Visa

ImageURL string /Portals/_default/Skins/OmintSkin/cont/visa.jpg

Type string T

Installments – Installment[] NumberOfPayments Int 1

PaymentsAmount double 10

MessageCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 26: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

26/42

9.2 Function Name: CreateVoucher. http://p1.omintseguroviagem.com.br:7211/Emission.svc?wsdl

9.2.1 Functional Description.

Create a new voucher. This method creates a new voucher and returns a voucher code.

9.2.2 Implementation.

This method will be implemented on OIS platform.

9.2.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters(CreateVoucherRequest)

SessionID Yes string – Session ID obtained by GetSession method. a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

VoucherData Yes VoucherRequestData – Data needed for the voucher generation.

Response (CreateVoucherResponse)

CreateVoucherResult HashCode string

PaymentURL[] string

VoucherNumber string 3000805683

Vouchers[] string

MessageCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0. See table of error codes.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

<s:Body>

<CreateVoucherResponse xmlns="http://tempuri.org/">

<CreateVoucherResult xmlns:a="http://schemas.datacontract.org/2004/07/PA_WCF"

xmlns:i="http://www.w3.org/2001/XMLSchema-instance">

<MessageCode

xmlns="http://schemas.datacontract.org/2004/07/PA_WCF.Model">0</MessageCode>

<MessageDescription

xmlns="http://schemas.datacontract.org/2004/07/PA_WCF.Model"/>

<a:HashCode/>

<a:PaymentURL i:nil="true"/>

<a:VoucherNumber>3000805683</a:VoucherNumber>

<a:Vouchers i:nil="true"

xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>

</CreateVoucherResult>

</CreateVoucherResponse>

</s:Body>

</s:Envelope>

Page 27: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

27/42

Structure Specification of the VoucherRequestData

Req. Data Type Examples

VoucherData CompanyAmount Yes double 10

DeparturePointCode Yes string SP

DestinationCode Yes string USA

DiscountCoupon No string 10

Notes No string

ProductCode Yes string GB

PurposeOfTripCode Yes string L I E

ValidFrom Yes dateTime 2015-09-01

ValidTo Yes dateTime 2015-09-15

VoucherNumber No string

AdditionalCoverage - AdditionalCoverage[]

Code No string PP

CompanyAmount No double 20

Buyer DateOfBirth Yes dateTime 1974-09-04

FirstName Yes string PAULO

Gender Yes string M F

LastName Yes string SILVA

IncludeInNewsLetters No int 0

Buyer - IdentityDocuments - IdentityDocument

Code Yes string CPF

Number Yes string 142.450.468-64

Buyer - Address City Yes string SAO PAULO

Neighborhood Yes string VILA CAMPO GRANDE

StateCode Yes string SP

Street Yes string RUA JOAO FRANCISCO DE MOURA

CountryCode Yes string BRA

Floor No string

Number Yes string 142

OfficeOrAppartment No string

ZipCode Yes string 04455-170

Buyer - EmailAddress

Email Yes string ***@***.com.br

Buyer - Phones - Phone[]

AreaCode Yes string 11

Number Yes string 99998888

Type Yes string TELEF

EmergencyContact FirstName Yes string PAULO

LastName Yes string SILVA

SendCopyOfVouchers No string 0

EmergencyContact - EmailAddress

Email Yes string ***@***.com.br

EmergencyContact - Phones - Phone[]

AreaCode Yes string 11

Number Yes string 99998888

Type Yes string TELEF

Payment CCExpirationDate No string 11/18

CCHolder No string PAULO SILVA

CCNumber No string 0000000000000001

CCSecurityCode No string 111

FormOfPaymentCode Yes string TVI

NumberOfPayments Yes int 1

Travelers - TravelerRequest []

CompanyAmount Yes double 100

DateOfBirth Yes dateTime 1974-09-04

FirstName Yes string LUIS

LastName Yes string SILVA

PPE Yes int 1

Page 28: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

28/42

PPERelationshipCode Yes string 2

TravelerRequest - IdentityDocuments - IdentityDocument

Code Yes string CPF

Number Yes string 265.307.868-16

9.3 Function Name: CancelVoucher. http://p1.omintseguroviagem.com.br:7211/Emission.svc?wsdl

9.3.1 Functional Description.

Cancels a voucher. This method cancels (voids) a voucher.

9.3.2 Implementation.

This method will be implemented on OIS platform.

9.3.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters(CancelVoucherRequest)

SessionID Yes string – Session ID obtained by GetSession method. a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

TravelerNumber Yes String – 50 characters 1 2

VoucherNumber Yes String – 50 characters 3000805683

Response (CancelVoucherResponse)

StatusCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 29: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

29/42

9.4 Function Name: QueryVouchers. http://p1.omintseguroviagem.com.br:7211/Emission.svc?wsdl

9.4.1 Functional Description.

Query vouchers. This method returns a list containing vouchers information between the specified dates.

9.4.2 Implementation.

This method will be implemented on OIS platform.

9.4.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters (SearchVouchersRequest)

SessionID Yes string – Session ID obtained by GetSession method. a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

DateFrom Yes DateTime – Begin range (inclusive).

2015-01-01

DateTo Yes DateTime - End of range (inclusive).

2015-01-30

PassengerName No String

Response(SearchVouchersResponse)

VoucherNumberList QueryVoucherResponseData [] –Voucher list.

MessageCode int – This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

QueryVoucherResponseData [] –Voucher list.

Data Types Examples

VoucherHeader AdditionalCoverages String PP

AgencyName String Cotação S/A Dist. de Tit. e Valores Mobiliários

Currency String BRL

Days Int 0

DestinationCode String USA

DestinationName String Estados Unidos

IssueDate Datetime 2015-01-02T00:00:00

IssuedTo Datetime

PassengerFirstName String LUIS

PassengerLastName String SILVA

PaymentID String

ProductCode String STGB

ProductName String Safetravel Lazer Global

ProductType String Simple

SalesPerson String

TotalAmount Double 95.9462

ValidFrom Datetime 2015-01-12T00:00:00

ValidTo Datetime 2015-01-28T00:00:00

VoidDate Datetime 0001-01-01T00:00:00

VoucherID String 71953

VoucherNumber String 000719536

Beneficiaries – BeneficiaryHeader[] DateOfBirth Datetime 1998-12-16T00:00:00

Page 30: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

30/42

FirstName String LUIS

IdentityDocumentNumber String 324.543.454-98

IdentityDocumentType String CPF

LastName String SILVA

VoucherNumber String 000719536/01

9.5 Function Name: ExtensionAuthorize. http://p1.omintseguroviagem.com.br:7211/Emission.svc?wsdl

9.5.1 Functional Description.

This method recive the voucher and a dateto in order to make an extension. Returns if the extension was able to do.

9.5.2 Implementation.

This method will be implemented on OIS platform.

9.5.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters

SessionID Yes string – Session ID obtained by GetSession method. a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

TravelerNumber Yes String – 50 characters 1 2

ValidTo Yes Datetime 2015-10-31

VoucherNumber Yes String – 50 characters 3000805683

Response

ExtensionAuthorizeResult Amount Double 100.00

AuthorizationID Int 45

StatusCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 31: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

31/42

9.6 Function Name: ExtensionOfCoverage. http://p1.omintseguroviagem.com.br:7211/Emission.svc?wsdl

9.6.1 Functional Description.

This method recive the voucher and a dateto in order to make an extension. Returns if the extension was able to do.

9.6.2 Implementation.

This method will be implemented on OIS platform.

9.6.3 Parameters description and results description.

Req. Data Type Examples

Input Parameters

SessionID Yes string – Session ID obtained by GetSession method.

a6QSSZBgLf0TTcktSNteeSg3qXsMVjo/F5py/Gtw7xucTrUWbsrVCdIoGE8Cm1bixpuVPlr58k6n

AuthorizationID Yes Int 1 2

CompanyAmount Yes double 10.00

Payment CCExpirationDate Yes String

CCHolder Yes String

CCNumber Yes String

CCSecurityCode Yes String

FormOfPaymentCode Yes String TMA

NumberOfPayments Yes Int 1

Response

PaymentURL String

TravelerNumber Yes String – 50 characters 1 2

VoucherNumber Yes String – 50 characters 3000805683

VoucherURL String

StatusCode int - This message code indicates whether the operation was completed properly or not. If the operation was successful the code is 0.

0

MessageDescription string – Descriptive text of the message. If the operation was successful this field is not applied, otherwise it reports the error message.

Page 32: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

32/42

10 Appendix – References Tables.

10.1 Document types table.

Company Code Description

AR DNI National identity document

PAS Passport

CUIT Unique code identification tax

BR RG General Registry

PAS Passport

CPF Cadastro de Pessoa Fisica

CNPJ Cadastro Nacional da Pessoa Jurídica

10.2 Currency table Currency code according to ISO4217 standar.

Code Description

ARS Pesos Argentinos

BRL Reales

USD Dólar estadounidense

10.3 Relationship table

Company Code Description

AR 1 Conyuge – Spouse

2 Hijo – Son

9 Otro - Other

BR Not apply to Brazil

10.4 Tax Conditions Table

Company Code Description

AR 1 IVA Resp. Inscripto

2 IVA Resp. No Inscripto

3 Exento

4 N/A

BR Not apply to Brazil

Page 33: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

33/42

10.5 Method of payment / Sale conditions - table

Company Code Description

AR 1 Efectivo

2 Tarjeta de crédito

3 Tarjeta de débito (actualmente no habilitada)

4 Otras

BR Not apply to Brazil, our payments are handled by Braspag gateway

10.6 Invoice types table

Company Code Description

AR A Factura A

B Factura B

C Factura C

NC Nota de crédito

ND Nota de débito

BR 1 Venda PF One Short - Cartão de Crédito

2 Venda PF One Short - Débito em Conta

3 Venda PJ Bloco de Dias

4 Faturamento PJ de Contratos

10.7 Table of Group Companies

Company Code Description

AR 1 OMINT

2 CS Salud

3 San Timoteo

4 Omint Travel

BR 1 Omint Saude

2 Del Sol

3 Omint Travel

10.8 Table of Credit Card types

Company Code Description

AR Nowadays this table doesn't apply because the payments are managed by ERP system.

BR Not apply to Brazil, our payments are handled by Braspag gateway

Page 34: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

34/42

10.9 Table of Credit Cards

Code Description

TVI Visa

TMA Mastercard

DIN Dinners Club

TAM American Express

ELO Elo

HCD Hipercard

EFV Faturamento Omint

10.10 Table of P.P.E

Code Description

1 Avô/Avó

2 Cônjuge

3 Filho(a)

4 Irmã(o)

5 Mãe

6 Neto(a)

7 Outros

8 Pai

9 Sobrinho(a)

10 Tio(a)

11 Companheiro(a)

12 Noivo(a)

13 Amigo(a)

14 Primo(a)

15 Estipulante

16 Herdeiro Legal

Page 35: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

35/42

10.11 Table of Error Codes

11.10.10

Login Failed

11.10.20

Invalid Country Code

11.10.30

Invalid Language Code

11.10.40

Invalid SellerID

11.10.50

Invalid Sales Man File

11.20.10

Invalid Login Token

11.30.10

You have no permission to execute Service [@0] - Method

[@1].

20.40.010

Invalid Product Code [@0].

20.40.020

Invalid Purpose Of Trip [@0].

20.40.030

Invalid Departure Point Code [@0].

20.40.040

Invalid Destination Code [@0].

20.40.050

Invalid Includes Europe Code [@0].

20.40.060

Invalid From Date. Must be greater than [@0].

20.40.070

Invalid To Date. Must be greater than From Date.

20.40.080

Invalid To Date. Must be less than [@0].

20.40.090

Invalid Age Range Code [@0].

20.40.100

Invalid Traveler Quantity [@1] for age range code [@0].

Page 36: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

36/42

20.40.110

Invalid Discount Coupon [@0].

20.40.130

Invalid Additional Coverage Code [@0].

20.40.140

Invalid Price Additional Coverage Code [@0].

20.40.120

Invalid Travelers Quantity.

20.50.010

Invalid Purpose Of Trip [@0].

20.50.020

Invalid Destination Code [@0].

20.50.030

Invalid Includes Europe Code [@0].

20.50.040

Invalid From Date. Must be greater than [@0].

20.50.050

Invalid To Date. Must be greater than From Date.

20.70.010

Invalid Purpose Of Trip [@0].

20.70.020

Invalid Destination Code [@0].

20.70.030

Invalid Includes Europe Code [@0].

20.70.040

Invalid Additional Coverage Code [@0].

20.80.010

Invalid Purpose Of Trip Code [@0].

20.90.010

Invalid Departure Point Code [@0].

30.10.10

Error Reported By Web Service

40.10.010

Invalid Document Type Code [@0].

40.20.010

Invalid Destination Code [@0].

Page 37: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

37/42

40.30.010

Voucher Amount Can't Be Zero.

40.40.010

Traveler Not Found.

40.50.010

Commission Type Not Found.

40.50.020

Company Amount Must Be Zero.

40.50.025

Company Amount Must Greater Than Zero.

40.50.030

From Date Must Be Greater Than Today.

40.50.040

From Date Must Be Less Than [@0] Days.

40.50.050

To Date Must Be Greater Than From Date.

40.50.060

To Date Must Be Less Than [@0] Days.

40.50.070

Invalid Additional Coverage [@0].

40.50.080

Must Inform First Name.

40.50.090

Must Inform Last Name.

40.50.100

Must Inform At Least One Identity Document.

40.50.110

Must Inform At Least One Identity Document Of Type [@0].

40.50.120

Invalid Identity Document [@0 - @1].

40.50.130

Date Of Birth Must Be Minor Than Today [@0].

40.50.140

Buyer Must Be At Least [@0] Years Old.

40.50.150

Buyer Must Be At Most [@0] Years Old.

Page 38: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

38/42

40.50.160

Must Inform An Address For Buyer.

40.50.170

Must Inform The Street For Buyer.

40.50.180

Must Inform The Door Number For Buyer.

40.50.190

Must Inform The City For Buyer.

40.50.200

Must Inform The Country For Buyer.

40.50.210

Must Inform The Neighborhood For Buyer.

40.50.220

Must Inform The State For Buyer.

40.50.230

Must Inform The Zip Code For Buyer.

40.50.240

Must Inform The Email Address For Buyer.

40.50.250

Invalid Email Address For Buyer.

40.50.260

Invalid Include In Newsletter Value [@0].

40.50.270

Must Inform At Least One Phone Number For Buyer.

40.50.280

Invalid Phone Number Type [@0] For Buyer.

40.50.290

Invalid Phone Number [@0] For Buyer.

40.50.300

Traveler [@1 - @2] Must Inform First Name.

40.50.310

Traveler [@1 - @2] Must Inform Last Name.

40.50.320

Traveler [@1 - @2] Must Inform At Least One Identity

Document.

40.50.330

Traveler [@1 - @2] Must Inform At Least One Identity

Document Of Type [@0].

Page 39: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

39/42

40.50.340

Traveler [@2] Invalid Identity Document [@0 - @1].

40.50.350

Traveler [@1 - @2] Date Of Birth Must Be Minor Than Today

[@0].

40.50.360

Traveler [@1 - @2] Must Be At Least [@0] Years Old.

40.50.370

Traveler [@1 - @2] Must Be At Most [@0] Years Old.

40.50.375

Traveler [@1 - @2] Invalid Date Of Birth [@0].

40.50.380

Traveler [@0 - @1] With Multiple Active Voucher.

40.50.380

Must Inform First Name For Emergency Contact.

40.50.390

Must Inform Last Name For Emergency Contact.

40.50.400

Must Inform The Email Address For Emergency Contact.

40.50.410

Invalid Email Address For Emergency Contact.

40.50.420

Must Inform At Least One Phone Number For Emergency Contact.

40.50.430

Invalid Phone Number Type [@0] For Emergency Contact.

40.50.440

Invalid Phone Number [@0] For Emergency Contact.

40.60.010

Traveler Number [@0] Not Found.

40.60.020

Voucher [@0] Canceled on date [@1].

40.60.030

Unpaid Voucher [@0]

40.70.010

Traveler [@1] Not Found For Voucher [@0].

40.70.020

Buyer Is Not Traveling For Voucher [@0].

Page 40: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

40/42

40.70.030

Voucher [@0] Already Canceled On Date [@1].

40.70.040

Could Not Cancel Voucher [@0] On Support System.

40.70.050

Could Not Cancel Payment For Voucher [@0].

40.80.010

This person has no active vouchers.

40.80.020

Invalid Voucher Number For This Person.

40.90.010

Invalid From Date. Must Be Minor Than Today.

40.90.020

Invalid To Date. Must be greater than From Date.

40.100.10

Extencion Autorization Has Failure for Traveler [@0]

40.200.10

Traveler [@1] Not Found For Voucher [@0]

40.200.20

Voucher [@0] is Already Canceled On Date [@1]

40.200.30

Product [@1] Not Found For Voucher [@0]

40.200.40

Voucher Extecion [@0] Exceed [@1] the Coverage days.

40.200.50

Unable to extend date [@0] within past the 24 hour.

40.200.60

Extension Date Must Be Greater Than [@0].

40.200.70

The extension should be taken an hour before the coverage

starts.

40.300.10

The Product [@0] Extension Amount Is Not Loaded.

40.400.010

Extension date must be less than the current.

40.500.010

Invalid Additional Coverage Code [@0].

Page 41: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

41/42

40.500.020

Invalid Price Additional Coverage Code [@0].

50.30.010

Invalid Form Of Payment Code [@0].

50.30.020

Invalid Number Of Payments [@0].

50.30.030

Invalid Credit Card Holder [@0].

50.30.040

Invalid Credit Card Number [@0].

50.30.050

Invalid Credit Card Expiration Date [@0].

50.30.060

Invalid Credit Card Security Code [@0].

50.30.070

Voucher Already Paid [@0].

50.30.080

Invalid Form Of Payment Code [@0] For An Emission With

Discount Coupon.

60.10.010

Must Inform Email Address.

60.10.020

Invalid Email Address.

60.20.010

Must Inform Email Address.

60.20.020

Invalid Email Address.

60.30.010

Must Inform Full Name.

60.30.020

Must Inform Blog Line.

60.30.030

Must Inform Subject.

60.30.040

Must Inform Comment.

60.40.010

Email Address cannot be null.

Page 42: Version 1.0 - Omint Mar16.pdf · WCF Specification I.T. Omint Version 1.0.0 Date: 01/09/2015 Analysis and Development 5/42 1 Introduction This document it is a reference for developers

WCF Specification

I.T. Omint Version 1.0.0

Date: 01/09/2015 Analysis and Development

42/42

60.40.020

Invalid Email Address.

70.10.010

Invalid Voucher [@0].

80.10.010

Invalid Product Code [@0].

80.10.020

Valid From Must Be Greater Than Today.

80.10.030

Invalid TotalAmount

80.10.040

Company Amount Must Be Zero.

80.10.050

Company Amount Must Greater Than Zero.

80.10.060

Invalid Discount Coupon [@0].

00.00.10

Inactive Session.

00.00.20

Internal Error [@0]

40.50.450

Max days of coverage ([@0]) exceeded.

40.50.460

Só é permitida a compra do seguro viagem desde que a

vigência ou inicio da viagem seja inferior à [@0]. Para maiores

informações 0800 727 3001.

90.10.010

Invalid Old Password.

90.10.020

Invalid New Password.

100.20.010

SalesMan [@0] does not exists.