ARCOS API Documentation - Appendix Continued, Definitions – OSCAR Portal

Navigation

Overview

Crew Manager

Extracts, Callout, sMART

Appendix

Appendix Continued, Definitions (current)

Employee Data Structures.

Schedule Data Structures.

Crew Manager Data Structures.

Checkpoint Data Structures.

Resource Assist Data Structures.

Incident Manager Data Structures.

Metadata Structures.

Miscellaneous Data Structures.

Definitions.

Employee Data Structures

Address

<xs:complexType name="address">

<xs:sequence />

<xs:attribute name="street" type="xs:string" />

<xs:attribute name="streetTwo" type="xs:string" />

<xs:attribute name="city" type="xs:string" />

<xs:attribute name="state" type="xs:string" />

<xs:attribute name="zip" type="xs:string" />

</xs:complexType>

emailAddress

<xs:complexType name="emailAddress">

<xs:sequence />

<xs:attribute name="index" type="xs:int" use="required" />

<xs:attribute name="address" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="enabled" type="xs:boolean" use="required" />

<xs:attribute name="condensed" type="xs:boolean" use="required" />

<xs:attribute name="emailProtected" type="xs:boolean" use="required" />

</xs:complexType>

coPhone

<xs:complexType name="coPhone">

<xs:complexContent>

<xs:extension base="transferPhone">

<xs:sequence />

<xs:attribute name="sequence" type="xs:int" />

<xs:attribute name="duty" type="xs:boolean" use="required" />

<xs:attribute name="trusted" type="xs:boolean" use="required" />

<xs:attribute name="pinReq" type="xs:boolean" use="required" />

<xs:attribute name="smsEnabled" type="xs:boolean" use="required" />

<xs:attribute name="temporary" type="xs:boolean" />

<xs:attribute name="expirationDate" type="xs:string" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

Employee

<xs:complexType name="employee">

<xs:sequence>

<xs:element name="attributes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="attribute" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element ref="address" minOccurs="0" />

<xs:element name="emails" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="email" type="emailAddress" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="phones" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="phone" type="coPhone" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="pagers" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="pager" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element ref="transferPhone" minOccurs="0" />

<xs:element name="webDevices" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="webDevice" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="extendedAttribute" type="mapElementArray" minOccurs="0" />

</xs:sequence>

<xs:attribute name="contactId" type="xs:int" use="required" />

<xs:attribute name="statusColor" type="xs:string" />

</xs:complexType>

transferPhone

<xs:complexType name="transferPhone">

<xs:sequence />

<xs:attribute name="number" type="xs:string" />

<xs:attribute name="phoneType" type="xs:string" />

<xs:attribute name="firstPause" type="xs:string" />

<xs:attribute name="firstTouchTone" type="xs:string" />

<xs:attribute name="secondPause" type="xs:string" />

<xs:attribute name="secondTouchTone" type="xs:string" />

<xs:attribute name="comments" type="xs:string" />

</xs:complexType>

Pager

<xs:complexType name="pager">

<xs:sequence />

<xs:attribute name="sequence" type="xs:int" />

<xs:attribute name="number" type="xs:string" />

<xs:attribute name="onDuty" type="xs:boolean" use="required" />

<xs:attribute name="pagerType" type="xs:string" />

<xs:attribute name="pin" type="xs:string" />

<xs:attribute name="temporary" type="xs:boolean" />

<xs:attribute name="expirationDate" type="xs:string" />

</xs:complexType>

webDevice

<xs:complexType name="webDevice">

<xs:sequence />

<xs:attribute name="serviceName" type="xs:string" />

<xs:attribute name="target" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="aux" type="xs:string" />

<xs:attribute name="enabled" type="xs:boolean" use="required" />

</xs:complexType>

Classification

<xs:complexType name="classification">

<xs:sequence>

<xs:element name="locations" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="location" type="xs:int" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="xwalks" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="xwalk" type="xs:string" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="classId" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="classType" type="xs:string" />

<xs:attribute name="order" type="xs:int" use="required" />

</xs:complexType>

employeeStub

<xs:complexType name="employeeStub">

<xs:sequence>

<xs:element name="emails" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="email" type="xs:string" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="phones" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="phone" type="xs:string" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="contactId" type="xs:int" use="required" />

<xs:attribute name="firstName" type="xs:string" />

<xs:attribute name="lastName" type="xs:string" />

<xs:attribute name="middleName" type="xs:string" />

<xs:attribute name="firstLastName" type="xs:string" />

<xs:attribute name="fullName" type="xs:string" />

<xs:attribute name="vruId" type="xs:string" />

<xs:attribute name="webId" type="xs:string" />

<xs:attribute name="employeeId" type="xs:string" />

<xs:attribute name="className" type="xs:string" />

<xs:attribute name="locationName" type="xs:string" />

<xs:attribute name="emplSource" type="xs:string" />

</xs:complexType>

extendedAttribute

<xs:complexType name="extendedAttribute">

<xs:sequence>

<xs:element name="category" type="attribute" minOccurs="0" />

</xs:sequence>

<xs:attribute name="attributeId" type="xs:string" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="order" type="xs:int" use="required" />

<xs:attribute name="dataType" type="xs:string" />

<xs:attribute name="attributeStatusId" type="xs:int" use="required" />

</xs:complexType>

extendedAttributeValue

<xs:complexType name="extendedAttributeValue">

<xs:sequence />

<xs:attribute name="value" type="xs:string" />

<xs:attribute name="order" type="xs:int" use="required" />

</xs:complexType>

Schedule Data Structures

Shift

<xs:complexType name="shift">

<xs:sequence>

<xs:element name="shiftDays" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="shiftDay" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="referAsList" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="referAs" type="shiftReferAs" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="signature" type="xs:string" />

</xs:complexType>

shiftDay

<xs:complexType name="shiftDay">

<xs:sequence />

<xs:attribute name="dayOfWeek" type="xs:string" />

<xs:attribute name="startTime" type="xs:string" />

<xs:attribute name="endTime" type="xs:string" />

<xs:attribute name="startsOnPreviousDay" type="xs:boolean" use="required" />

<xs:attribute name="endsOnNextDay" type="xs:boolean" use="required" />

</xs:complexType>

shiftReferAs

<xs:complexType name="shiftReferAs">

<xs:sequence />

<xs:attribute name="referAs" type="xs:string" />

<xs:attribute name="locationId" type="xs:int" use="required" />

</xs:complexType>

employeeSchedule

<xs:complexType name="employeeSchedule">

<xs:sequence>

<xs:element name="shiftAssignments" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="shiftAssignment" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="scheduledShifts" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="scheduledShift" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="scheduleExceptions" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="scheduleException" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="contactId" type="xs:int" use="required" />

<xs:attribute name="vruId" type="xs:string" />

<xs:attribute name="webId" type="xs:string" />

<xs:attribute name="empId" type="xs:string" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="locationId" type="xs:int" use="required" />

</xs:complexType>

shiftAssignment

<xs:complexType name="shiftAssignment">

<xs:sequence />

<xs:attribute name="contactId" type="xs:int" use="required" />

<xs:attribute name="custIdType" type="xs:string" />

