امتثال
واجهة البرمجة

Element codes

GET
/v1/element-codes

Exactly the table the firm's next job is read with: confirmed meanings that have not been replaced or retracted.

Authorization

BearerAuth
headerAuthorizationBearer <token>

JWT access token. Obtain via POST /v1/auth/login.

Response Body

The meanings in force.

application/json
  1. response
[key: string]?any
curl -X GET 'https://api.aisc.sa/v1/element-codes'
{}
DELETE
/v1/element-codes/{code_id}

The layer is unread again on the firm's next job and will be asked about again. The meaning is kept in history, so past jobs stay reproducible.

Authorization

BearerAuth
headerAuthorizationBearer <token>

JWT access token. Obtain via POST /v1/auth/login.

Path Parameters

code_id*Code Id
Formatuuid

Response Body

Retracted.

curl -X DELETE 'https://api.aisc.sa/v1/element-codes/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Empty
PUT
/v1/element-codes/{code_id}

Supersedes the meaning with a new one for the same code and label. The old meaning is kept, so past jobs stay reproducible. Applies to FUTURE jobs.

Authorization

BearerAuth
headerAuthorizationBearer <token>

JWT access token. Obtain via POST /v1/auth/login.

Path Parameters

code_id*Code Id
Formatuuid

Request Body

application/json
  1. body

Body for PUT /v1/element-codes/{code_id}.

element_type*ElementType

The new meaning, from the vocabulary the rules are written against. The code, label and convention stay those of the meaning replaced.

Value in"room""door""window""exit""stair""corridor""ramp""shaft""elevator""mezzanine""fire_compartment""occupancy_zone""egress_path""wall""column""beam""slab""foundation""reinforcement""steel_connection""fire_alarm""smoke_detector""fire_extinguisher""sprinkler""standpipe""fire_pump""exit_sign""smoke_vent""emergency_light""travel_distance""common_path""fire_zone""circuit""earth_electrode""conductor""distribution_panel""socket_outlet""luminaire""conduit""transformer""air_handling_unit""chiller""fan""damper""diffuser""boiler""water_heater""trap""plumbing_fixture""backflow_preventer""floor_drain""cleanout""gas_appliance""gas_regulator""gas_meter""shutoff_valve""vent_terminal""footing""anchor""brace""pile""retaining_wall""expansion_joint""pool""diving_board""pool_drain""pool_barrier""insulation""glazing_unit""energy_meter""solar_panel""duct""pipe""equipment""building""floor""site""other""occupancy_area""unknown"

Response Body

Replaced. The body is the meaning now in force.

response?unknownapplication/json
curl -X PUT 'https://api.aisc.sa/v1/element-codes/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "element_type": "wall"}'
null