Siomething

مستند فنی مشخصات لایه سرویس سامانه بانکداری متمرکز

This document listed the Restfull Services APIs and Models.

Abstract

این مستند اطلاعات مرتبط با سرویسهای سامانه را تشریح کرده است

Version & contact information

Version	Date	Produced By	Contact Email	Website	Base Path
1.0.0	2015-29-13	Osveh Co.	Osveh Email	http://www.osveh.com	http://

License & Agreements

Licence:

 کلیه حقوق این مستند متعلق به شرکت اسوه ایران می باشد

Terms of Service:

 هر گونه استفاده از این مستند منوط به اخذ مجوز کتبی از شرکت اسوه ایران می باشد

سرویس های مرتبط با شخص

 /person

---

Paths

/person

getPerson

Path	Method	Nickname	Return Type	Summary	Notes
/person	GET	getPerson	Person	Returns Defualt person	با اجرای این متد سرویس یک شی از نوع شخص بصورت پیش فرض برگردانده میشود

Responses

Code	Message
200	OK
500	خطای سیستمی در سرور رخ داده است

Produces

• application/json

Consumes

• application/json

addPerson

Path	Method	Nickname	Return Type	Summary	Notes
/person	POST	addPerson	C5	ثبت یک شخص جدید

Parameters

Name	Description	Type	Required	Param Type
person	پپارامتر متد شی ای از نوع شخص است	Person	true	body

Responses

Produces

• application/json

Consumes

• application/json

/{personid}

getPersonByID

Path	Method	Nickname	Return Type	Summary	Notes
/{personid}	GET	getPersonByID	Person	دریافت شی شخص با استفاده از شناسه شخص

Parameters

Name	Description	Type	Required	Param Type
personid	کد شخص بعنوان پارامتر ورودی	String	true	body

Responses

Produces

• application/json

Consumes

• application/json

Models

C5

 C5
 Model ID: C5

Property Name	Description	Type	Required
a	a	String	false
c6	c6	List<C6>	false

C6

 C6
 Model ID: C6

Property Name	Description	Type	Required
name	name	String	false
code	code	String	false

Person

 Person resource representation
 Model ID: Person

Property Name	Description	Type	Required
phoneNo	شماره تلفن ثابت عدی بطول حداکثر 10 رقم	String	true
lastName	نام خانوادگی شخص به حداکثر طول 35	String	true
email	ایمیل شخص	String	true
firstName	نام شخص به حداکثر طول 35	String	true

Say Hello!

 /hello

---

Paths

/hello2

sayHello2

Path	Method	Nickname	Return Type	Summary	Notes
/hello2	GET	sayHello2	Map<String,List<TestT>>	Say Hello World	Anything Else?

Parameters

Name	Description	Type	Required	Param Type
param	Map	Map<String,CInfo<C3>[]>	true	body

Responses

Code	Message
200	OK
500	Something wrong in Server

Produces

• application/json

Consumes

• application/json

/hello

sayBye

Path	Method	Nickname	Return Type	Summary	Notes
/hello	POST	sayBye	List<State>	Say Bye World	Anything Else?

Parameters

Name	Description	Type	Required	Param Type
param	List	List<String>	true	body

Responses

Code	Message
200	OK
500	Something wrong in Server

Produces

• application/json

Consumes

• application/json

sayByeBye

Path	Method	Nickname	Return Type	Summary	Notes
/hello	POST	sayByeBye	City[]	Say Bye World	Anything Else?

Parameters

Name	Description	Type	Required	Param Type
param	long[]	long[]	true	body

Responses

Code	Message
200	OK
500	Something wrong in Server

Produces

• application/json

Consumes

• application/json

sayHello

Path	Method	Nickname	Return Type	Summary	Notes
/hello	GET	sayHello	C5,List<State>	Say Hello World	Anything Else?

Parameters

Name	Description	Type	Required	Param Type
address	آدرس مشتری	Address	true	body
cInfo	اطلاعات تکمیلی	C5	true	body
states	استانهای مشتریی	List<State>	true	body

Responses

Produces

• application/json

Consumes

• application/json

Models

Address

 Address
 Model ID: Address

Property Name	Description	Type	Required
description	جزییات آدرس	String	true
state	استان	State	true
city	شهر	City	true

C3

 C3
 Model ID: C3

Property Name	Description	Type	Required
json	json	Json	false
c4List	c4List	List<C4>	false

C4

 C4
 Model ID: C4

Property Name	Description	Type	Required
l	l	long	false

TestT

 TestT
 Model ID: TestT

Property Name	Description	Type	Required
json	json	Json	false

C5

 C5
 Model ID: C5

Property Name	Description	Type	Required
a	a	String	false
c6	c6	List<C6>	false

City

 City resource representation
 Model ID: city

Property Name	Description	Type	Required
name	نام شهر	String	true
code	کد شهر	String	true

C6

 C6
 Model ID: C6

Property Name	Description	Type	Required
name	name	String	false
code	code	String	false

State

 City resource representation
 Model ID: city

Property Name	Description	Type	Required
name	name	String	false
code	code	String	false

CInfo

 CInfo
 Model ID: CInfo

Property Name	Description	Type	Required
price	price	double	false
infoCode	infoCode	String	false

سرویسهای مرتبط با مشتری

 /customer

---

Paths

/customer

getCustomer

Path	Method	Nickname	Return Type	Summary	Notes
/customer	GET	getCustomer	Customer	Returns Defualt person

Responses

Code	Message
200	OK
500	خطای سیستمی در سرور رخ داده است

Produces

• application/json

Consumes

• application/json

addCustomer

Path	Method	Nickname	Return Type	Summary	Notes
/customer	POST	addCustomer	Response	ثبت مشخصات مشتری جدید

Parameters

Name	Description	Type	Required	Param Type
param	پارامتری از نوع مشتری بعنوان ورودی قابل قبول است	Customer	true	body

Responses

Produces

• application/json

Consumes

• application/json

Models

CustomerSig

 CustomerSig
 Model ID: CustomerSig

Property Name	Description	Type	Required
list2	list2	T2[]	false
list1	list1	List<T1>	false

Address

 Address
 Model ID: Address

Property Name	Description	Type	Required
description	جزییات آدرس	String	true
state	استان	State	true
city	شهر	City	true

City

 City resource representation
 Model ID: city

Property Name	Description	Type	Required
name	نام شهر	String	true
code	کد شهر	String	true

State

 City resource representation
 Model ID: city

Property Name	Description	Type	Required
name	name	String	false
code	code	String	false

C2

 C2
 Model ID: C2

Property Name	Description	Type	Required
longs	longs	Map<String,Long>	false

Order

 Order
 Model ID: Order

Property Name	Description	Type	Required
orderHeader	orderHeader	String	false
orderId	orderId	int	false

C1

 C1
 Model ID: C1

Property Name	Description	Type	Required
strs	strs	String[]	false

Customer

 کلاس مشتری
 Model ID: customer ,Model Code: Model_1001

Property Name	Description	Type	Required
order	سفارش مشتری	Order	true
address	آدرس مشتری	Address	true
name	نام مشتری	String	true
map	map	Map<String,CustomerSig<C1,C2>>	false
code	شماره مشتری	String	true