<xs:attribute name="custIdValue" type="xs:string" />

<xs:attribute name="shiftId" type="xs:int" use="required" />

<xs:attribute name="shiftReferAs" type="xs:string" />

<xs:attribute name="assignmentStart" type="xs:string" />

<xs:attribute name="modified" type="xs:boolean" use="required" />

<xs:attribute name="addDate" type="xs:string" />

<xs:attribute name="changeDate" type="xs:string" />

</xs:complexType>

scheduledShift

<xs:complexType name="scheduledShift">

<xs:complexContent>

<xs:extension base="scheduleRecord">

<xs:sequence />

<xs:attribute name="treatAs" type="xs:string" />

<xs:attribute name="isHoliday" type="xs:boolean" use="required" />

<xs:attribute name="isWorkingHoliday" type="xs:boolean" use="required" />

<xs:attribute name="modified" type="xs:boolean" use="required" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

scheduleRecord

<xs:complexType name="scheduleRecord">

<xs:sequence>

<xs:element name="attributes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="attributes" type="attribute" nillable="true" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="memexId" type="xs:int" use="required" />

<xs:attribute name="contactId" type="xs:int" use="required" />

<xs:attribute name="custIdType" type="xs:string" />

<xs:attribute name="custIdValue" type="xs:string" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="eventId" type="xs:int" use="required" />

<xs:attribute name="startTime" type="xs:string" />

<xs:attribute name="endTime" type="xs:string" />

<xs:attribute name="comment" type="xs:string" />

<xs:attribute name="isActive" type="xs:boolean" use="required" />

<xs:attribute name="locationId" type="xs:int" use="required" />

<xs:attribute name="vehicleId" type="xs:int" use="required" />

<xs:attribute name="restFlag" type="xs:int" use="required" />

<xs:attribute name="addDate" type="xs:string" />

<xs:attribute name="changeDate" type="xs:string" />

</xs:complexType>

scheduleException

<xs:complexType name="scheduleException">

<xs:complexContent>

<xs:extension base="scheduleRecord">

<xs:sequence />

<xs:attribute name="coId" type="xs:long" use="required" />

<xs:attribute name="estimatedEndTime" type="xs:string" />

<xs:attribute name="releaseFlag" type="xs:int" use="required" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

scheduleRequestRecord

<xs:complexType name="scheduleRequestRecord">

<xs:sequence />

<xs:attribute name="schedRequestId" type="xs:int" use="required" />

<xs:attribute name="memexId" type="xs:int" use="required" />

<xs:attribute name="contactId" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="eventId" type="xs:int" use="required" />

<xs:attribute name="startDate" type="xs:dateTime" />

<xs:attribute name="endDate" type="xs:dateTime" />

<xs:attribute name="requestStatus" type="xs:string" />

<xs:attribute name="isDeleted" type="xs:boolean" use="required" />

<xs:attribute name="declineReason" type="xs:string" />

<xs:attribute name="comments" type="xs:string" />

<xs:attribute name="notifiedDateString" type="xs:string" />

<xs:attribute name="eventAbbrev" type="xs:string" />

<xs:attribute name="tzName" type="xs:string" />

<xs:attribute name="empName" type="xs:string" />

<xs:attribute name="empLocId" type="xs:int" use="required" />

<xs:attribute name="empLocName" type="xs:string" />

<xs:attribute name="addDate" type="xs:dateTime" />

<xs:attribute name="startDateString" type="xs:string" />

<xs:attribute name="endDateString" type="xs:string" />

</xs:complexType>

scheduleEvent

<xs:complexType name="scheduleEvent">

<xs:sequence>

<xs:element name="eventTraits" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="eventTrait" type="eventTraitValue" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="isEnabled" type="xs:int" />

</xs:sequence>

<xs:attribute name="eventId" type="xs:int" use="required" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="abbreviation" type="xs:string" />

<xs:attribute name="recording" type="xs:int" use="required" />

</xs:complexType>

Crew Manager Data Structures

Group

<xs:complexType name="group">

<xs:complexContent>

<xs:extension base="attributeElement">

<xs:sequence />

<xs:attribute name="viewId" type="xs:int" />

<xs:attribute name="crewIds">

<xs:simpleType>

<xs:list itemType="xs:int" />

</xs:simpleType>

</xs:attribute>

<xs:attribute name="memberCnt" type="xs:int" use="required" />

<xs:attribute name="bgColor" type="xs:string" />

<xs:attribute name="fontColor" type="xs:string" />

<xs:attribute name="borderColor" type="xs:string" />

<xs:attribute name="chartAttributes">

<xs:simpleType>

<xs:list itemType="xs:string" />

</xs:simpleType>

</xs:attribute>

<xs:attribute name="ord" type="xs:string" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

roomCapacity

<xs:complexType name="roomCapacity">

<xs:sequence />

<xs:attribute name="roomType" type="xs:int" use="required" />

<xs:attribute name="quantity" type="xs:int" use="required" />

<xs:attribute name="rate" type="xs:double" use="required" />

</xs:complexType>

workTicket

<xs:complexType name="workTicket">

<xs:sequence />

<xs:attribute name="id" type="xs:int" />

<xs:attribute name="crewId" type="xs:int" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="start" type="xs:string" />

<xs:attribute name="end" type="xs:string" />

</xs:complexType>

<xs:complexType name="member">

<xs:complexContent>

<xs:extension base="attributeElement">

<xs:sequence>

<xs:element name="scheduleRecords" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="scheduleRecord" type="memberScheduleRecord" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="crewId" type="xs:int" />

<xs:attribute name="siteId" type="xs:int" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

memberScheduleRecord

<xs:complexType name="memberScheduleRecord">

<xs:sequence />

<xs:attribute name="memexId" type="xs:int" />

<xs:attribute name="eventId" type="xs:int" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="comment" type="xs:string" />

<xs:attribute name="startTime" type="xs:string" />

<xs:attribute name="endTime" type="xs:string" />

</xs:complexType>

Crew

<xs:complexType name="crew">

<xs:complexContent>

<xs:extension base="attributeElement">

<xs:sequence>

<xs:element name="tickets" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="ticket" type="workTicket" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="memberCnt" type="xs:int" />

</xs:sequence>

<xs:attribute name="bgColor" type="xs:string" />

<xs:attribute name="fontColor" type="xs:string" />

<xs:attribute name="nameBgColor" type="xs:string" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

Lodging

<xs:complexType name="lodging">

<xs:complexContent>

<xs:extension base="attributeElement">

<xs:sequence>

<xs:element name="rooms" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="capacity" type="roomCapacity" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="availabilityList" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="availability" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

Availability

<xs:complexType name="availability">

<xs:sequence />

<xs:attribute name="id" type="xs:int" />

<xs:attribute name="lodgingId" type="xs:int" />

<xs:attribute name="roomTypeId" type="xs:int" />

<xs:attribute name="date" type="xs:string" />

<xs:attribute name="available" type="xs:int" use="required" />

<xs:attribute name="booked" type="xs:int" use="required" />

<xs:attribute name="rate" type="xs:double" use="required" />

<xs:attribute name="note" type="xs:string" />

