Avetta

Avetta Pegasus Scope Scope Person External ID Controller API

The pegasusScope_scope-person-external-id-controller API from Avetta — 3 operation(s) for pegasusscope_scope-person-external-id-controller.

GitHub OpenAPI

Operations 3

GET /api/v1/scope/{scopeId}/person/external-id/{externalId} Get person by external ID #
GET /api/v1/scope/{scopeId}/person/external-id/{externalId}/list Get persons by external ID #
GET /api/v1/scope/{scopeId}/person/external-id/types List external ID types #

Documentation

📖
Documentation
https://docs.connect.avetta.com/
📖
Documentation
https://docs.pegasus.avetta.com/
📖
Documentation
https://docs.worker.avetta.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/openapi/avetta-pegasusscope-scope-person-external-id-controller-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-1-0-0-supplier-profile-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-1-0-0-get-workflow-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-1-0-0-supplier-profiles-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-1-0-0-create-work-request-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-1-0-0-worker-open-work-requests-summary-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-1-0-0-get-work-request-questions-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-3-29-14-integrate-employee-resource-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-3-29-14-employee-resource-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-3-29-14-worker-resource-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-3-29-14-competency-resource-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-3-29-14-scope-permission-resource-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-3-29-14-client-company-registration-resource-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-stats-schema-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-request-structure-refresh-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-request-structure-password-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-request-wmconnect-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-sites-message-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/avetta:avetta-pegasusscope-scope-person-external-id-controller-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

avetta-pegasusscope-scope-person-external-id-controller-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Avetta Pegasus Scope Scope Person External ID Controller API
  version: APSO-1355
  x-logo:
    url: avetta_logo.png
  description: 'Operations tagged pegasusScope_scope-person-external-id-controller across 2 of this provider''s published API definitions: avetta-pegasus-dist.json, avetta-pegasus-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: EPE (Test Environment)
  url: https://epe-onsitetrackeasy.com.au/onsite-rest
- description: Production
  url: https://secure.onsitetrackeasy.com.au/onsite-rest
tags:
- name: pegasusScope_scope-person-external-id-controller
  x-displayName: scope-person-external-id-controller
paths:
  /api/v1/scope/{scopeId}/person/external-id/{externalId}:
    get:
      tags:
      - pegasusScope_scope-person-external-id-controller
      summary: Get person by external ID
      description: Find a single person by their external ID value. If the scope has multiple external ID types, specify externalIdTypeId or externalIdTypeName to disambiguate.
      operationId: getPersonByExternalId
      parameters:
      - name: scopeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: externalId
        in: path
        required: true
        schema:
          type: string
      - name: externalIdTypeId
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: externalIdTypeName
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_WorkerResource'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
      security:
      - 3.29.14_security_auth: []
        3.29.14_security_apikey: []
    servers:
    - description: EPE (Test Environment)
      url: https://epe-onsitetrackeasy.com.au/onsite-rest
    - description: Production
      url: https://secure.onsitetrackeasy.com.au/onsite-rest
  /api/v1/scope/{scopeId}/person/external-id/{externalId}/list:
    get:
      tags:
      - pegasusScope_scope-person-external-id-controller
      summary: Get persons by external ID
      description: Find all persons matching an external ID value. Searches all visible external ID types for the scope unless filtered by externalIdTypeId or externalIdTypeName.
      operationId: getPersonsByExternalId
      parameters:
      - name: scopeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: externalId
        in: path
        required: true
        schema:
          type: string
      - name: externalIdTypeId
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: externalIdTypeName
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                allOf:
                - $ref: '#/components/schemas/3.29.14_WorkerSummaryResource'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
      security:
      - 3.29.14_security_auth: []
        3.29.14_security_apikey: []
    servers:
    - description: EPE (Test Environment)
      url: https://epe-onsitetrackeasy.com.au/onsite-rest
    - description: Production
      url: https://secure.onsitetrackeasy.com.au/onsite-rest
  /api/v1/scope/{scopeId}/person/external-id/types:
    get:
      tags:
      - pegasusScope_scope-person-external-id-controller
      summary: List external ID types
      description: List available external ID types for a scope.
      operationId: getExternalIdTypes
      parameters:
      - name: scopeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        required: false
        schema:
          type: string
      - name: includeInactive
        in: query
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/3.29.14_OtherIdNameResource'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
      security:
      - 3.29.14_security_auth: []
        3.29.14_security_apikey: []
    servers:
    - description: EPE (Test Environment)
      url: https://epe-onsitetrackeasy.com.au/onsite-rest
    - description: Production
      url: https://secure.onsitetrackeasy.com.au/onsite-rest
