Site info API

Site info API

Site information

Receive the breif site information.

URL: /site/{siteId}
siteId: site ID
Method: GET

Request
- None

Response
Key Required Type Description
id true STRING Site unique ID
name true STRING Site name
accessType true STRING Card type (REGULAR or DYNAMIC)
status true STRING Current status (ACTIVATED, PAYMENT_REQUIRED: short on credits, Dynamic stopped)
created true LONG Created date & time
credit true STRING No of credits
refill true STRING No of maintenance credits
smsCredit   STRING User profile image link
countryCode true STRING Country code
languageCode true STRING Language code
timeZone true STRING Site timezone

Example
GET - /site/1
Request:
    None
Response:
{"status":200,"message":"success",
 "record": {
    "id": "100000",
    "name": "사이트이름",
    "accessType": "DYNAMIC",
    "status": "ACTIVATED",
    "created": 1591331573805,
    "credit": "0",
    "refill": "0",
    "smsCredit": "0",
    "countryCode": "KR",
    "languageCode": "KO",
    "timeZone": "Asia/Seoul"
  }
}
    • Related Articles

    • [Site]

      Monitor and change site information from Site Settings. Site settings allows you to check the current settings of your site and change some of its information. Settings list Site ID Site ID is an unique ID for your site. It is created upon the time ...
    • Login token & user / card API

      This section explains how to login & manage user through Airfob Portal APIs. Before start Airfob portal account and portal site need to be created in advance to use Airfob portal API. For more information on how to sign up and create a portal site, ...
    • Create a site

      Create a site and manage users and mobile access. A site is a management organization that issues a mobile access card for a specific company or office, gym, branch, etc. so that only the corresponding users can use it. You can become a site ...
    • Dynamic vs. regular site type

      There are two types of site types: dynamic and regular. Set the site type considering the organization you manage. Once site has been created, the site type cannot be changed, so please be considerate when creating a site. Comparison table. Dynamic ...
    • [Admin] Set up a site admin

      Site admin takes in charge of site settings and license of a site. Site admins have access and configuration permission to site and license settings. Site admins can only be invited by masters and sub-masters. Site admin roles Site management Change ...