SubOrganizationDetail

idintegerrequired

Internal unique identifier of the sub-organization (system-generated)

Example: 5472

externalIdstringrequired

The identifier assigned by the API consumer

Possible values: <= 255 characters

Example: New-Sub-ORG-ID

namestringrequired

Official name of the sub-organization

Possible values: <= 255 characters

Example: ABCGH

externalStatusstringrequired

Sub-organization status as defined by the external system or API consumer

Possible values: [active, inactive, awaiting approval, draft, suspended, blacklisted, closed]

Example: active

addressstringrequired

Street address of the sub-organization

Possible values: <= 255 characters

Example: A Street

citystring | nullnullablerequired

The city where the sub-organization is located

Possible values: <= 100 characters

Example: Kabul

provincestring | nullnullablerequired

The province or state where the sub-organization is located

Possible values: <= 100 characters

Example: Kabul Province

postalCodestring | nullnullablerequired

Postal or ZIP code of the sub-organization's address

Possible values: <= 20 characters

Example: 1001

countrystringrequired

Country where the sub-organization is located (ISO 3166-1 alpha-2 format)

Possible values: <= 2 characters, Value must match regular expression ^[A-Z]{2}$

Example: AF

maleEmployeesinteger | nullnullablerequired

Number of male employees reported by the sub-organization

Example: 123456

femaleEmployeesinteger | nullnullablerequired

Number of female employees reported by the sub-organization

Example: 1241

solutionsUsedstring[]required

List of solutions used by the sub-organization

Possible values: [Inspection, T&A, Lab Test]

Example: ["Inspection","T&A","Lab Test"]

phoneNumberstring | nullnullablerequired

The phone number of the sub-organization

Possible values: <= 50 characters

Example: +93-20-123-4567

permissionsstring[]required

Indicates the access level the current user has for this sub-organization. This helps determine what actions the user can perform (e.g., view-only, edit).

Possible values: [read, write, edit, share, full]

Example: ["edit"]

contacts object[]required

List of primary contact persons for the sub-organization

Array [

firstNamestringrequired

First name of the contact person

Possible values: <= 100 characters

Example: Ahmed

lastNamestring

Last name of the contact person

Possible values: <= 100 characters

Example: Benali

emailstring<email>required

Email address of the contact person

Possible values: <= 255 characters

Example: [email protected]

phoneNumberstring

Phone number of the contact person

Possible values: <= 50 characters

Example: +213-555-123-456

rolestring

Job title or role of the contact person within the sub-organization, can refer from List Contact Roles API

Possible values: <= 100 characters

Example: Manager

]

location objectrequired

Location coordinates of the sub-organization

longitude(number | null)<double>nullable

Longitude of the sub-organization's location

Example: 3.0588

latitude(number | null)<double>nullable

Latitude of the sub-organization's location

Example: 36.7538

SubOrganizationDetail

{
  "id": 5472,
  "externalId": "New-Sub-ORG-ID",
  "name": "ABCGH",
  "externalStatus": "active",
  "address": "A Street",
  "city": "Kabul",
  "province": "Kabul Province",
  "postalCode": "1001",
  "country": "AF",
  "maleEmployees": 123456,
  "femaleEmployees": 1241,
  "solutionsUsed": [
    "Inspection",
    "T&A",
    "Lab Test"
  ],
  "phoneNumber": "+93-20-123-4567",
  "permissions": [
    "edit"
  ],
  "contacts": [
    {
      "firstName": "Ahmed",
      "lastName": "Benali",
      "email": "[email protected]",
      "phoneNumber": "+213-555-123-456",
      "role": "Manager"
    }
  ],
  "location": {
    "longitude": 3.0588,
    "latitude": 36.7538
  }
}