i-Claim

Add Providers

POST

/providers/add_providers

Provider Management

Request

Body Params application/json

array of:

provider_id

string

Provider Id

required

Unique id used to identify service provider

ahfoz_number

string

Ahfoz Number

required

Unique id provided by AHFoZ used to identify service provider

name

string

Name

required

Name of service provider

units

array[object (AhfozGradesSchema) {2}]

Units

required

List of registered units under service provider

unit

string

Unit

required

grade

enum<string>

Grade

required

Allowed values:

ABCDEF

dispenser_license

boolean

Dispenser License

required

Checks if service provider has a dispenser license

string

required

Email address of service provider

phone

string

Phone

required

Phone number of service provider

address

string

Address

required

Address of service provider

country

string

Country

required

Country where service provider resides

Example

[
  {
    "provider_id": "string",
    "ahfoz_number": "string",
    "name": "string",
    "units": [
      {
        "unit": "string",
        "grade": "A"
      }
    ],
    "dispenser_license": true,
    "email": "string",
    "phone": "string",
    "address": "string",
    "country": "string"
  }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/providers/add_providers' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "provider_id": "string",
        "ahfoz_number": "string",
        "name": "string",
        "units": [
            {
                "unit": "string",
                "grade": "A"
            }
        ],
        "dispenser_license": true,
        "email": "string",
        "phone": "string",
        "address": "string",
        "country": "string"
    }
]'

Responses

🟢200OK

application/json

Successful Response

Body

No schema defined

Example

null

🟠422Parameter Error

Modified at 2024-12-07 17:10:47

Add Provider

Get Provider