<xs:attribute name="changeDate" type="xs:string" />

<xs:attribute name="user" type="xs:string" />

</xs:complexType>

roomType

<xs:complexType name="roomType">

<xs:complexContent>

<xs:extension base="attributeElement">

<xs:all />

<xs:attribute name="size" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="abbreviation" type="xs:string" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

Resource

<xs:complexType name="resource">

<xs:complexContent>

<xs:extension base="attributeElement">

<xs:sequence />

<xs:attribute name="resourceType" type="xs:string" />

<xs:attribute name="resourceTypeId" type="xs:int" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

classResourceTypes

<xs:complexType name="classResourceTypes">

<xs:sequence />

<xs:attribute name="resourceId" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="customFlag" type="xs:int" use="required" />

</xs:complexType>

workOrder

<xs:complexType name="workOrder">

<xs:complexContent>

<xs:extension base="resource">

<xs:sequence>

<xs:element name="workOrderTimeEntries" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="workOrderTimeEntry" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

workOrderTimeEntry

<xs:complexType name="workOrderTimeEntry">

<xs:sequence />

<xs:attribute name="id" type="xs:int" />

<xs:attribute name="changeId" type="xs:int" />

<xs:attribute name="crewId" type="xs:int" />

<xs:attribute name="start" type="xs:string" />

<xs:attribute name="end" type="xs:string" />

<xs:attribute name="hours" type="xs:double" />

<xs:attribute name="comments" type="xs:string" />

<xs:attribute name="changeDate" type="xs:string" />

</xs:complexType>

Assignment

<xs:complexType name="assignment">

<xs:choice>

<xs:element ref="attributeElement" />

<xs:element ref="crewGroup" />

<xs:element ref="crew" />

<xs:element ref="member" />

<xs:element ref="lodging" />

<xs:element ref="roomType" />

<xs:element ref="resource" />

<xs:element ref="workOrder" />

</xs:choice>

<xs:attribute name="assignId" type="xs:int" />

<xs:attribute name="label" type="xs:string" />

<xs:attribute name="assignStart" type="xs:string" />

<xs:attribute name="assignEnd" type="xs:string" />

<xs:attribute name="changeDate" type="xs:string" />

</xs:complexType>

attributeRecord

<xs:complexType name="attributeRecord">

<xs:sequence />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="value" type="xs:string" />

<xs:attribute name="start" type="xs:string" />

<xs:attribute name="end" type="xs:string" />

<xs:attribute name="changeId" type="xs:int" />

<xs:attribute name="changeDate" type="xs:string" />

<xs:attribute name="bgColor" type="xs:string" />

<xs:attribute name="badgeText" type="xs:string" />

<xs:attribute name="image" type="xs:string" />

<xs:attribute name="ord" type="xs:string" />

<xs:attribute name="fontColor" type="xs:string" />

<xs:attribute name="borderColor" type="xs:string" />

<xs:attribute name="chartBgColors" type="xs:string" />

</xs:complexType>

attributeCollection

<xs:complexType name="attributeCollection">

<xs:sequence>

<xs:element name="attributes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="attributeRecord" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="targetType" type="xs:string" />

<xs:attribute name="id" type="xs:int" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="searchType" type="xs:string" />

<xs:attribute name="searchValue" type="xs:string" />

</xs:complexType>

attributeElement

<xs:complexType name="attributeElement" abstract="true">

<xs:sequence>

<xs:element name="attributes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="attributeRecord" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="assignments" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="assignment" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="createdDate" type="xs:string" />

<xs:attribute name="deletedDate" type="xs:string" />

<xs:attribute name="changedDate" type="xs:string" />

<xs:attribute name="searchType" type="xs:string" />

<xs:attribute name="searchValue" type="xs:string" />

<xs:attribute name="delete" type="xs:boolean" />

</xs:complexType>

attributeDefinition

<xs:complexType name="attributeDefinition">

<xs:sequence>

<xs:element name="properties" type="mapElementArray" minOccurs="0" />

<xs:element name="values" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="value" type="attributeValue" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="target" type="xs:string" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="addDate" type="xs:string" />

</xs:complexType>

attributeValue

<xs:complexType name="attributeValue">

<xs:sequence>

<xs:element name="dataPoints" type="mapElementArray" minOccurs="0" />

</xs:sequence>

<xs:attribute name="value" type="xs:string" />

<xs:attribute name="ord" type="xs:string" />

<xs:attribute name="bgColor" type="xs:string" />

<xs:attribute name="badgeText" type="xs:string" />

<xs:attribute name="image" type="xs:string" />

<xs:attribute name="fontColor" type="xs:string" />

<xs:attribute name="borderColor" type="xs:string" />

</xs:complexType>

savedSet

<xs:complexType name="savedSet">

<xs:sequence>

<xs:element name="propertyMap" type="mapElementArray" minOccurs="0" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="userId" type="xs:int" use="required" />

<xs:attribute name="isPublic" type="xs:boolean" use="required" />

<xs:attribute name="userName" type="xs:string" />

<xs:attribute name="ownerId" type="xs:int" use="required" />

<xs:attribute name="ownerName" type="xs:string" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="type" type="xs:string" />

<xs:attribute name="specialFlag" type="xs:string" />

<xs:attribute name="changeDate" type="xs:string" />

</xs:complexType>

crewManagerData

<xs:complexType name="crewManagerData">

<xs:sequence>

<xs:element name="groups" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="group" type="group" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="lodgings" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="lodging" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="resources" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="resource" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="attributes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="attribute" type="attributeDefinition" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

Filter

<xs:complexType name="filter">

<xs:complexContent>

<xs:extension base="savedSet">

<xs:sequence>

<xs:element name="entries" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="entry" type="filterEntry" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

filterEntry

<xs:complexType name="filterEntry">

<xs:sequence>

<xs:element name="values" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="values" type="xs:string" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:string" />

</xs:complexType>

viewSet

<xs:complexType name="viewSet">

<xs:complexContent>

<xs:extension base="savedSet">

<xs:sequence>

<xs:element name="targets" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="target" type="xs:string" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="selectedAttributes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="attribute" type="viewAttribute" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

viewAttribute

<xs:complexType name="viewAttribute">

<xs:sequence />

<xs:attribute name="targetAdo" type="xs:string" />

<xs:attribute name="badge" type="xs:int" use="required" />

<xs:attribute name="icon" type="xs:int" use="required" />

<xs:attribute name="tab" type="xs:int" use="required" />

<xs:attribute name="bar" type="xs:int" use="required" />

<xs:attribute name="pie" type="xs:int" use="required" />

<xs:attribute name="list" type="xs:string" />

</xs:complexType>

resourceTypeDefinition

<xs:complexType name="resourceTypeDefinition">

<xs:sequence />

<xs:attribute name="id" type="xs:int" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

</xs:complexType>

Perspective

<xs:complexType name="perspective">

<xs:complexContent>

<xs:extension base="savedSet">

<xs:sequence>

<xs:element name="filters" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="filter" type="xs:string" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="views" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="view" type="xs:string" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="resourceTypes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="resourceTypes" type="xs:string" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="notes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="notes" type="xs:string" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

