WCF WebServices Interface

Kód chyby	MemberName	MemberValue	Popis
D002	AcInstallationDate		Chybějící element. Povinný pro typ Claimu: AC, SOPE_AC.
D002	AcInstallationMileage		Chybějící element. Povinný pro typ Claimu: AC, SOPE_AC.
D001	Cause	Cause	Délka je větší než 50 znaků.
D002	Cause		Chybějící element.
D001	ClaimDate	ClaimDate	ClaimDate musí být menší nebo rovno aktulnímu datu a času.
D001	Condition	Condition	Délka je větší než 50 znaků.
D002	Condition		Chybějící element.
D001	DeliveryDate	DeliveryDate	Je větší než aktuální datum.
D002	DeliveryDate		Chybějící element. Povinný pro typ Claimu TEC a pokud je Mileage > 100
D001	DlrClaimNo	DlrClaimNo	Délka mezi 1-6. Může obsahovat písmena a číslice. RegEx: ^[a-z0-9A-Z]{1,6}$
D002	DlrClaimNo		Chybějící element.
D002	DlrCode		Chybějící element.
D001	MidtronicFirstTest1	MidtronicFirstTest1	Právě 10 písmen nebo číslic, nesmí obsahovat písmena I, O, Q, S. RegEx: ^(?!.*[iIoOqQsS])[a-z0-9A-Z]{10}$
D002	MidtronicFirstTest1	MidtronicFirstTest1	Povinný pokud hlavní díl zaciná na 28800 nebo hlavní operace je jedna z 190011,190011A,190031, 19099.
D001	MidtronicFirstTest2	MidtronicFirstTest2	Právě 10 písmen nebo číslic, nesmí obsahovat písmena I, O, Q, S. RegEx: ^(?!.*[iIoOqQsS])[a-z0-9A-Z]{10}$
D001	MidtronicLastTest1	MidtronicLastTest1	Právě 10 písmen nebo číslic, nesmí obsahovat písmena I, O, Q, S. RegEx: ^(?!.*[iIoOqQsS])[a-z0-9A-Z]{10}$
D001	MidtronicLastTest2	MidtronicLastTest2	Právě 10 písmen nebo číslic, nesmí obsahovat písmena I, O, Q, S. RegEx: ^(?!.*[iIoOqQsS])[a-z0-9A-Z]{10}$
D001	Mileage	Mileage	Je větší rovno 1 000 000.
D002	Operations		Chybějící element. Povinný u všech typů kromě P2.
D005	Operations		Kolekce může obsahovat max 10 elementů.
SD002	Operations		Právě jedna operace musí být hlavní.
D006	Opertaions		Kolekce muže obsahovat min 1 element.
D002	P1PreviousMileage		Chybějící element. Povinný pro typ Claimu: P1, SOPE_P1.
D002	P1PreviousRepairDate		Chybějící element. Povinný pro typ Claimu: P1, SOPE_P1.
D002	P1PreviousRepairDate		Chybějící element. Povinný pro typ Claimu: P1, SOPE_P1.
D002	P2PreviouisSalesInvoicDate		Chybějící element. Povinný pro typ Claimu P2.
D002	P2PreviousSalesInvoiceNo		Chybějící element. Povinný pro typ Claimu P2.
D002	P2SalesInvoiceDate		Chybějící element. Povinný pro typ Claimu P2.
D002	P2SalesInvoiceNo		Chybějící element. Povinný pro typ Claimu P2.
D005	Parts		V kolekci může být max. 99 part elementů.
SD001	Parts		Kolekce obsahuje víc než jeden hlavní díl.
D002	Positions		Chybějící element. Povinné pokud hlavní operace začíná na N,P,R.
D005	Positions		Kolekce může obsahovat max. 10 position elementů.
D001	ReceptionDate	ReceptionDate	ReceptionDate musí být menší nebo rovno RepairDate.
D001	Remedy	Remedy	Délka je větší než 50 znaků.
D002	Remedy		Chybějící element.
D001	RepairDate	RepairDate	RepairDate musí být menší nebo rovno ClaimDate.
D001	RepairOrderNo		Délka mezi 1-20, Může obsahoavt písmena a číslice. RegEx: ^[a-z0-9A-Z]{1,20}$
D002	RepairOrderNo		Chybějící element.
D005	Sublets		Kolekce může obsahovat max. 12 sublet elementů.
D001	T1	T1	Právě 2 znaky. RegEx: ^[a-z0-9A-Z]{2}$
D002	T1		Chybějící element.
D001	T2	T2	Právě 2 znaky. RegEx: ^[a-z0-9A-Z]{2}$.
D002	T2		Chybějící element.
D002	VIN		Chybějící element. Je povinný pro typ Claimu: VE, AC, P1, SOPE_VE, SOPE_AC, SOPE_P1, TEC.

