ای پی آی های کدجیک
v1.0
در این ورژن از ای پی آی می توانی مدیریت پروژه ها، گزارش ها، ورژن های پروژه ها و آیتم های ورژن های پروژه ها و همچنین مدیریت کاربران، کشور ها و شهر ها را انجام بدی.
/projectversions/create
با استفاده از این متد می تونی یه ورژن جدید به پروژه مورد نظر اضافه کنی.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| versionInfoParameters | object | برای ایجاد ورژن جدید باید فیلد های ( Letter , Major , Minor , Revision , Build , ShamsiReleaseDate , ShamsiExpirationDate , ProjectId) مقدار دهی کنی. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/projectversions/create
/useraccount/updateprofile
با این متد کاربر می تواند اطلاعات پروفایل خود را ویرایش نماید.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| userAccuontInfoParameter | object | برای ویرایش داده های کاربر باید فیلد های Id، FullName، NickName، Email و WebsiteOrAbout به این متد ارسال شود. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/useraccount/updateprofile
/project/update
با استفاده از این متد می توان پروژه و خصوصیات مربوط به آن را ویرایش کرد.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| modifiedProjectInfoParameters | object | برای بروزرسانی پروژه باید فیلد های ( UserAccountId ,Title ,Domain , Protocol , VersionType ,Confirmed , DomainIsValid , Specification, MdIsRtl , Id ) مقدار دهی کنی. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/project/update
/projectversions/update
با استفاده از این متد می تونی ورژن های پروژه مورد نظر رو بروز رسانی کنی یا تغییر بدی.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| versionInfoParameters | object | برای ویرایش یا ایجاد تغییر در ورژن، باید فیلد های ( Letter , Major , Minor , Revision , Build , ShamsiReleaseDate , ShamsiExpirationDate , Id) مقدار دهی کنی. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/projectversions/update
/insight/track
این متد گزارش های مربوط به پروژه ها را ثبت می کند.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| insightInfoParameters | object | برای افزودن گزارش باید فیلد های DomainName , InstrumentationKey , Name, Data , Flag , ProjectId را مقدار دهی کرده و به این کلاس ارسال شود. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/insight/track
/projectversionitems/create
با این متد می تونی یه آیتم جدید به ورژن پروژه مورد نظر اضافه کنی.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| versionItemInfoParameters | object | برای ایجاد آیتم جدید باید فیلد های ( ProjectVersionId , Title , Type , Description ) مقدار دهی کنی. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/projectversionitems/create/
/project/create
با استفاده از این متد می توان یک پروژه جدید ایجاد کرد.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| newProjectInfoParameters | object | برای ایجاد پروژه جدید باید فیلد های ( UserAccountId ,Title ,Domain , Protocol , VersionType ,Confirmed , DomainIsValid , Specification, MdIsRtl ) مقدار دهی کنی. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/project/create
/projectversionitems/update
با استفاده از این متد می تونی آیتم ورژن مورد نظر رو بروزرسانی کنی.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| versionItemInfoParameters | object | برای بروزرسانی آیتم مورد نظر، باید فیلد های ( Id , Title , Type , Description ) مقدار دهی کنی. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/projectversionitems/update
/useraccount/usernameisvalid
با استفاده از این متد می توانید چک کنید که آیا کاربری با این نام کاربری وجود دارد یا خیر!
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| username | string | نام، نام کاربری ای هست که متد با استفاده از آن بررسی می کند که آیا کاربری با این نام کاربری وجود دارد یا خیر! |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/useraccount/usernameisvalid?username={username}
/projectversions/getallbyid
در این متد با وارد کردن id پروژه مورد نظر، می تونی لیست ورژن هایی که تا کنون برای این پروژه تعریف شده اند و در دسترس قرار دارند رو ببینی.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| projectid | guid | نام، id پروژه ای هست که با استفاده از اون می تونی ورژن های پروژه مورد نظر رو دریافت کنی. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/projectversions/getallbyid?projectid={projectid}
/projectversionitems/getitemsbydomainandversion
این متد در ورودی 2 پارامتر ورژن عددی و دامنه پروژه را دریافت می کند و در خروجی یک لیست از آیتم ها را بر میگرداند.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| domain | string | نام، مشخص کننده دامنه پروژه ای هست که کاربر می خواهد همراه مقدار عددی ورژن وارد کند تا آیتم های این ورژن را دریافت کند. |
| numericVersion | string | نام، مقداری عددی و نمایانگر ورژن پروژه می باشد که کاربر می خواهد همراه دامنه پروژه وارد کند تا آیتم های این ورژن را دریافت کند. مقدار ورژن، عددی است مانند : 2.3.1.1 |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/projectversionitems/getitemsbydomainandversion?numericVersion={numericVersion}&domain={domain}
/city/getcity
این متد نام استان مورد نظر را دریافت می کند و شهر هایی که زیر مجموعه این استان هست را در خروجی بر می گرداند.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| provinceName | string | نام، اسم استان مورد نظر می باشد، برای دیدن شهر های زیر مجموعه ی آن استان. نام می تواند هم لاتین باشد و هم فارسی! |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/city/getcity?provinceName={provinceName}
/projectversionitems/getbyversionid
این متد یک id را به عنوان پارامتر ورودی دریافت می کند، که این id، معرف یک ورژن خاص می باشد. خروجی این متد لیست تمام آیتم هایی هست که زیر مجموعه این ورژن می باشد.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| versionid | guid | نام، یک عدد با فرمت Guid هست و این عدد، id ورژن مورد نظر می باشد. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/projectversionitems/getbyversionid?versionid={versionid}
/version/getlastupdate
با استفاده از این متد می توان از آخرین بروز رسانی ورژن پروژه مطلع شد. پارامتر ورودی این متد نام پروژه مورد نظر می باشد، که با وارد کردن آن آخرین ورژن پروژه بر گردانده می شود.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| domain | string | نام، همان دامنه پروژه مورد نظر می باشد. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/version/getlastupdate?domain={domain}
/project/checkdomain
این متد بررسی می کند که آیا چنین دامنه ای وجود دارد یا خیر! خروجی این متد از نوع بولین می باشد. در صورت وجود داشتن مقدار true را بر میگرداند.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| domain | string | نام، اسم دامنه ای می باشد که باید وجود آن بررسی گردد و نوع آن از نوع متنی می باشد. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/project/checkdomain?domain={domain}
/useraccount/getdetail
در این متد با استفاده از نام کاربری می توان مشخصات کاربر مورد نظر را دریافت کرد.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| username | string | نام، نام کاربری ای هست که با استفاده از آن می توان اطلاعات و مشخصات کاربر مورد نظر را دریافت کرد. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/useraccount/getdetail?username={username}
/project/getbyusername
این متد یک نام کاربری در ورودی خود می پذیرد، و سپس مشخصاتی از تمام پروژه های مرتبط با این نام کاربری را بر می گرداند.این مشخصات شامل: دامنه، ای دی، نوع پروتکل، عنوان پروژه، تاییدیه مبنی بر تایید شدن پروژه، مشخصات و ویژگی های پروژه و ای دی کاربر
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| username | string | نام کاربری ، مشخصه ای هست که با آن می توان نام و مشخصات پروژه هایی که با این نام کاربری ثبت شده اند را برگرداند. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/project/getbyusername?username={username}
/projectversionitems/getitemsbydomainandletter
این متد 2 پارامتر در ورودی دریافت می کند و در خروجی لیستی از آیتم های ورژن مورد نظر را بر می گرداند.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| domain | string | نام، دامنه ی پروژه ای هست که میخوای آیتم های ورژن اون رو دریافت کنی. همچنین به همراه دامنه باید مقدار ورژن رو وارد کنی! |
| versionletter | string | نام، مقدار ورژن (به حروف) هست که کاربر می خواهد همراه با نام دامنه وارد کند و آیتم های آن ورژن مورد نظر را دریافت کند. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/projectversionitems/projectversionitems/getitemsbydomainandletter?versionletter={versionletter}&domain={domain}
/province/getprovince
در این متد با وارد کردن نام کشور میتونی لیستی از استان های اون کشور رو ببینی.
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| countryName | string | نام، نام کشوری هست که می خواهی لیست استان های اون را دریافت کنی. نام کشور باید فارسی باشد. |
نمونه فراخوانی
http://api.codegeek.ir/v1.0/province/getprovince?countryName={countryName}