Checkpoint Data Structures

bulkCheckin

<xs:complexType name="bulkCheckin">

<xs:sequence />

<xs:attribute name="contactIds">

<xs:simpleType>

<xs:list itemType="xs:int" />

</xs:simpleType>

</xs:attribute>

<xs:attribute name="checkpointIds">

<xs:simpleType>

<xs:list itemType="xs:int" />

</xs:simpleType>

</xs:attribute>

<xs:attribute name="timestamps">

<xs:simpleType>

<xs:list itemType="xs:string" />

</xs:simpleType>

</xs:attribute>

<xs:attribute name="userId" type="xs:int" use="required" />

</xs:complexType>

Checkpoint

<xs:complexType name="checkpoint">

<xs:sequence />

<xs:attribute name="checkpointId" type="xs:int" use="required" />

<xs:attribute name="eventId" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="isActive" type="xs:boolean" use="required" />

<xs:attribute name="eventName" type="xs:string" />

<xs:attribute name="activatedOn" type="xs:string" />

<xs:attribute name="validScans" type="xs:int" use="required" />

<xs:attribute name="invalidScans" type="xs:int" use="required" />

<xs:attribute name="templateId" type="xs:int" use="required" />

<xs:attribute name="status" type="checkpointStatus" />

</xs:complexType>

checkpointActivity

<xs:complexType name="checkpointActivity">

<xs:sequence />

<xs:attribute name="activityId" type="xs:int" use="required" />

<xs:attribute name="checkpointId" type="xs:int" use="required" />

<xs:attribute name="resourceType" type="resourceType" />

<xs:attribute name="resourceId" type="xs:int" use="required" />

<xs:attribute name="result" type="xs:int" use="required" />

<xs:attribute name="entryType" type="entryType" />

<xs:attribute name="scannedBy" type="xs:int" use="required" />

<xs:attribute name="createdOn" type="xs:string" />

<xs:attribute name="salt" type="xs:string" />

</xs:complexType>

checkpointAssignment

<xs:complexType name="checkpointAssignment">

<xs:sequence />

<xs:attribute name="contactId" type="xs:int" use="required" />

<xs:attribute name="checkpointId" type="xs:int" use="required" />

<xs:attribute name="isActive" type="xs:boolean" use="required" />

<xs:attribute name="activatedOn" type="xs:string" />

<xs:attribute name="deactivatedOn" type="xs:string" />

<xs:attribute name="createdBy" type="xs:int" use="required" />

<xs:attribute name="createdOn" type="xs:string" />

<xs:attribute name="updatedBy" type="xs:int" use="required" />

<xs:attribute name="updatedOn" type="xs:string" />

</xs:complexType>

checkpointTemplate

<xs:complexType name="checkpointTemplate">

<xs:sequence />

<xs:attribute name="templateId" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="isActive" type="xs:boolean" use="required" />

<xs:attribute name="createdOn" type="xs:string" />

</xs:complexType>

checkpointStatus

<xs:simpleType name="checkpointStatus">

<xs:restriction base="xs:string">

<xs:enumeration value="Deleted" />

<xs:enumeration value="Active" />

<xs:enumeration value="Archived" />

</xs:restriction>

</xs:simpleType>

resourceType

<xs:simpleType name="resourceType">

<xs:restriction base="xs:string">

<xs:enumeration value="Employee" />

</xs:restriction>

</xs:simpleType>

entryType

<xs:simpleType name="entryType">

<xs:restriction base="xs:string">

<xs:enumeration value="Scanned" />

<xs:enumeration value="Manual" />

</xs:restriction>

</xs:simpleType>

Resource Assist Data Structures

raDocument

<xs:complexType name="raDocument">

<xs:sequence>

<xs:element name="user" type="attribute" minOccurs="0" />

<xs:element name="storage" type="cloudStorage" minOccurs="0" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="requestId" type="xs:int" use="required" />

<xs:attribute name="attachmentType" type="xs:int" use="required" />

<xs:attribute name="deleted" type="xs:int" use="required" />

<xs:attribute name="fileSize" type="xs:int" use="required" />

<xs:attribute name="displayName" type="xs:string" />

<xs:attribute name="fileName" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="addDate" type="xs:dateTime" />

</xs:complexType>

Incident Manager Data Structures

cloudStorage

<xs:complexType name="cloudStorage">

<xs:sequence />

<xs:attribute name="type" type="xs:string" />

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="stringId" type="xs:string" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="service" type="xs:string" />

<xs:attribute name="region" type="xs:string" />

<xs:attribute name="bucket" type="xs:string" />

<xs:attribute name="hash" type="xs:string" />

<xs:attribute name="added" type="xs:dateTime" />

</xs:complexType>

Document

<xs:complexType name="document">

<xs:sequence>

<xs:element name="storage" type="cloudStorage" minOccurs="0" />

<xs:element name="event" type="attribute" minOccurs="0" />

<xs:element name="user" type="attribute" minOccurs="0" />

<xs:element name="roles" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="role" type="attribute" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="link" type="xs:string" minOccurs="0" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="template" type="xs:boolean" use="required" />

<xs:attribute name="version" type="xs:int" use="required" />

<xs:attribute name="parentId" type="xs:int" />

<xs:attribute name="respondent" type="xs:string" />

<xs:attribute name="added" type="xs:dateTime" />

<xs:attribute name="active" type="xs:boolean" use="required" />

</xs:complexType>

documentRoute

<xs:complexType name="documentRoute">

<xs:sequence>

<xs:element name="document" type="attribute" minOccurs="0" />

<xs:element name="role" type="attribute" minOccurs="0" />

<xs:element name="email" type="routeEmail" minOccurs="0" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="act" type="xs:int" use="required" />

<xs:attribute name="targetType" type="xs:int" use="required" />

<xs:attribute name="targetVal" type="xs:string" />

<xs:attribute name="startDate" type="xs:dateTime" />

<xs:attribute name="endDate" type="xs:dateTime" />

<xs:attribute name="lastSent" type="xs:dateTime" />

<xs:attribute name="recurMins" type="xs:int" use="required" />

<xs:attribute name="active" type="xs:boolean" use="required" />

<xs:attribute name="emailFlag" type="xs:int" use="required" />

<xs:attribute name="notificationFlag" type="xs:int" use="required" />

</xs:complexType>

routeEmail

<xs:complexType name="routeEmail">

<xs:sequence>

<xs:element name="emails" type="xs:string" minOccurs="0" />

</xs:sequence>

<xs:attribute name="subject" type="xs:string" />

<xs:attribute name="replyTo" type="xs:string" />

<xs:attribute name="message" type="xs:string" />

</xs:complexType>

emCrew

<xs:complexType name="emCrew">

<xs:sequence />

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="addDate" type="xs:string" />

<xs:attribute name="createDate" type="xs:string" />

</xs:complexType>

emLocation

<xs:complexType name="emLocation">

<xs:sequence>

<xs:element name="category" type="locationCategory" minOccurs="0" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="address" type="xs:string" />

<xs:attribute name="formattedAddress" type="xs:string" />

<xs:attribute name="lat" type="xs:string" />