OperationFault chyby

OperationFault

Kód chyby	MemberName	MemberValue	Popis
O003	DlrClaimNo	DlrClaimNo	Objekt Claim s DlrClaimNo již existuje v databázi TMCZ.
O001	DlrCode	DlrCode	Delaer nenalezen v databázi TMCZ.
O002	Operations		Kolekce musí obsahovat pouze platné operace.
O002	Parts		Kolekce musí obsahovat pouze platná čísla náhradních dílů.
O002	Positions		Kolekce musí obsahovat pouze platné PositionCodes
O002	Sublets		Kolekce musí obsahovat pouze platné SubletCodes.
O001	T1	T1	T1 kód nenalezen v databázi TMCZ.
O001	T2	T2	T2 kód nenalezen v databázi TMCZ.
O001	VIN	VIN	VIN nenalezen v databázi TMCZ.

Part

ObjectName =Claims

MemberName = Claim

MemberValue = DlrClaim

Objec tName = Claim

ObjectID = DlrClaimNo

MemberName = Parts

MemberValue = PartNumbers

ObjectName = Parts

MemberName = Part

MemberValue = PartNo

ObjectName = Part

ObjectID = PartNo

DataFault chyby

· DataFault

Kód	MemberName	MemberValue	Popis
D001	ClaimedAmount	ClaimedAmount	Musí být mezi 0 – 10 000 000.
D001	ClaimedQty	ClaimedQty	Musí být mezi 0 – 99.
D001	PartDescription	PartDescription	Délka může být max. 50 znaků.
D001	PartNo	PartNo	RegEx: ^([a-z0-9A-Z]{5}-[a-z0-9A-Z]{5}-[a-z0-9A-Z]{1,2})$\|^([a-z0-9A-Z]{5}-[a-z0-9A-Z]{1,5})$\|^([a-z0-9A-Z]{3,5})$
D002	PartNo		Chybějící element.

OperationFault chyby

OperationFault

Kód chyby

MemberName

MemberValue

Popis

O001

PartCode

PartCode nanalezen databázi TMCZ.

Opeation

ObjectName =Claims

ObjectID =DlrClaimNo

MemberName = Claim

MemberValue = DlrClaim

Objec tName = Claim

Objec tID = DlrClaimNo

MemberName =Operations

MemberValue =OperationCodes

ObjectName = Operations

MemberName =Operation

MemberValue = OperationCode

ObjectName = Operation

ObjectID = OperationCode

DataFault chyby

· DataFault

Kód	MemberName	MemberValue	Popis
D002	ClaimedHours		Povinný pokud na 4. a 5. místě v OperationCode je „99“ nebo na 6. místě „Z“
D001	OperationCode	OperationCode	RegEx: ^[a-z0-9A-Z-]{2,10}$
D002	OperationCode		Chybějící element.
D001	OperationDescription	OperationDescription	Délka může být max 100 znaků.
D002	OperationDescription		Povinný pokud na 4. a 5. místě v OperationCode je „99“ nebo na 6. místě „Z“

OperationFault chyby

· OperationFault

Kód chyby

MemberName

MemberValue

Popis

O001

OperationCode

OperationCode nanalezen databázi TMCZ.

Sublet

ObjectName =Claims

ObjectID =DlrClaimNo

MemberName = Claim

MemberValue = DlrClaim

Objec tName = Claim

MemberValue = DlrClaimNo

MemberName = Sublets

MemberValue = SubletCodes

ObjectName = Sublets

MemberName = Sublet

MemberValue = SubletCode

ObjectName = Sublet

ObjectID = SubletCode

DataFault chyby

· DataFault

