POI's Sub Category

The KSA Service Sub Category API returns list of services which fall under a service category in KSA region along with service id and name. Using the service sub-category API you can tag business in a district, city or region to provide structured information to your users. You can decide to use Json or XML as an output format in addition to language of your choice from Arabic or English.

Usage:

You must use an access token to make an authenticated call to our system. Access token are generated based on your subscription type. To get your access token please refer to “Your Subscriptions” section available on profile page.

Limits for calls to API

Our system doesn’t apply any limits on number of requests you can make for a particular API. But there are limits defined for total number of calls you can make per min and in one week. Please reference the list below for limits applied

• Starter Package - Subscribers will be able to execute 5 calls/ minute up to a maximum of 100 calls/ week for any API.
• Unlimited Package - Subscribers can make as many calls as they wish per minute or in a week with no upper limit defined. This package will have to be approved by our system administrator and make time.

API Request
Input Parameters

Requested URL

https://apina.address.gov.sa/NationalAddress/v3.1/lookup/services-sub-categories?language=A&format=JSON&servicecategoryid=1&api_key=

Response

Default Fields Returned

By default, only the following fields are returned for a profile request:

Sample Response
JSON

{"LookUp": null,
"Regions": null,
"Cities": null,
"Districts": null,
"ServiceCategories": null,
"ServiceSubCategories":[{"Id": "1C",
"Name": "Civil Defense"},
{"Id": "1F",
"Name": "General Government Services"},
{"Id": "1A",
"Name": "Ministries"},
{"Id": "1B",
"Name": "Police Stations"},
{"Id": "1D",
"Name": "Postal Services"},
],
"success": true,
"datasetOrdatatable": null,
"result": null,
"statusdescription": "SUCCESS",
"fullexception": null}

XML

<LookupOutputParams xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<success>true</success>
<statusdescription>SUCCESS</statusdescription>
<ServiceSubCategories>
<ServiceSubCategory>
<Id>1C</Id>
<Name>Civil Defense</Name>
</ServiceSubCategory>
</ServiceSubCategories>
</LookupOutputParams>

Common Errors

If there's an error with your API call, LinkedIn will return a HTTP status code along with a message detailing the error.