<xs:attribute name="lon" type="xs:string" />

<xs:attribute name="phone" type="xs:string" />

<xs:attribute name="messageId" type="xs:int" use="required" />

<xs:attribute name="displayOrder" type="xs:int" use="required" />

<xs:attribute name="changeDate" type="xs:string" />

</xs:complexType>

locationCategory

<xs:complexType name="locationCategory">

<xs:sequence />

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

</xs:complexType>

emMassCall

<xs:complexType name="emMassCall">

<xs:sequence />

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="status" type="xs:string" />

</xs:complexType>

emProcess

<xs:complexType name="emProcess">

<xs:sequence>

<xs:element name="role" type="attribute" minOccurs="0" />

<xs:element name="responseGroup" type="attribute" minOccurs="0" />

<xs:element name="steps" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="steps" type="processStep" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="previewStartDate" type="xs:string" />

</xs:complexType>

processStep

<xs:complexType name="processStep">

<xs:sequence>

<xs:element name="attributes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="attribute" type="stepAttribute" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="processId" type="xs:int" use="required" />

<xs:attribute name="type" type="xs:int" use="required" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="order" type="xs:int" use="required" />

<xs:attribute name="details" type="xs:string" />

</xs:complexType>

stepAttribute

<xs:complexType name="stepAttribute">

<xs:sequence />

<xs:attribute name="stepId" type="xs:int" use="required" />

<xs:attribute name="type" type="xs:string" />

<xs:attribute name="attrId" type="xs:int" use="required" />

<xs:attribute name="value" type="xs:string" />

<xs:attribute name="order" type="xs:int" use="required" />

</xs:complexType>

Event

<xs:complexType name="event">

<xs:sequence>

<xs:element name="eventTeam" type="attribute" minOccurs="0" />

<xs:element name="scenario" type="attribute" minOccurs="0" />

<xs:element name="root" type="eventNode" minOccurs="0" />

<xs:element name="phases" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="phase" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="acknowledgedContacts" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="contact" type="attribute" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="severity" type="xs:int" use="required" />

<xs:attribute name="template" type="xs:boolean" use="required" />

<xs:attribute name="addDate" type="xs:string" />

<xs:attribute name="startDate" type="xs:string" />

<xs:attribute name="endDate" type="xs:string" />

<xs:attribute name="active" type="xs:boolean" use="required" />

<xs:attribute name="changeDate" type="xs:string" />

<xs:attribute name="notificationCo" type="xs:int" />

<xs:attribute name="earliestActionDate" type="xs:string" />

</xs:complexType>

eventNode

<xs:complexType name="eventNode">

<xs:sequence>

<xs:element name="location" type="attribute" minOccurs="0" />

<xs:element name="roleRequests" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="request" type="roleRequest" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="contacts" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="contact" type="contactInfo" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="children" type="eventNode" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="eventId" type="xs:int" use="required" />

<xs:attribute name="reportsTo" type="xs:int" use="required" />

<xs:attribute name="roleId" type="xs:int" use="required" />

<xs:attribute name="deputy" type="xs:boolean" use="required" />

<xs:attribute name="prefix" type="xs:string" />

<xs:attribute name="suffix" type="xs:string" />

<xs:attribute name="state" type="xs:int" use="required" />

</xs:complexType>

roleRequest

<xs:complexType name="roleRequest">

<xs:sequence>

<xs:element name="event" type="attribute" minOccurs="0" />

<xs:element name="status" type="attribute" minOccurs="0" />

<xs:element name="role" type="attribute" minOccurs="0" />

<xs:element name="employees" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="employee" type="requestEmployee" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="attributes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="attribute" type="requestAttribute" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="startDate" type="xs:string" />

<xs:attribute name="endDate" type="xs:string" />

<xs:attribute name="eventNode" type="xs:int" use="required" />

<xs:attribute name="changedDate" type="xs:string" />

<xs:attribute name="coMainId" type="xs:int" use="required" />

<xs:attribute name="coId" type="xs:int" use="required" />

<xs:attribute name="callAvailOnly" type="xs:boolean" use="required" />

<xs:attribute name="quantity" type="xs:int" use="required" />

</xs:complexType>

requestEmployee

<xs:complexType name="requestEmployee">

<xs:sequence>

<xs:element name="employee" type="attribute" minOccurs="0" />

<xs:element name="result" type="attribute" minOccurs="0" />

<xs:element name="resultSource" type="attribute" minOccurs="0" />

<xs:element name="team" type="attribute" minOccurs="0" />

<xs:element name="schedule" type="attribute" minOccurs="0" />

</xs:sequence>

<xs:attribute name="requestId" type="xs:int" use="required" />

<xs:attribute name="order" type="xs:int" use="required" />

<xs:attribute name="resultDate" type="xs:string" />

<xs:attribute name="calls" type="xs:int" use="required" />

<xs:attribute name="emails" type="xs:int" use="required" />

<xs:attribute name="texts" type="xs:int" use="required" />

<xs:attribute name="notifications" type="xs:int" use="required" />

<xs:attribute name="comment" type="xs:string" />

<xs:attribute name="teamOrder" type="xs:int" use="required" />

<xs:attribute name="userValue1" type="xs:string" />

<xs:attribute name="userValue2" type="xs:string" />

</xs:complexType>

requestAttribute

<xs:complexType name="requestAttribute">

<xs:sequence />

<xs:attribute name="requestId" type="xs:int" use="required" />

<xs:attribute name="attrId" type="xs:int" use="required" />

<xs:attribute name="value" type="xs:string" />

</xs:complexType>

Phase

<xs:complexType name="phase">

<xs:sequence>

<xs:element name="activationRoles" type="xs:int" minOccurs="0" maxOccurs="unbounded" />

<xs:element name="deactivationRoles" type="xs:int" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="eventId" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="order" type="xs:int" use="required" />

</xs:complexType>

eventCategory

<xs:complexType name="eventCategory">

<xs:sequence />

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="group" type="xs:string" />

<xs:attribute name="addDate" type="xs:string" />

</xs:complexType>

eventHistory

<xs:complexType name="eventHistory">

<xs:sequence>

<xs:element name="event" type="attribute" minOccurs="0" />

<xs:element name="transactions" type="eventTransaction" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

eventTransaction

<xs:complexType name="eventTransaction">

<xs:sequence>

<xs:element name="user" type="attribute" minOccurs="0" />

</xs:sequence>

<xs:attribute name="transaction" type="xs:string" />

<xs:attribute name="date" type="xs:string" />

<xs:attribute name="source" type="xs:string" />

<xs:attribute name="eventId" type="xs:int" use="required" />

</xs:complexType>

eventTeam

<xs:complexType name="eventTeam">

<xs:sequence>

<xs:element name="employees" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="employeePerm" type="teamPermission" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element ref="readyCheckConfig" minOccurs="0" />

<xs:element name="tz" type="attribute" minOccurs="0" />

<xs:element name="ignoredRoles" type="xs:int" minOccurs="0" maxOccurs="unbounded" />

<xs:element name="ignoredFunctions" type="xs:int" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="teamDesc" type="xs:string" />

