Request ile parametreleri “actType” parametresine göre değişir.
“actType” parametresinin alabileceği değerler
Bu parametre ile uygulamadan bir formu açması istenebilir.
İki parametre ile “formId”, “refId” birlikte kullanılır.
“formId” parametresi ile açılması istenen form id belirtilir.
“refId” parametresinde 0 dan farklı bir değer verilirse belirtilen form açılır ve “refId” ile belirtilen kayıt değiştirme modunda açılır.
Bu özellik tüm formlar için desteklenmez.
Response olarak “result_code”, “result_message” alanları döner.
“result_code“ hata yoksa 0 olarak döner hata varsa ilgili hata kodu döner.
“result_message” alanı hata yoksa ‘OK’ varsa ilgili hata mesajını gösterir. “result” alanı ise restapi den gelen veriyi içerir.
Örnekler:
Request | Reponse |
|---|
{
"actType": "openform",
"formId": 331,
"refId": 0
} | {
"result_code":0,
"result_message":"OK"
} |
{
"actType": "openform",
"formId": 23,
"refId": 2
} | {
"result_code":0,
"result_message":"OK"
} |
restApi
Bu parametre ile uygulamadan restapi’yi kullanarak işlem yapması istenebilir. “result_code”, “result_message”, “result” alanları döner.
“result_code“ hata yoksa 0 olarak döner hata varsa ilgili hata kodu döner .
“result_message” alanı hata yoksa ‘OK’ varsa ilgili hata mesajını gösterir. “result” alanı ise restapi den gelen veriyi içerir.
Aşağıdaki parametrelerle birlikte kullanılır:
- username: RestApi serverine bağlanırken kullanılacak kullanıcı adı. Boş bırakılırsa, RestApi’ye bağlanırken programın aktif kullanıcı adı gönderilir.
- password: RestApi serverine bağlanırken kullanılacak şifre. Boş bırakılırsa, RestApi’ye bağlanırken programın aktif kullanıcı şifresi gönderilir.
- firmid: RestApi serverine bağlanırken kullanılacak firma bilgisi. Boş bırakılırsa, RestApi’ye bağlanırken programın aktif firma bilgisi.
- restMethod: RestApi serverine bağlanırken kullanılılır. Kullanıcı “GET”, ”PUT”, ”POST”, ”PATCH”, ”DELETE” methodlarını kullanabilir. Hangi metodların kullanılması gerektiği ile ilgili olarak restapi dökümantasyonuna bakılmalıdır.
- restApiVer : Uygulamanın bağlanacağı RestApi’nin versiyonu belitilir. e bağlanırken kullanılılır. Hangi versiyonun kullanılması gerektiği ile ilgili olarak restapi dökümantasyonuna bakılmalıdır.
- urlParam: Uygulamanın bağlanacağı RestApi’nin versiyonu belitilir. e bağlanırken kullanılılır. Hangi urlParam değerinin kullanılması gerektiği ile ilgili olarak restapi dökümantasyonuna bakılmalıdır.
- content: Uygulamanın bağlanacağı RestApi’ye POST,PUT,POST,PATCH metodlarında içerik olarak gönderilir. Hangi content içeriginin kullanılması gerektiği ile iligili olarak restapi dökümantasyonuna bakılmalıdır.
Request:
{
"actType": "restapi",
"urlParam": "\/glaccounts",
"firmId": 1,
"username": "",
"restMethod": "GET",
"content": "",
"restApiVer": "v1",
"password": "",
"progId":"SamplePlugin.Sample"
}
Response:
{
"result_code" : 0,
"result_message" : "OK",
"result" : {
"limit" : 10,
"offset" : 0,
"items" : [{
"PROJECT_CONTROL" : 0,
"VATREFLAREF" : 0,
"CATEGORY" : 0,
"CCURRENCY" : 0,
"HOUR_CREATED" : -26476,
"BDGTPAYAREF" : 0,
"INF_DIFF_ACCREF" : 0,
"BDGTACCREF" : 0,
"MNDTRY_QUAN" : 0,
"CURR_DIFF_DEBTREF" : 0,
"DEFNFLDSLIST" : {
"Meta" : {
"mediaType" : "application\/json; charset=UTF-8",
"apiVersion" : "1.0",
"href" : "https:\/\/172.16.12.54:32002\/api\/v1\/GLAccounts\/1\/DEFNFLDSLIST"
}
},
"DATA_SITEID" : 0,
"ACCOUNT_TYPE" : 2,
"FIXEDCURRTYPE" : 0,
"VAT_ACC" : 0,
"ACCOUNT_CHAR" : 2,
"XML_ATTRIBUTE" : 0,
"DESCRIPTION2" : "test hesap guncellendi.Plugin",
"LEVEL" : 0,
"MIN_MODIFIED" : 16612,
"IS_BDGT_LINE" : 0,
"HOUR_MODIFIED" : -23761,
"VATREFLOTHAREF" : 0,
"CRBDGTACCLN" : 0,
"BDREFLACCREF" : 0,
"RECORD_STATUS" : 0,
"CENTERREF" : 0,
"INTERNAL_REFERENCE" : 1,
"INFLATION_FLAG" : 0,
"FOR_TAX_DECL" : 0,
"DESCRIPTION" : "test hesap guncellendi.Plugin\/Patch",
"SUBACCOUNTS" : 2,
"SEC_CREATED" : -5376,
"MIN_CREATED" : 16612,
"MODIFIED_BY" : 1,
"CURRDIFREF" : 0,
"CURRATETYPE" : 0,
"CRBDGTPAYALN" : 0,
"DATA_REFERENCE" : 1,
"ADDINFOPTR" : 0,
"GROUP_CODE" : 0,
"Meta" : {
"mediaType" : "application\/json; charset=UTF-8",
"apiVersion" : "1.0",
"href" : "https:\/\/172.16.12.54:32002\/api\/v1\/GLAccounts\/1"
},
"CODE" : "100",
"EXTENREF" : 0,
"MNDTRY_OHP" : 0,
"CREATED_BY" : 0,
"SEC_MODIFIED" : -5376,
"BDPAYREFLAREF" : 0
}
],
"first" : {
"mediaType" : "application\/json; charset=UTF-8",
"apiVersion" : "1.0",
"href" : "https:\/\/172.16.12.54:32002\/api\/v1\/glaccounts?limit=10"
},
"next" : {
"mediaType" : "application\/json; charset=UTF-8",
"apiVersion" : "1.0",
"href" : "https:\/\/172.16.12.54:32002\/api\/v1\/glaccounts?offset=10&limit=10"
},
"count" : 10,
"Meta" : {
"mediaType" : "application\/json; charset=UTF-8",
"apiVersion" : "1.0",
"href" : "https:\/\/172.16.12.54:32002\/api\/v1\/glaccounts?limit=10"
},
"previous" : {
"mediaType" : "application\/json; charset=UTF-8",
"apiVersion" : "1.0"
}
}
}
