GetApiSetting API
Assembly: TaxProGST.API
GetApiSetting may be Optionally used by ASP to get present API settings for ASP Application
HTTP Method: GET
Headers or Query String Param:
|
Property
|
Description
|
Data Type
|
|
aspid
|
AspUserId provided by GSP.
|
String
|
Sample Url:
https://gstapi.charteredinfo.com/aspapi/v1.0/getapisetting?aspid=<===YourAspId===>
Response: GetApiSetting API response returns below properties from type APISetting
|
Property
|
Description
|
Data Type
|
|
ASPName
|
For User Friendly name only. Not referred or used by GSP System.
|
String
|
|
IsActive
|
ASP may use this in case multiple settings are stored at ASP end.
|
String
|
|
IsDefault
|
ASP may use this in case multiple settings are stored at ASP end.
|
Integer
|
|
AspWebsite
|
ASP Website address or GSP's ASP Portal address. Not used by API system.
|
String
|
|
UrlAuth
|
GST Authentication API access end point @ GSP Server.
e.g. https://gstapi.charteredinfo.com/taxpayerapi/v0.2/authenticate
|
String
|
|
AuthVer
|
Active version of Authentication API on GSP Server.
|
String
|
|
UrlReturn
|
GST Returns API access end point @ GSP Server.
e.g. https://gstapi.charteredinfo.com/taxpayerapi/v0.2/returns
|
String
|
|
ReturnVer
|
Active version of Returns API on GSP Server.
|
String
|
|
UrlLedger
|
GST Authentication API access end point @ GSP Server.
https://gstapi.charteredinfo.com/taxpayerapi/v0.2/ledgers
|
String
|
|
LedgerVer
|
Active version of Ledgers API on GSP Server.
|
String
|
|
UrlAspUtil
|
GSP - ASP APIs Url
https://gstapi.charteredinfo.com/aspapi/v0.2
|
String
|
GetApiSetting API Call Method (applies only if you are using TaxProGST.API.GspAPI Class)
|
API
(Method)
|
Method in TaxPro Lib
(GspAPI class)
|
Parameter Type
|
Description
|
|
GetApiSetting
(POST)
|
GetApiSetting
|
|
This method is used to download APISetting from TaxPro GSP Server.
|