<xs:attribute name="active" type="xs:boolean" use="required" />

<xs:attribute name="activeEvents" type="xs:int" use="required" />

<xs:attribute name="scenarios" type="xs:int" use="required" />

<xs:attribute name="roles" type="xs:int" use="required" />

<xs:attribute name="teams" type="xs:int" use="required" />

<xs:attribute name="changeDate" type="xs:string" />

</xs:complexType>

teamPermission

<xs:complexType name="teamPermission">

<xs:sequence>

<xs:element name="permissions" type="xs:int" />

</xs:sequence>

<xs:attribute name="teamId" type="xs:int" use="required" />

<xs:attribute name="contactId" type="xs:int" use="required" />

</xs:complexType>

readyCheckConfig

<xs:complexType name="readyCheckConfig">

<xs:sequence>

<xs:element name="incidentStartNotification" type="xs:int" />

<xs:element name="autoInitiateRequest" type="xs:boolean" />

<xs:element name="autoInitiateNextRequest" type="xs:boolean" />

<xs:element name="onDeckMinutes" type="xs:int" />

<xs:element name="sendDeactivation" type="xs:boolean" />

<xs:element name="requireAcknowledge" type="xs:boolean" />

<xs:element name="calloutNotification" type="xs:boolean" />

<xs:element name="smsNotification" type="xs:boolean" />

</xs:sequence>

</xs:complexType>

eventWrapper

<xs:complexType name="eventWrapper">

<xs:sequence>

<xs:element name="incidents" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="incident" type="event" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="crews" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="crew" type="emCrew" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="stormcodes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="stormcodes" type="stormCode" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="callouts" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="callouts" type="callout" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="masscalls" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="masscalls" type="emMassCall" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="deleted" type="xs:boolean" use="required" />

<xs:attribute name="addDate" type="xs:string" />

<xs:attribute name="closeDate" type="xs:string" />

<xs:attribute name="closed" type="xs:boolean" use="required" />

<xs:attribute name="categoryId" type="xs:int" use="required" />

<xs:attribute name="email" type="xs:string" />

<xs:attribute name="application" type="xs:string" />

<xs:attribute name="startDate" type="xs:string" />

<xs:attribute name="endDate" type="xs:string" />

<xs:attribute name="categoryName" type="xs:string" />

<xs:attribute name="categoryGroup" type="xs:string" />

</xs:complexType>

stormCode

<xs:complexType name="stormCode">

<xs:sequence />

<xs:attribute name="application" type="xs:string" />

<xs:attribute name="enabled" type="xs:int" use="required" />

<xs:attribute name="storm" type="xs:string" />

<xs:attribute name="stormCode" type="xs:string" />

<xs:attribute name="stormId" type="xs:int" use="required" />

<xs:attribute name="wrapperId" type="xs:int" use="required" />

</xs:complexType>

icsFunction

<xs:complexType name="icsFunction">

<xs:sequence>

<xs:element name="eventTeam" type="attribute" minOccurs="0" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="color" type="xs:string" />

<xs:attribute name="active" type="xs:boolean" use="required" />

</xs:complexType>

Level

<xs:complexType name="level">

<xs:sequence>

<xs:element name="eventTeam" type="attribute" minOccurs="0" />

<xs:element name="roles" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="role" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="logicalLevel" type="xs:int" use="required" />

<xs:attribute name="leaderName" type="xs:string" />

<xs:attribute name="assistantName" type="xs:string" />

<xs:attribute name="deletedFlag" type="xs:int" use="required" />

</xs:complexType>

Role

<xs:complexType name="role">

<xs:sequence>

<xs:element name="eventTeam" type="attribute" minOccurs="0" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="employeeCount" type="xs:int" use="required" />

<xs:attribute name="templateCount" type="xs:int" use="required" />

<xs:attribute name="prefix" type="xs:string" />

<xs:attribute name="heading" type="xs:string" />

<xs:attribute name="leaderName" type="xs:string" />

<xs:attribute name="assistantName" type="xs:string" />

<xs:attribute name="nameMethod" type="xs:int" use="required" />

<xs:attribute name="functionId" type="xs:int" use="required" />

<xs:attribute name="levelId" type="xs:int" use="required" />

<xs:attribute name="active" type="xs:boolean" use="required" />

<xs:attribute name="displayOrder" type="xs:int" use="required" />

<xs:attribute name="callAvailOnly" type="xs:boolean" use="required" />

</xs:complexType>

logEntryCategory

<xs:complexType name="logEntryCategory">

<xs:sequence>

<xs:element name="name" type="xs:string" minOccurs="0" />

<xs:element name="level" type="xs:int" />

<xs:element name="deleted" type="xs:int" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

</xs:complexType>

nodeDocument

<xs:complexType name="nodeDocument">

<xs:sequence>

<xs:element name="documents" type="document" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

</xs:complexType>

processTeam

<xs:complexType name="processTeam">

<xs:sequence>

<xs:element name="responseGroup" type="attribute" minOccurs="0" />

<xs:element name="processes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="process" type="emProcess" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

</xs:complexType>

requestContact

<xs:complexType name="requestContact">

<xs:sequence>

<xs:element name="event" type="attribute" minOccurs="0" />

<xs:element name="requestStatus" type="attribute" minOccurs="0" />

<xs:element name="contactResult" type="attribute" minOccurs="0" />

<xs:element name="role" type="attribute" minOccurs="0" />

</xs:sequence>

<xs:attribute name="requestId" type="xs:int" use="required" />

<xs:attribute name="contactId" type="xs:int" use="required" />

<xs:attribute name="requestStartDate" type="xs:string" />

<xs:attribute name="requestEndDate" type="xs:string" />

</xs:complexType>

Scenario

<xs:complexType name="scenario">

<xs:sequence>

<xs:element name="eventTeam" type="attribute" minOccurs="0" />

<xs:element name="eventTemplates" type="xs:int" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="active" type="xs:boolean" use="required" />

<xs:attribute name="changeDate" type="xs:string" />

</xs:complexType>

Settings

<xs:complexType name="settings">

<xs:sequence />

<xs:attribute name="severityLevels" type="xs:int" use="required" />

<xs:attribute name="severityDescending" type="xs:boolean" use="required" />

<xs:attribute name="severityMax" type="xs:int" use="required" />

</xs:complexType>

stateChange

<xs:complexType name="stateChange">

<xs:sequence>

<xs:element name="roles" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="role" type="xs:int" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="state" type="xs:int" use="required" />

<xs:attribute name="status" type="xs:int" use="required" />

<xs:attribute name="eventId" type="xs:int" use="required" />

</xs:complexType>

templateRoleCollection

<xs:complexType name="templateRoleCollection">

<xs:sequence>

<xs:element name="roles" type="xs:int" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

<xs:attribute name="eventId" type="xs:int" use="required" />

<xs:attribute name="scenarioId" type="xs:int" use="required" />

<xs:attribute name="severity" type="xs:int" use="required" />

</xs:complexType>

events.Event

<xs:complexType name="events.Event">

<xs:sequence>

