API CreateBranch: Porovnání verzí
Z Podpora.nextis.cz
| (Není zobrazeno 6 mezilehlých verzí od 2 dalších uživatelů.) | |||
| Řádka 1: | Řádka 1: | ||
| + | ==== Description ==== | ||
| + | Method allows You to create new branch in system. | ||
| + | |||
==== Exact name ==== | ==== Exact name ==== | ||
<code>API_CreateBranch</code> | <code>API_CreateBranch</code> | ||
==== Type ==== | ==== Type ==== | ||
| − | Standard executable stored procedure | + | Standard executable stored procedure. |
==== Specification ==== | ==== Specification ==== | ||
| Řádka 16: | Řádka 19: | ||
|int | |int | ||
| | | | ||
| − | | | + | |ID of workshop from workshop list (see relation) |
| − | ( | ||
|API_GetWorkshops.ID | |API_GetWorkshops.ID | ||
|- | |- | ||
| Řádka 23: | Řádka 25: | ||
|nvarchar(100) | |nvarchar(100) | ||
| | | | ||
| − | | | + | |Branch name |
| | | | ||
|- | |- | ||
| Řádka 29: | Řádka 31: | ||
|nvarchar(200) | |nvarchar(200) | ||
| | | | ||
| − | | | + | |Street |
| | | | ||
|- | |- | ||
| Řádka 35: | Řádka 37: | ||
|nvarchar(120) | |nvarchar(120) | ||
| | | | ||
| − | | | + | |City |
| | | | ||
|- | |- | ||
| Řádka 41: | Řádka 43: | ||
|nvarchar(15) | |nvarchar(15) | ||
| | | | ||
| − | | | + | |ZIPCode |
| | | | ||
|- | |- | ||
| Řádka 47: | Řádka 49: | ||
|nvarchar(70) | |nvarchar(70) | ||
| | | | ||
| − | | | + | |Country |
| | | | ||
|- | |- | ||
| Řádka 53: | Řádka 55: | ||
|nvarchar(70) | |nvarchar(70) | ||
| | | | ||
| − | | | + | |Region |
| | | | ||
|- | |- | ||
| Řádka 59: | Řádka 61: | ||
|nvarchar(80) | |nvarchar(80) | ||
| | | | ||
| − | | | + | |State |
| | | | ||
|- | |- | ||
| Řádka 65: | Řádka 67: | ||
|int | |int | ||
| | | | ||
| − | |ID of country | + | |ID of country from country list (see relation) |
|API_GetCountry.ID | |API_GetCountry.ID | ||
|- | |- | ||
| Řádka 98: | Řádka 100: | ||
| | | | ||
|} | |} | ||
| + | |||
| + | ==== Return ==== | ||
| + | 0 : OK | ||
| + | 100 : Item could not be created | ||
==== Example ==== | ==== Example ==== | ||
<syntaxhighlight lang="sql"> | <syntaxhighlight lang="sql"> | ||
| − | EXEC [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' | + | 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> | </syntaxhighlight> | ||
| + | |||
| + | ==== Notices ==== | ||
| + | None. | ||
Aktuální verze z 20. 9. 2017, 14: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 | ||
| nvarchar(70) | ||||
| @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.
