API CreateBranch: Porovnání verzí

Z Podpora.nextis.cz
Přejít na: navigace, hledání
(Založena nová stránka s textem „API_CreateBranch @WorkshopID int - API_GetWorkshops.ID @Name nvarchar(100) @Street nvarchar(200) @City nvarchar(120) @ZIPCode nvarchar(15) @Country…“)
 
 
(Není zobrazeno 9 mezilehlých verzí od 2 dalších uživatelů.)
Řádka 1: Řádka 1:
−
API_CreateBranch
+
==== Description ====
 +
Method allows You to create new branch in system.
  
−
@WorkshopID int - API_GetWorkshops.ID
+
==== Exact name ====
−
@Name nvarchar(100)
+
<code>API_CreateBranch</code>
−
@Street nvarchar(200)
 
−
@City nvarchar(120)
 
−
@ZIPCode nvarchar(15)
 
−
@Country nvarchar(70)
 
−
@Region nvarchar(70)
 
−
@State nvarchar(80)
 
−
@StateID int - API_GetCountry.ID
 
−
@Phone nvarchar(50)
 
−
@Fax nvarchar(50)
 
−
@MobilePhone nvarchar(50)
 
−
@Email nvarchar(70)
 
−
@Web nvarchar(120)
 
  
 +
==== Type ====
 +
Standard executable stored procedure.
  
−
Example:
+
==== Specification ====
−
  EXEC [API_CreateBranch]  
+
{| class="wikitable"
−
  @WorkshopID = 1
+
!Parameter
−
  ,@Name = 'Name'
+
!Data type
−
  ,@Street = 'Street'
+
!Value range
−
  ,@City = 'City'
+
!Description
−
  ,@ZIPCode = 'ZIPCode'
+
!Relation
−
  ,@Country = 'Country'
+
|-
−
  ,@Region = 'Region'
+
|@WorkshopID
−
  ,@State ='Česká republika'
+
|int
−
  ,@StateID = 15797
+
|
−
  ,@Phone = '+420 556 621 300'
+
|ID of workshop from workshop list (see relation)
−
  ,@Fax = '+420 596 790 789'
+
|API_GetWorkshops.ID
−
  ,@MobilePhone = '+420 556 621 301'
+
|-
−
  ,@Email = 'info@nextis.cz'
+
|@Name
−
  ,@Web = 'www.nextis.cz'
+
|nvarchar(100)
 +
|
 +
|Branch name
 +
|
 +
|-
 +
|@Street
 +
|nvarchar(200)
 +
|
 +
|Street
 +
|
 +
|-
 +
|@City
 +
|nvarchar(120)
 +
|
 +
|City
 +
|
 +
|-
 +
|@ZIPCode
 +
|nvarchar(15)
 +
|
 +
|ZIPCode
 +
|
 +
|-
 +
|@Country
 +
|nvarchar(70)
 +
|
 +
|Country
 +
|
 +
|-
 +
|@Region
 +
|nvarchar(70)
 +
|
 +
|Region
 +
|
 +
|-
 +
|@State
 +
|nvarchar(80)
 +
|
 +
|State
 +
|
 +
|-
 +
|@StateID
 +
|int
 +
|
 +
|ID of country from country list (see relation)
 +
|API_GetCountry.ID
 +
|-
 +
|@Phone
 +
|nvarchar(50)
 +
|
 +
|Phone
 +
|
 +
|-
 +
|@Fax
 +
|nvarchar(50)
 +
|
 +
|Fax
 +
|
 +
|-
 +
|@MobilePhone
 +
|nvarchar(50)
 +
|
 +
|Mobile phone
 +
|
 +
|-
 +
|@Email
 +
|nvarchar(70)
 +
|
 +
|Email
 +
|
 +
|-
 +
|@Web
 +
|nvarchar(120)
 +
|
 +
|Web address
 +
|
 +
|}
 +
 
 +
==== Return ====
 +
0 : OK
 +
  100 : Item could not be created
 +
 
 +
==== Example ====
 +
<syntaxhighlight lang="sql">
 +
DECLARE @return_value int
 +
EXEC @return_value = [API_CreateBranch] @WorkshopID = 1 ,@Name = 'Name' ,@Street = 'Street' ,@City = 'City' ,@ZIPCode = 'ZIPCode' ,@Country = 'Country' ,@Region = 'Region' ,@State ='Česká republika' ,@StateID = 15797 ,@Phone = '+420 556 621 300' ,@Fax = '+420 596 790 789' ,@MobilePhone = '+420 556 621 301' ,@Email = 'info@nextis.cz' ,@Web = 'www.nextis.cz'
 +
</syntaxhighlight>
 +
 
 +
==== Notices ====
 +
None.

Aktuální verze z 20. 9. 2017, 15:53

Description

Method allows You to create new branch in system.

Exact name

API_CreateBranch

Type

Standard executable stored procedure.

Specification

Parameter Data type Value range Description Relation
@WorkshopID int ID of workshop from workshop list (see relation) API_GetWorkshops.ID
@Name nvarchar(100) Branch name
@Street nvarchar(200) Street
@City nvarchar(120) City
@ZIPCode nvarchar(15) ZIPCode
@Country nvarchar(70) Country
@Region nvarchar(70) Region
@State nvarchar(80) State
@StateID int ID of country from country list (see relation) API_GetCountry.ID
@Phone nvarchar(50) Phone
@Fax nvarchar(50) Fax
@MobilePhone nvarchar(50) Mobile phone
@Email nvarchar(70) Email
@Web nvarchar(120) Web address

Return

0 : OK
100 : Item could not be created

Example

DECLARE @return_value int
EXEC @return_value = [API_CreateBranch] @WorkshopID = 1 ,@Name = 'Name' ,@Street = 'Street' ,@City = 'City' ,@ZIPCode = 'ZIPCode' ,@Country = 'Country' ,@Region = 'Region' ,@State ='Česká republika' ,@StateID = 15797 ,@Phone = '+420 556 621 300' ,@Fax = '+420 596 790 789' ,@MobilePhone = '+420 556 621 301' ,@Email = 'info@nextis.cz' ,@Web = 'www.nextis.cz'

Notices

None.

Citováno z „https://podpora.nextis.cz/index.php?title=API_CreateBranch&oldid=955“