Kód	MemberName	MemberValue	Popis
D001	ClaimedAmount	ClaimedAmount	Musí být mezí 0 – 10 000 000.
D001	SubletCode	SubletCode	RegEx: ^[a-z0-9A-Z]{2}$
D002	SubletCode		Chybějící element.
D001	SubletComment	SubletComment	Délka může být max 150 znaků.
D001	SubletDescription	SubletDescription	Délka může být max 150 znaků.
D001	SubletInvoiceNo	SulbetInvoiceNo	Délka mezi 2-20. RegEx: ^[a-z0-9A-Z/-]{2,20}$

OperationFault chyby

· OperationFault

Kód chyby

MemberName

MemberValue

Popis

O001

SubletCode

SubletCode nenalezen databázi TMCZ.

PositionCode

ObjectName =Claims

ObjectID =DlrClaimNo

MemberName = Claim

MemberValue = DlrClaim

Objec tName = Claim

MemberValue = DlrClaimNo

MemberName = Positions

MemberValue =PositionCodes

ObjectName = Positions

MemberName = Position

MemberValue = PositionCode

ObjectName = Position

ObjectID = PositionCode

DataFault chyby

· DataFault

Kód

MemberName

MemberValue

Popis

D002

PositionCode

Chybějící element.

D001

PositionCode

RegEx: ^[NPRnpr]{1}[0-9]{4}$

OperationFault chyby

OperationFault

Kód chyby

MemberName

MemberValue

Popis

O001

PositionCode

PositionCode nenalezen databázi TMCZ.

GetClaimStatus

ClaimStatuses GetClaimStatus(string[] ClaimNumbers, string DealerCode)

Metoda pro získání stavu záručních protokolů.

· Sample Request: http://schemas.toyota.cz/WCF/Service01/Samples/ClaimService1.GetClaimStatus_REQUEST.xml

· Sample Response XML: http://schemas.toyota.cz/WCF/Service01/Samples/ClaimService1.GetClaimStatus_RESPONSE.xml

GetClaimNumbers

string[] GetClaimNumbers(DateTime ReceiveDateFrom, DateTime ReceiveDateTo, string DealerCode)

Metoda pro získání čísel záručních protokolů v časovém období.

· Sample Request: http://schemas.toyota.cz/WCF/Service01/Samples/ClaimService1.GetClaimNumbers_REQUEST.xml

· Sample Response XML: http://schemas.toyota.cz/WCF/Service01/Samples/ClaimService1.GetClaimNumbers_RESPONSE.xml

GetClaim

Claims GetClaim(string[] ClaimNumbers, string DealerCode)

Metoda pro získání záručních protokolů.

· Sample Request: http://schemas.toyota.cz/WCF/Service01/Samples/ClaimService1.GetClaim_REQUEST.xml

· Sample Response XML: http://schemas.toyota.cz/WCF/Service01/Samples/ClaimService1.GetClaim_RESPONSE.xml

InvoiceService

Služba pokrývající informace o fakturách záručních protokolů,

· URL testovací: https://wstest.toyota.cz/Service01/InvoiceService1.svc

WSDL testovací: http://schemas.toyota.cz/WCFtest/Service01/InvoiceService1.wsdl.zip
URL produkční: https://ws.toyota.cz/Service01/InvoiceService1.svc
WSDL produkční: http://schemas.toyota.cz/WCF/Service01/InvoiceService1.wsdl.zip

Struktury

Dokumentace:

· http://schemas.toyota.cz/WCF/Service01/Documentation/InvoiceService1.Service/InvoiceService1.Service.html

· http://schemas.toyota.cz/WCF/Service01/Documentation/InvoiceService1.Well/InvoiceService1.Well.html

Metody

GetInvoiceNumbers

string[] GetInvoiceNumbers(DateTime CreateDateFrom, DateTime CreateDateTo, string DealerCode)

Metoda pro získání čísel faktur vystavených za reklamační protokoly v časovém období.

· Sample Request: http://schemas.toyota.cz/WCF/Service01/Samples/InvoiceService1.GetInvoiceNumbers_REQUEST.xml

· Sample Response XML: http://schemas.toyota.cz/WCF/Service01/Samples/InvoiceService1.GetInvoiceNumbers_RESPONSE.xml

GetInvoice

ClaimInvoiceCollection_INO GetInvoice(string[] InvoiceNumbers, string DealerCode)

Metoda pro získání faktur za reklamační protokoly.

· Sample Request: http://schemas.toyota.cz/WCF/Service01/Samples/InvoiceService1.GetInvoice_REQUEST.xml