<xs:element name="incidents" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="incident" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="crews" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="crew" type="emCrew" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="stormcodes" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="stormcodes" type="stormCode" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="callouts" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="callouts" type="callout" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="masscalls" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="masscalls" type="emMassCall" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="deleted" type="xs:boolean" use="required" />

<xs:attribute name="addDate" type="xs:string" />

<xs:attribute name="closeDate" type="xs:string" />

<xs:attribute name="closed" type="xs:boolean" use="required" />

<xs:attribute name="startDate" type="xs:string" />

<xs:attribute name="endDate" type="xs:string" />

<xs:attribute name="categoryId" type="xs:int" use="required" />

<xs:attribute name="email" type="xs:string" />

<xs:attribute name="application" type="xs:string" />

<xs:attribute name="categoryName" type="xs:string" />

<xs:attribute name="categoryGroup" type="xs:string" />

</xs:complexType>

Incident

<xs:complexType name="incident">

<xs:sequence>

<xs:element name="eventTeam" type="attribute" minOccurs="0" />

<xs:element name="scenario" type="attribute" minOccurs="0" />

<xs:element name="root" type="eventNode" minOccurs="0" />

<xs:element name="phases" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="phase" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="acknowledgedContacts" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="contact" type="attribute" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="severity" type="xs:int" use="required" />

<xs:attribute name="template" type="xs:boolean" use="required" />

<xs:attribute name="addDate" type="xs:string" />

<xs:attribute name="startDate" type="xs:string" />

<xs:attribute name="endDate" type="xs:string" />

<xs:attribute name="deleted" type="xs:boolean" use="required" />

<xs:attribute name="changeDate" type="xs:string" />

<xs:attribute name="notificationCo" type="xs:int" />

<xs:attribute name="earliestActionDate" type="xs:string" />

</xs:complexType>

Metadata Structures

XWalk

<xs:complexType name="xwalk">

<xs:sequence />

<xs:attribute name="type" type="xs:string" />

<xs:attribute name="arcosId" type="xs:string" />

<xs:attribute name="custId" type="xs:string" />

</xs:complexType>

Miscellaneous Data Structures

mapElement

<xs:complexType name="mapElement">

<xs:sequence />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="value" type="xs:string" />

</xs:complexType>

jsonObject

<xs:complexType name="jsonObject">

<xs:complexContent>

<xs:extension base="hashMap">

<xs:sequence />

</xs:extension>

</xs:complexContent>

</xs:complexType>

hashMap

<xs:complexType name="hashMap">

<xs:complexContent>

<xs:extension base="abstractMap">

<xs:sequence />

</xs:extension>

</xs:complexContent>

</xs:complexType>

abstractMap

<xs:complexType name="abstractMap" abstract="true">

<xs:sequence />

</xs:complexType>

mapElementAttay

<xs:complexType name="mapElementArray" final="#all">

<xs:sequence>

<xs:element name="item" type="mapElement" minOccurs="0" maxOccurs="unbounded" nillable="true" />

</xs:sequence>

</xs:complexType>

Session

<xs:complexType name="session">

<xs:sequence />

<xs:attribute name="hash" type="xs:string" />

<xs:attribute name="company" type="xs:string" />

<xs:attribute name="userId" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="logon" type="xs:dateTime" />

<xs:attribute name="agent" type="xs:string" />

<xs:attribute name="application" type="xs:string" />

<xs:attribute name="superUser" type="xs:boolean" use="required" />

<xs:attribute name="locationId" type="xs:int" use="required" />

<xs:attribute name="locationName" type="xs:string" />

<xs:attribute name="locationAccess" type="xs:boolean" use="required" />

<xs:attribute name="className" type="xs:string" />

<xs:attribute name="logonStr" type="xs:string" />

<xs:attribute name="server" type="xs:string" />

</xs:complexType>

Product

<xs:complexType name="product">

<xs:sequence />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="status" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

</xs:complexType>

eventTrait

<xs:complexType name="eventTrait">

<xs:sequence />

<xs:attribute name="eventTraitId" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="description" type="xs:string" />

</xs:complexType>

eventTraitValue

<xs:complexType name="eventTraitValue">

<xs:sequence />

<xs:attribute name="eventTraitId" type="xs:int" use="required" />

<xs:attribute name="value" type="xs:int" use="required" />

</xs:complexType>

safetyDetails

<xs:complexType name="safetyDetails">

<xs:sequence />

<xs:attribute name="safetyNoticeId" type="xs:string" />

<xs:attribute name="fullName" type="xs:string" />

<xs:attribute name="contactId" type="xs:string" />

<xs:attribute name="noticeRecievedDate" type="xs:string" />

<xs:attribute name="noticeLocation" type="xs:string" />

<xs:attribute name="homeLocation" type="xs:string" />

<xs:attribute name="responseId" type="xs:string" />

<xs:attribute name="phoneNumbers">

<xs:simpleType>

<xs:list itemType="xs:string" />

</xs:simpleType>

</xs:attribute>

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="noticeSentDate" type="xs:string" />

<xs:attribute name="viewEmpDetails" type="xs:boolean" use="required" />

<xs:attribute name="reponseDesc" type="xs:string" />

</xs:complexType>

scheduleType

<xs:complexType name="scheduleType">

<xs:sequence />

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="on" type="xs:int" use="required" />

</xs:complexType>

Location

<xs:complexType name="location">

<xs:sequence>

<xs:element name="childLocations" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element ref="location" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="locationId" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="parentLocationId" type="xs:int" use="required" />

<xs:attribute name="rank" type="xs:int" use="required" />

<xs:attribute name="order" type="xs:int" use="required" />

<xs:attribute name="timezone" type="xs:string" />

<xs:attribute name="pagerDelay" type="xs:int" use="required" />

</xs:complexType>

locationExt

<xs:complexType name="locationExt">

<xs:sequence>

<xs:element name="xwalks" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="xwalk" type="xs:string" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="childLocations" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="location" type="locationExt" minOccurs="0" maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="locationId" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

<xs:attribute name="parentLocationId" type="xs:int" use="required" />

<xs:attribute name="rank" type="xs:int" use="required" />

<xs:attribute name="order" type="xs:int" use="required" />

<xs:attribute name="timezone" type="xs:string" />

<xs:attribute name="pagerDelay" type="xs:int" use="required" />

</xs:complexType>

Configs

<xs:complexType name="configs">

<xs:sequence>

<xs:element name="enableSafetyManagementNotification" type="xs:boolean" minOccurs="0" />

<xs:element name="mapTimeout" type="xs:int" minOccurs="0" />

<xs:element name="locationPingFreq" type="xs:int" minOccurs="0" />

<xs:element name="captureMobileData" type="xs:boolean" minOccurs="0" />

<xs:element name="captureWebData" type="xs:boolean" minOccurs="0" />

<xs:element name="onlyTrackWorking" type="xs:boolean" minOccurs="0" />

<xs:element name="available" type="xs:string" minOccurs="0" />

<xs:element name="rest" type="xs:string" minOccurs="0" />

<xs:element name="working" type="xs:string" minOccurs="0" />

<xs:element name="exception" type="xs:string" minOccurs="0" />

<xs:element name="defaultSafetyNoticeExp" type="xs:double" minOccurs="0" />

