openapi: 3.0.1 info: title: NationalAddress.NationalAddressByShortAddress version: '1.0' servers: - url: http://apina.address.gov.sa/NationalAddress/NationalAddressByShortAddress - url: https://apina.address.gov.sa/NationalAddress/NationalAddressByShortAddress paths: /NationalAddressByShortAddress: get: summary: NationalAddress By Short Address description: "NationalAddressByShortAddress API returns full address details for given short address value\nYou can decide to use Json or XML as an output format" operationId: 6071af46a615421d7e590af2 parameters: - name: format in: query description: 'It’s an optional input. We currently support output for API’s in two formats Json and XML. You will be required to specify in which format you need response, default is Json.' schema: enum: - json type: string default: json - name: language in: query description: It is an optional input. Our API can provide response in Arabic or English with Arabic being the default language. schema: type: string - name: page in: query description: 'By default each request returns a maximum number of 10 results. If there are a large number of results, in such a case, this page number must be passed along to get the next set of results. Default value is 1.' schema: enum: - 1 type: number default: 1 - name: encode in: query description: By default response is in windows-1256. Pass "utf8" as input parameter to get utf-8 charset. schema: type: string - name: shortaddress in: query description: Short Address Value schema: type: string responses: '200': description: components: securitySchemes: apiKeyHeader: type: apiKey name: api_key in: header apiKeyQuery: type: apiKey name: api_key in: query security: - apiKeyHeader: [ ] - apiKeyQuery: [ ]