· Sample Response XML: http://schemas.toyota.cz/WCF/Service01/Samples/InvoiceService1.GetInvoice_RESPONSE.xml

Chybové Zprávy ze Servisní domény

Chybové zprávy ze Servisní domény.

Struktury

Dokumentace

· http://schemas.toyota.cz/WCF/Service01/Documentation/Faults/Faults.html

Obecné definice

· GeneralFault

· DataFault

· OperationFault

DataFault

Struktury

http://schemas.toyota.cz/WCF/Service01/Documentation/Faults/Faults.html#Link00000000

Obecné definice

· DataFault

Definice kódů ze servisní domény

Možné chybové kódy ze servisní domény a jejich popisy.

Kód	Popis
SD001	Main part must be just one.
SD002	Main operation must be just one.

OperationFault

Struktury

· http://schemas.toyota.cz/WCF/Service01/Documentation/Faults/Faults.html#Link00000006

Obecné definice

· OperationFault

Definice kódů ze servisní domény

Možné chybové kódy ze servisní domény a jejich popisy.

Kód	Popis
SO001	Authorization is not working. Dealer code could not be obtained.
SO002	Cannot insert claim with another dealer code. Dealer with appropriate code must be logged in.

AUTHORIZATION

Rozhraní, která se týkají ověřování identity a přístupových práv TMCZ+DLR uživatelů k externím webovým aplikacím.

AuthorizationService

Služba pokrývající autentizaci a autorizaci doménových uživatelů TMCZ/TMSK+partnerů do extranetových aplikací.

URL testovací: https://wstest.toyota.cz/Authorization01/AuthorizationService1.svc
WSDL testovací: http://schemas.toyota.cz/WCFtest/Authorization01/AuthorizationService1.wsdl.zip
URL produkční: https://ws.toyota.cz/Authorization01/AuthorizationService1.svc
WSDL produkční: http://schemas.toyota.cz/WCF/Authorization01/AuthorizationService1.wsdl.zip

Standardní ověřovací schéma je:

· Uživatel přichází na (vaši) www aplikaci – teoreticky do libovolné cesty

· Když aplikace zjistí neověřeného klienta, přesměruje ho na přihlašovací stránku na serveru TMCZ

· Pokud uživatel zadá platné jméno a heslo a má práva k aplikaci (alespoň 1 roli), je přesměrován zpět a v URL je uveden unikátní klíč session

· Aplikace zavolá AuthorizationService, aby ověřila pravost klíče a případně zjistila rozsah oprávnění a případně detaily uživatele a jeho firmy/pobočky.

Struktury

Dokumentace:

· http://schemas.toyota.cz/WCF/Authorization01/Documentation/AuthorizationService1.Authorization/AuthorizationService1.Authorization.html

· http://schemas.toyota.cz/WCF/Authorization01/Documentation/AuthorizationService1.Well/AuthorizationService1.Well.html

Metody

Pro autentizaci (ověření ticketu) a autorizaci (získání rolí) lze použít metodu:

· Session GetSessionByTicket(int applicationID, string sessionTicketValue)

Tato metoda poskytuje (v kombinaci s PartyService) všechny dostupné údaje. Pokud je aplikace nepotřebuje, lze místo toho v zájmu rychlejšího volání využít následující redukované metody:

· Roles GetRolesByTicket(int applicationID, string sessionTicketValue)

· Boolean HasRoleByTicket(int applicationID, int roleID, string sessionTicketValue)

Pro získání objetku session z Credentials slouží metoda:

· Session GetSessionByCredentials(int applicationID, string username, string domain, string password)

Pro zpětnou kompatibilitu jsou k dispozici i následující metody:

· Company HasRoleGetOrganizationDetailsByTicket(int applicationID, int roleID, string sessionTicketValue)

· Person GetIdentityPersonByTicket(string sessionTicketValue)

· Company GetIdentityCompanyByTicket(string sessionTicketValue)

· Parties GetIdentityPartiesByTicket(string sessionTicketValue)

Jejich použití však nedoporučujeme.

GetSessionByTicket

Session GetSessionByTicket(int applicationID, string sessionTicketValue)

Vrací objekt Session, pokud je session stále platná. V něm je obsaženo login a displayName uživatele, seznam jeho rolí a odkazy na podrobné objekty Party fyzické osoby uživatele a jeho organizace (firmy). Ty lze následně získat voláním služby PartyService.GetParty