components:
  schemas:
    3.29.14_NaturalKeyResource:
      type: object
      properties:
        extSysKey:
          type: string
        idKey:
          type: string
    3.29.14_RealmResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        scope:
          $ref: '#/components/schemas/3.29.14_ScopeResource'
        active:
          type: boolean
        connectClient:
          type: boolean
    3.29.14_DriversLicenseResource:
      required:
      - driversLicenseClass
      - driversLicenseNumber
      - driversLicenseState
      type: object
      properties:
        driversLicenseNumber:
          maxLength: 20
          minLength: 0
          type: string
        driversLicenseState:
          maxLength: 20
          minLength: 0
          type: string
        driversLicenseClass:
          maxLength: 40
          minLength: 0
          type: string
        driversLicenseExpiry:
          type: string
    3.29.14_StatusType:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
        reasonPhrase:
          type: string
    3.29.14_WorkerResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        firstName:
          type: string
        lastName:
          type: string
        photoLink:
          type: string
        companies:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_KeyedIntegerClientResource'
        email1:
          type: string
        email2:
          type: string
        uniqueEmail:
          type: string
        phone1:
          type: string
        phone2:
          type: string
        address:
          $ref: '#/components/schemas/3.29.14_AddressResource'
        nextOfKin:
          $ref: '#/components/schemas/3.29.14_NextOfKinResource'
        status:
          type: string
          enum:
          - PENDING
          - APPROVED
          - ARCHIVED
        locale:
          type: string
        mergedToPersonId:
          type: integer
          format: int32
        createTime:
          type: string
        updateTime:
          type: string
        personTypes:
          type: array
          items:
            type: string
            enum:
            - SITE_CONTACT
            - PERSONAL_CONTACT
            - USER
            - EMPLOYEE
            - CONTRACTOR
            - VISITOR
            - SUPERUSER
            - UNICORN_USER
            - INVALID_PERSON
            - MASTERKEY
            - CARDHOLDER
            - PAST_CARDHOLDER
            - INVISIBLE
            - IMPOSSIBLE
        email:
          type: string
        blocked:
          type: boolean
        blockRecursive:
          type: boolean
        defaultCompanies:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_ScopeDefaultCompanyResource'
        siteLegacyIds:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_SiteLegacyIdResource'
        externalIds:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_KeyedStringResource'
        clientKey:
          $ref: '#/components/schemas/3.29.14_NaturalKeyResource'
        middleName:
          type: string
        gender:
          type: string
          enum:
          - UNSET
          - F
          - M
          - OTHER
          - PREFER_NOT_TO_SAY
        dateOfBirth:
          type: string
        placeOfBirth:
          type: string
        phone:
          type: string
        driversLicense:
          $ref: '#/components/schemas/3.29.14_DriversLicenseResource'
        universalStudentIdentifier:
          type: string
        idCheckPass:
          type: boolean
        idCheckPendingNonExpired:
          type: boolean
        siteAssociations:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_SiteAssociationPersonResource'
        realmAssociations:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_RealmAssociationPersonResource'
        blocks:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_BlockResource'
        canEditAction:
          $ref: '#/components/schemas/3.29.14_ActionResource'
    3.29.14_KeyedIntegerResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
    3.29.14_RealmAssociationPersonResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        realm:
          $ref: '#/components/schemas/3.29.14_RealmResource'
        personId:
          type: integer
          format: int32
        companyId:
          type: integer
          format: int32
        pending:
          type: boolean
        associationDate:
          type: string
        associatedBy:
          type: string
        createTime:
          type: string
    3.29.14_OtherIdNameResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        description:
          type: string
        active:
          type: boolean
    3.29.14_SiteLegacyIdResource:
      type: object
      properties:
        site:
          $ref: '#/components/schemas/3.29.14_KeyedIntegerResource'
        legacyIdName:
          type: string
        legacyId:
          type: string
    3.29.14_SiteAssociationPersonResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        site:
          $ref: '#/components/schemas/3.29.14_SiteResource'
        personType:
          type: string
          enum:
          - SITE_CONTACT
          - PERSONAL_CONTACT
          - USER
          - EMPLOYEE
          - CONTRACTOR
          - VISITOR
          - SUPERUSER
          - UNICORN_USER
          - INVALID_PERSON
          - MASTERKEY
          - CARDHOLDER
          - PAST_CARDHOLDER
          - INVISIBLE
          - IMPOSSIBLE
        personId:
          type: integer
          format: int32
        companyId:
          type: integer
          format: int32
        pending:
          type: boolean
        associationDate:
          type: string
        associatedBy:
          type: string
        createTime:
          type: string
    3.29.14_ScopeDefaultCompanyResource:
      type: object
      properties:
        scope:
          $ref: '#/components/schemas/3.29.14_ScopeDetailResource'
        company:
          $ref: '#/components/schemas/3.29.14_KeyedIntegerResource'
    3.29.14_AdminNoteResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        action:
          type: string
        noteDateTime:
          type: string
        note:
          type: string
        sysInfo:
          type: string
        scope:
          $ref: '#/components/schemas/3.29.14_ScopeDetailResource'
        user:
          $ref: '#/components/schemas/3.29.14_KeyedIntegerResource'
        authoriser:
          type: string
        restricted:
          type: boolean
        current:
          type: boolean
        active:
          type: boolean
    3.29.14_FullErrorResource:
      type: object
      properties:
        errorType:
          type: string
          enum:
          - GENERAL_ERROR
          - BAD_REQUEST
          - FORBIDDEN
          - UNAUTHORISED
          - NO_ACCESS_TO_PORTAL
          - INVALID_PASSWORD
          - NOT_FOUND
          - CONSTRAINT_VIOLATION
          - VALIDATION_ERROR
          - ALREADY_EXISTS
          - DATA_MISMATCH
          - NOT_AN_EMPLOYEE
          - CANNOT_BE_TERMINATED
          - TOO_MANY_FAILED_ATTEMPTS
          - REQUIRED_FIELD_MISSING
          - VERIFICATION_TOKEN_EXPIRED
          - PURCHASE_ORDER_EXPIRED
          - DUPLICATE_PAYMENT
          - PAYMENT_ERROR
          - CANNOT_BE_UPDATED
          - PENDING_CARD_IN_PROGRESS
          - CANNOT_ASSIGN
          - INVALID_PERSON_STATE
        error:
          type: string
        field:
          type: string
        problems:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_Problem'
        errorDetail:
          type: string
    3.29.14_SiteResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        scope:
          $ref: '#/components/schemas/3.29.14_ScopeResource'
        active:
          type: boolean
        genderCompulsory:
          type: boolean
    3.29.14_ScopeDetailResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        timezone:
          type: string
        fatigueLimit:
          type: integer
          format: int32
        siteId:
          type: integer
          format: int32
        realmId:
          type: integer
          format: int32
        concoId:
          type: integer
          format: int32
        type:
          type: string
          enum:
          - SYSTEM
          - REALM
          - SITE
          - LOCATION
          - CONCO_WEB
          - EMPLOYEE
          - UNKNOWN
        typeDisplayName:
          type: string
        ownerName:
          type: string
        connectAccountId:
          type: string
        connectClient:
          type: boolean
        parentId:
          type: integer
          format: int32
        realm:
          $ref: '#/components/schemas/3.29.14_KeyedIntegerResource'
        site:
          $ref: '#/components/schemas/3.29.14_KeyedIntegerResource'
        conco:
          $ref: '#/components/schemas/3.29.14_KeyedIntegerResource'
        topLevel:
          type: boolean
    3.29.14_KeyedIntegerClientResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        clientKey:
          $ref: '#/components/schemas/3.29.14_NaturalKeyResource'
    3.29.14_ErrorResource:
      type: object
      properties:
        errorType:
          type: string
          enum:
          - GENERAL_ERROR
          - BAD_REQUEST
          - FORBIDDEN
          - UNAUTHORISED
          - NO_ACCESS_TO_PORTAL
          - INVALID_PASSWORD
          - NOT_FOUND
          - CONSTRAINT_VIOLATION
          - VALIDATION_ERROR
          - ALREADY_EXISTS
          - DATA_MISMATCH
          - NOT_AN_EMPLOYEE
          - CANNOT_BE_TERMINATED
          - TOO_MANY_FAILED_ATTEMPTS
          - REQUIRED_FIELD_MISSING
          - VERIFICATION_TOKEN_EXPIRED
          - PURCHASE_ORDER_EXPIRED
          - DUPLICATE_PAYMENT
          - PAYMENT_ERROR
          - CANNOT_BE_UPDATED
          - PENDING_CARD_IN_PROGRESS
          - CANNOT_ASSIGN
          - INVALID_PERSON_STATE
        error:
          type: string
        field:
          type: string
        problems:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_Problem'
    3.29.14_WorkerSummaryResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        firstName:
          type: string
        lastName:
          type: string
        photoLink:
          type: string
        companies:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_KeyedIntegerClientResource'
        email1:
          type: string
        email2:
          type: string
        uniqueEmail:
          type: string
        phone1:
          type: string
        phone2:
          type: string
        address:
          $ref: '#/components/schemas/3.29.14_AddressResource'
        nextOfKin:
          $ref: '#/components/schemas/3.29.14_NextOfKinResource'
        status:
          type: string
          enum:
          - PENDING
          - APPROVED
          - ARCHIVED
        locale:
          type: string
        mergedToPersonId:
          type: integer
          format: int32
        createTime:
          type: string
        updateTime:
          type: string
        personTypes:
          type: array
          items:
            type: string
            enum:
            - SITE_CONTACT
            - PERSONAL_CONTACT
            - USER
            - EMPLOYEE
            - CONTRACTOR
            - VISITOR
            - SUPERUSER
            - UNICORN_USER
            - INVALID_PERSON
            - MASTERKEY
            - CARDHOLDER
            - PAST_CARDHOLDER
            - INVISIBLE
            - IMPOSSIBLE
        email:
          type: string
        blocked:
          type: boolean
        blockRecursive:
          type: boolean
        defaultCompanies:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_ScopeDefaultCompanyResource'
        siteLegacyIds:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_SiteLegacyIdResource'
        externalIds:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_KeyedStringResource'
        clientKey:
          $ref: '#/components/schemas/3.29.14_NaturalKeyResource'
    3.29.14_Problem:
      type: object
      properties:
        instance:
          type: string
          format: uri
        type:
          type: string
          format: uri
        parameters:
          type: object
          additionalProperties:
            type: object
        detail:
          type: string
        title:
          type: string
        status:
          $ref: '#/components/schemas/3.29.14_StatusType'
    3.29.14_AddressResource:
      required:
      - country
      type: object
      properties:
        id:
          type: integer
          format: int32
        address:
          maxLength: 200
          minLength: 0
          type: string
        town:
          maxLength: 50
          minLength: 0
          type: string
        state:
          maxLength: 50
          minLength: 0
          type: string
        postcode:
          maxLength: 15
          minLength: 0
          type: string
        country:
          maxLength: 2
          minLength: 0
          type: string
    3.29.14_BlockResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        blockType:
          type: string
          enum:
          - GENERAL
          - SAFETY_SELECTION
          - BAC
          - SITE_FAMILIARITY
        scope:
          $ref: '#/components/schemas/3.29.14_ScopeDetailResource'
        recursive:
          type: boolean
        safetySelectionRunning:
          type: boolean
        active:
          type: boolean
        contextBlock:
          type: boolean
        adminNote:
          $ref: '#/components/schemas/3.29.14_AdminNoteResource'
    3.29.14_ScopeResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        timezone:
          type: string
        fatigueLimit:
          type: integer
          format: int32
        siteId:
          type: integer
          format: int32
        realmId:
          type: integer
          format: int32
        concoId:
          type: integer
          format: int32
        type:
          type: string
          enum:
          - SYSTEM
          - REALM
          - SITE
          - LOCATION
          - CONCO_WEB
          - EMPLOYEE
          - UNKNOWN
        typeDisplayName:
          type: string
        ownerName:
          type: string
        connectAccountId:
          type: string
        connectClient:
          type: boolean
        parentId:
          type: integer
          format: int32
    3.29.14_ActionResource:
      type: object
      properties:
        actionType:
          type: string
          enum:
          - EDIT_WORKER
          - ASSOCIATE_EMPLOYEE
          - END_EMPLOYMENT
          - MANAGE_WORK_LOCATIONS
          - MODIFY_REMOVE_GROUP_REQUIREMENTS
          - EDIT_EMPLOYEE
        actionDescription:
          type: string
        actionAllowed:
          type: boolean
        actionDeniedType:
          type: string
          enum:
          - ACTION_NOT_IMPLEMENTED
          - ARCHIVED_WORKER
          - PENDING_WORKER
          - ASSESSMENT_REQUIREMENT
          - RULE_REQUIREMENT
          - USER_MISSING_PERMISSION
          - USER_CANNOT_EDIT
          - USER_CANNOT_EDIT_ON_EMPLOYEE_HOME_SITE
          - INCORRECT_USER_TYPE
          - CONCO_WEB_CONTACT
          - REALM_COMPETENCY_APPROVER
          - INCOMPLETE_TRAINING
          - USER_NOT_COMPANY_REPRESENTATIVE
          - MISSING_CARD
          - NOT_COMPANY_EMPLOYEE
          - INVALID_SCOPE
          - EMPLOYEE_NOT_VISIBLE
          - UNKNOWN
        actionDeniedDescription:
          type: string
        actionDeniedDetails:
          type: string
    3.29.14_NextOfKinResource:
      type: object
      properties:
        firstName:
          maxLength: 35
          minLength: 0
          type: string
        lastName:
          maxLength: 45
          minLength: 0
          type: string
        phone:
          maxLength: 50
          minLength: 0
          type: string
        email:
          maxLength: 255
          minLength: 0
          type: string
        relationship:
          type: string
          enum:
          - SPOUSE
          - PARTNER
          - MOTHER
          - FATHER
          - BROTHER
          - SISTER
          - SON
          - DAUGHTER
          - BOYFRIEND
          - GIRLFRIEND
          - SON_IN_LAW
          - DAUGHTER_IN_LAW
          - MOTHER_IN_LAW
          - FATHER_IN_LAW
          - OTHER
          - DOCTOR
        updateTime:
          type: string
    3.29.14_KeyedStringResource:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
  securitySchemes:
    3.29.14_security_auth:
      type: oauth2
      scheme: Bearer
      flows:
        authorizationCode:
          authorizationUrl: https://login.poweredbyonsite.com/cas/oidc/authorize
          tokenUrl: https://login.poweredbyonsite.com/cas/oidc/accessToken
          scopes:
            pegasus: Pegasus Authentication Scope
    3.29.14_security_apikey:
      type: apiKey
      name: api_key
      in: header
x-refined-from:
- avetta-pegasus-dist.json
- avetta-pegasus-openapi.yml
x-tagGroups:
- name: Compliance
  tags:
  - Authentication
  - Compliance
- name: Account
  tags:
  - Account
- name: Worksite Safety
  tags:
  - Worksite-Safety
- name: Deprecated Endpoints
  tags:
  - Deprecated Endpoints
  - Error Handling