</xs:sequence>

</xs:complexType>

userDetailConfiguration

<xs:complexType name="userDetailConfiguration">

<xs:sequence>

<xs:element name="name" type="xs:string" minOccurs="0" />

<xs:element name="attributeId" type="xs:string" minOccurs="0" />

<xs:element name="id" type="xs:int" minOccurs="0" />

<xs:element name="order" type="xs:int" minOccurs="0" />

<xs:element name="employeeView" type="xs:boolean" minOccurs="0" />

<xs:element name="rosterView" type="xs:boolean" minOccurs="0" />

<xs:element name="calloutsWorking" type="xs:boolean" minOccurs="0" />

<xs:element name="calloutsAccepts" type="xs:boolean" minOccurs="0" />

<xs:element name="adminView" type="xs:boolean" minOccurs="0" />

<xs:element name="type" type="xs:string" minOccurs="0" />

</xs:sequence>

</xs:complexType>

Message

<xs:complexType name="message">

<xs:sequence>

<xs:element name="category" type="messageCategory" minOccurs="0" />

<xs:element name="audioText" type="xs:string" minOccurs="0" />

<xs:element name="fullText" type="xs:string" minOccurs="0" />

<xs:element name="condensedText" type="xs:string" minOccurs="0" />

<xs:element name="lastModified" type="xs:string" minOccurs="0" />

<xs:element name="voiceGender" type="xs:string" minOccurs="0" />

<xs:element name="voiceRate" type="xs:string" minOccurs="0" />

<xs:element name="numLocsUsing" type="xs:int" />

</xs:sequence>

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="description" type="xs:string" />

<xs:attribute name="displayOrder" type="xs:int" use="required" />

<xs:attribute name="purge" type="xs:boolean" use="required" />

<xs:attribute name="filename" type="xs:string" />

<xs:attribute name="fileLength" type="xs:long" use="required" />

<xs:attribute name="duration" type="xs:string" />

<xs:attribute name="lastUsed" type="xs:string" />

<xs:attribute name="name" type="xs:string" />

</xs:complexType>

messageCategory

<xs:complexType name="messageCategory">

<xs:sequence />

<xs:attribute name="id" type="xs:int" use="required" />

<xs:attribute name="name" type="xs:string" />

</xs:complexType>

jobStatus

<xs:complexType name="jobStatus">

<xs:sequence>

<xs:element name="responseBody" type="xs:string" minOccurs="0" />

</xs:sequence>

<xs:attribute name="uuid" type="xs:string" />

<xs:attribute name="httpStatus" type="xs:string" />

</xs:complexType>

Subscription

<xs:complexType name="subscription">

<xs:sequence />

<xs:attribute name="topic" type="xs:string" />

<xs:attribute name="mediaTypeString" type="xs:string" />

</xs:complexType>

systemEvent

<xs:complexType name="systemEvent">

<xs:sequence>

<xs:element name="url" type="xs:string" minOccurs="0" />

<xs:element name="payload" type="xs:anyType" minOccurs="0" />

</xs:sequence>

<xs:attribute name="systemId" type="xs:string" />

<xs:attribute name="topic" type="xs:string" />

<xs:attribute name="id" type="xs:string" />

<xs:attribute name="date" type="xs:string" />

<xs:attribute name="actionString" type="xs:string" />

</xs:complexType>

apiCallLogData

<xs:complexType name="apiCallLogData">

<xs:sequence />

<xs:attribute name="uuid" type="xs:string" />

<xs:attribute name="headers" type="xs:string" />

<xs:attribute name="body" type="xs:string" />

<xs:attribute name="responseHeaders" type="xs:string" />

<xs:attribute name="responseBody" type="xs:string" />

</xs:complexType>

Definitions

Term	Definition
API	Application Programming Interface.
HTTP	Hyper Text Transfer Protocol - The protocol of the World Wide Web.
Method	An HTTP request verb used to denote the type of request that is being performed. Typical HTTP Methods include GET, POST, PUT, DELETE, etc.
URL	Uniform Resource Locator - The address of a resource on the World Wide Web. URLs are used to locate a particular resource or group of resources in REST based web services.
HTTP Status	The numeric value for the HTTP Response that indicates whether or not a Request was successful. 200 = OK, 401 = Unauthorized, etc.
REST	Representational State Transfer - A web service approach that relies on standard HTTP methods and URLs to locate and act on resources.
Header	A Key/Value pair in an HTTP Request or Response.
Access Key	A unique key that can be used to obtain an Access Token.
Access Token	A token that must be sent in the Authorization Header of all HTTP Requests when accessing the API.
Attribute	A named property of some resource.
Assignment	A timed grouping between 2 or more entities.
Crew	A Crew in the ARCOS Crew Manager Application. Crews have any number of Attributes, can have Member Assignments, and can have Resource Assignments.
Employee	An employee in the ARCOS system.
Shift	A template that defines a collection of start and end times for a weekly work schedule for an Employee.
Shift Signature	A generated short-hand notation used to represent the working schedule that a Shift covers. For example, if a Shift is defined to include all weekdays from 8:00 am to 5:00 pm, the signature could be MTWRF8-17.
Shift Assignment	The mapping of an Employee to a Shift for a specific week.
Event Type	Used to indicate additional information about the type of Schedule Record that exists for an Employee. Event Types may have any number of Event Traits associated with them.
Event Trait	A property of an Event Type that defines how the Type should be considered for things like auto-extending records, callout, holdover, etc.
Schedule Record	A record indicating the start and end time for an Employee for a specific Event Type.
Scheduled Shift	A Schedule Record that with an Event Type of 1008 - Normal Working Shift. This is the record type typically used to indicate day-to-day scheduled work for an Employee. This type of record is automatically created whenever an Employee is given a Shift Assignment.
Schedule Exception	A Schedule Record that represents some Event Type other than Normal Working Shift. Examples include Planned Overtime, Rest, Sick, Vacation, Callout, etc.
Holiday	A Holiday is a named date that can be used to mask Scheduled Shifts for Employees working in a Location.
XSD	XSD (XML Schema Definition) is a World Wide Web Consortium (W3C) recommendation that specifies how to formally describe the elements in an Extensible Markup Language (XML) document.

Term	Definition
xsd:dateString	A string in the format YYYY-DD-MM used to represent dates, where YYYY indicates the year, MM indicates the month (01-12), and DD (01-31) indicates the day.
xsd:dateTime	A string in the format YYYY-MM-DDThh:mm:ss[Z\|(+\|-)hh:mm] used to represent a date and time [with optional timezone portion]. The date is handled just like xsd:dateString. The time portion includes hh to indicate hours (00-23), mm to indicate minutes (00-59), and ss to indicate seconds (00-59). Specifying Z for the timezone will use the UTC timezone, otherwise the offset in hours (+ or -) should be used.

Articles in this section

ARCOS API Documentation - Appendix Continued, Definitions

Contents

Employee Data Structures

Schedule Data Structures

Crew Manager Data Structures

Checkpoint Data Structures

Resource Assist Data Structures

Incident Manager Data Structures

Metadata Structures

Miscellaneous Data Structures

Definitions

Comments