· Sample Request: http://schemas.toyota.cz/WCF/Authorization01/Samples/AuthorizationService1.GetSessionByTicket_REQUEST.xml

· Sample response XML: http://schemas.toyota.cz/WCF/Authorization01/Samples/AuthorizationService1.GetSessionByTicket_RESPONSE.xml

GetRolesByTicket

Roles GetRolesByTicket(int applicationID, string sessionTicketValue)

Vrací kolekci rolí přiřazených uživateli, pokud je session platná.

· Sample Request: http://schemas.toyota.cz/WCF/Authorization01/Samples/AuthorizationService1.GetRolesByTicket_REQUEST.xml

· Sample response XML: http://schemas.toyota.cz/WCF/Authorization01/Samples/AuthorizationService1.GetRolesByTicket_RESPONSE.xml

HasRoleByTicket

Boolean HasRoleByTicket(int applicationID, int roleID, string sessionTicketValue)

Vrací true, pokud je session platná a uživatel má danou roli, jinak false.

· Sample Request: http://schemas.toyota.cz/WCF/Authorization01/Samples/AuthorizationService1.HasRoleByTicket_REQUEST.xml

· Sample response XML: http://schemas.toyota.cz/WCF/Authorization01/Samples/AuthorizationService1.HasRoleByTicket_RESPONSE.xml

GetSessionByCredentials

Session GetSessionByCredentials(int applicationID, string username, string domain, hh password)

Vrací objekt Session pokud jsou platná credentials. V případě chybných credentials vrací null.

· Sample Request:

http://schemas.toyota.cz/WCF/Authorization01/Samples/AuthorizationService1.GetSessionByCredentials_REQUEST.xml

· Sample response XML:

http://schemas.toyota.cz/WCF/Authorization01/Samples/AuthorizationService1.GetSessionByCredentials_RESPONSE.xml

Uživatelská přihlašovací stránka

· URL testovací: http://briantest.corp.toyota.cz/Authenticate.aspx?ApplicationId=n

http://briantest.corp.toyota.cz/Logout.aspx

URL produkční: http://brian.corp.toyota.cz/Authenticate.aspx?ApplicationId=n

http://brian.corp.toyota.cz/Logout.aspx

Povinný parametr:

· ApplicationId – ID aplikace (int, přidělí vám ho TMCZ)

Volitelný parametr:

· RedirPath – relativní nebo absolutní cesta, na kterou se má klient vrátit. Není-li uveden, je klient přeměrován na URL referrer, případně na úvodní stránku aplikace

Návratový parametr:

· TicketValue – unikátní ověřovací identifikátor (guid)

Uživatel může zrušit přihlášení (session) vůči TMCZ pomocí Logout.aspx. Při dalším přístupu na stránku Authenticate.aspx je opět vyzván k zadání jména/hesla. Pokud existuje aktivní ticket pro danou aplikaci a uživatele, použije se a prodlouží.

Faults

Typyzované návratové chyby TMCZ.

GeneralFault

Tato chyba se používá v případě neošetřené vyjímky. Např. databázový server není k dispozici apod.

Struktury

Dokumentace

· http://schemas.toyota.cz/WCF/Documentation/Faults/Faults.html#Link00000004

Definice kódů

Možné chybové kódy a jejich popisy.

Kód	Popis
G001	General error occured on the server

DataFault

Používá se v případě, že lient pošle nesprávný DataContract. Např. V objektu objednávka bude chybět číslo objednávky. DataFault navíc obsahuje kolekcí dalších DataFault.

Struktury

Dokumentace

· http://schemas.toyota.cz/WCF/Documentation/Faults/Faults.html#Link00000001

Definice kódů

Možné chybové kódy a jejich popisy.

Kód	Popis
D001	Value is invalid.
D002	Data Member (element) is missing.
D003	Value can not be null.
D004	Fault is in inner object (element).
D005	Maximum count of items is exceeded.
D006	Minimum count of items is not exceeded.

OperationFault

Používá se v případě, že ošetřená chyba nastane u metody. Např. object neexistuje nebo je ve špatném stavu apod.

Struktury

Dokumentace

· http://schemas.toyota.cz/WCF/Documentation/Faults/Faults.html#Link00000007

Definice kódů

Možné chybové kódy a jejich popisy.

Kód	Popis
O001	Object not found in system or database.
O002	Object is in wrong state.
O003	Object already exists in system/database.