Jump to

• Request
• Response

Synchronize Employee

post

https://server:port/rest/apis/asset/resources/employeeSynchronization/

This REST web service synchronizes Enterprise Resource Planning - Human Capital Management Employee records with Work and Asset Management.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• input: object input
• output: object output

{
    "type":"object",
    "properties":{
        "input":{
            "type":"object",
            "properties":{
                "externalSystem":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Defaulted (value) by the HCM Integration.",
                    "example":"HCM"
                },
                "externalReferenceId":{
                    "type":"string",
                    "maxLength":36,
                    "description":"Variable based on the originating system"
                },
                "initialLoad":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Defaulted (value) by the HCM Integration."
                },
                "employeeInfo":{
                    "type":"object",
                    "properties":{
                        "externalId":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "hrEmployeeNumber":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "employeeType":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Employee Type",
                            "example":"Regular"
                        },
                        "businessUnit":{
                            "type":"string",
                            "maxLength":30,
                            "description":"The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.",
                            "example":"US1"
                        },
                        "status":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Employee's Current Status.",
                            "example":"ACTIVE or INACTIVE"
                        },
                        "creationUser":{
                            "type":"string",
                            "maxLength":8,
                            "description":"The system username for the employee. Employees do not necessarily have to be defined as users within the system."
                        },
                        "supervisor":{
                            "type":"string",
                            "maxLength":12,
                            "description":"The username of the employee's supervisor"
                        },
                        "principalCraft":{
                            "type":"string",
                            "maxLength":12,
                            "description":"The main craft that the employee is qualified to work."
                        },
                        "principalCraftExternalId":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "hiredDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Employee's Hired Date."
                        },
                        "jobTitle":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "jobCode":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "firstName":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Employee's First Name."
                        },
                        "lastName":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Employee's Last Name."
                        },
                        "emailAddress":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Employee's Email address."
                        },
                        "terminatedDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Employee's Termination Date."
                        },
                        "addressInformation":{
                            "type":"object",
                            "properties":{
                                "address1":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The first line for the address, associated with the Purchase Order."
                                },
                                "address2":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The second line for the address, associated with the Purchase Order."
                                },
                                "address3":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The third line for the address, associated with the Purchase Order."
                                },
                                "address4":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The fourth line for the address, associated with the Purchase Order."
                                },
                                "crossStreet":{
                                    "type":"string",
                                    "maxLength":64,
                                    "description":"The Cross Street the PO address."
                                },
                                "houseType":{
                                    "type":"string",
                                    "enum":[
                                    ],
                                    "description":"The House Type for the PO address.\n"
                                },
                                "number1":{
                                    "type":"string",
                                    "maxLength":6,
                                    "description":"Street number 1"
                                },
                                "number2":{
                                    "type":"string",
                                    "maxLength":4,
                                    "description":"Street number 2"
                                },
                                "geographicCode":{
                                    "type":"string",
                                    "maxLength":11,
                                    "description":"The Geographic Code for the PO address."
                                },
                                "inCityLimit":{
                                    "type":"boolean",
                                    "description":"In City Limit"
                                },
                                "city":{
                                    "type":"string",
                                    "maxLength":90,
                                    "description":"The City for the PO address."
                                },
                                "suburb":{
                                    "type":"string",
                                    "maxLength":64,
                                    "description":"The Suburb for the PO address."
                                },
                                "county":{
                                    "type":"string",
                                    "maxLength":90,
                                    "description":"The County for the PO address.",
                                    "example":"US"
                                },
                                "state":{
                                    "type":"string",
                                    "maxLength":6,
                                    "description":"State",
                                    "example":"CA"
                                },
                                "postal":{
                                    "type":"string",
                                    "maxLength":12,
                                    "description":"The Postal Code for the PO address."
                                },
                                "country":{
                                    "type":"string",
                                    "maxLength":3,
                                    "description":"Country"
                                }
                            }
                        },
                        "phoneNumbers":{
                            "type":"object",
                            "properties":{
                                "phoneNumbersList":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "phoneType":{
                                                "type":"string",
                                                "enum":[
                                                    "FAX ",
                                                    "SMS ",
                                                    "W1BS",
                                                    "W1HM",
                                                    "W1MB",
                                                    "W1PR"
                                                ],
                                                "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
                                            },
                                            "countryCode":{
                                                "type":"string",
                                                "maxLength":3,
                                                "description":"Country"
                                            },
                                            "areaCode":{
                                                "type":"string",
                                                "maxLength":24,
                                                "description":"Phone"
                                            },
                                            "phoneNumber":{
                                                "type":"string",
                                                "maxLength":24,
                                                "description":"Phone"
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "employeeTrainingInformation":{
                            "type":"object",
                            "properties":{
                                "employeeTrainingInformationList":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "course":{
                                                "type":"string",
                                                "maxLength":254,
                                                "description":"Training course number"
                                            },
                                            "effectiveDate":{
                                                "type":"string",
                                                "format":"date",
                                                "description":"Effective Date"
                                            },
                                            "expirationDate":{
                                                "type":"string",
                                                "format":"date",
                                                "description":"Expiration Date"
                                            },
                                            "employeeNotified":{
                                                "type":"boolean",
                                                "description":"Employee Notified"
                                            },
                                            "supervisorNotified":{
                                                "type":"boolean",
                                                "description":"Supervisor Notified"
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "billableRates":{
                            "type":"object",
                            "properties":{
                                "billableRatesList":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "effectiveDate":{
                                                "type":"string",
                                                "format":"date",
                                                "description":"Billable rates effective date"
                                            },
                                            "billableRate":{
                                                "type":"number",
                                                "description":"Billable rate"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "output":{
            "type":"object",
            "properties":{
                "syncRequestId":{
                    "type":"string",
                    "description":"(syncRequestId)"
                }
            }
        }
    }
}

Nested Schema : input

Type: object

Show Source

• employeeInfo: object employeeInfo
• externalReferenceId: string
  Maximum Length: 36

  Variable based on the originating system
• externalSystem: string
  Maximum Length: 30

  Defaulted (value) by the HCM Integration.

  Example: HCM
• initialLoad: string
  Maximum Length: 4

  Defaulted (value) by the HCM Integration.

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"Defaulted (value) by the HCM Integration.",
            "example":"HCM"
        },
        "externalReferenceId":{
            "type":"string",
            "maxLength":36,
            "description":"Variable based on the originating system"
        },
        "initialLoad":{
            "type":"string",
            "maxLength":4,
            "description":"Defaulted (value) by the HCM Integration."
        },
        "employeeInfo":{
            "type":"object",
            "properties":{
                "externalId":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "hrEmployeeNumber":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "employeeType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Employee Type",
                    "example":"Regular"
                },
                "businessUnit":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.",
                    "example":"US1"
                },
                "status":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Employee's Current Status.",
                    "example":"ACTIVE or INACTIVE"
                },
                "creationUser":{
                    "type":"string",
                    "maxLength":8,
                    "description":"The system username for the employee. Employees do not necessarily have to be defined as users within the system."
                },
                "supervisor":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The username of the employee's supervisor"
                },
                "principalCraft":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The main craft that the employee is qualified to work."
                },
                "principalCraftExternalId":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "hiredDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Employee's Hired Date."
                },
                "jobTitle":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "jobCode":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "firstName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Employee's First Name."
                },
                "lastName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Employee's Last Name."
                },
                "emailAddress":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Employee's Email address."
                },
                "terminatedDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Employee's Termination Date."
                },
                "addressInformation":{
                    "type":"object",
                    "properties":{
                        "address1":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The first line for the address, associated with the Purchase Order."
                        },
                        "address2":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The second line for the address, associated with the Purchase Order."
                        },
                        "address3":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The third line for the address, associated with the Purchase Order."
                        },
                        "address4":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The fourth line for the address, associated with the Purchase Order."
                        },
                        "crossStreet":{
                            "type":"string",
                            "maxLength":64,
                            "description":"The Cross Street the PO address."
                        },
                        "houseType":{
                            "type":"string",
                            "enum":[
                            ],
                            "description":"The House Type for the PO address.\n"
                        },
                        "number1":{
                            "type":"string",
                            "maxLength":6,
                            "description":"Street number 1"
                        },
                        "number2":{
                            "type":"string",
                            "maxLength":4,
                            "description":"Street number 2"
                        },
                        "geographicCode":{
                            "type":"string",
                            "maxLength":11,
                            "description":"The Geographic Code for the PO address."
                        },
                        "inCityLimit":{
                            "type":"boolean",
                            "description":"In City Limit"
                        },
                        "city":{
                            "type":"string",
                            "maxLength":90,
                            "description":"The City for the PO address."
                        },
                        "suburb":{
                            "type":"string",
                            "maxLength":64,
                            "description":"The Suburb for the PO address."
                        },
                        "county":{
                            "type":"string",
                            "maxLength":90,
                            "description":"The County for the PO address.",
                            "example":"US"
                        },
                        "state":{
                            "type":"string",
                            "maxLength":6,
                            "description":"State",
                            "example":"CA"
                        },
                        "postal":{
                            "type":"string",
                            "maxLength":12,
                            "description":"The Postal Code for the PO address."
                        },
                        "country":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Country"
                        }
                    }
                },
                "phoneNumbers":{
                    "type":"object",
                    "properties":{
                        "phoneNumbersList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "phoneType":{
                                        "type":"string",
                                        "enum":[
                                            "FAX ",
                                            "SMS ",
                                            "W1BS",
                                            "W1HM",
                                            "W1MB",
                                            "W1PR"
                                        ],
                                        "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
                                    },
                                    "countryCode":{
                                        "type":"string",
                                        "maxLength":3,
                                        "description":"Country"
                                    },
                                    "areaCode":{
                                        "type":"string",
                                        "maxLength":24,
                                        "description":"Phone"
                                    },
                                    "phoneNumber":{
                                        "type":"string",
                                        "maxLength":24,
                                        "description":"Phone"
                                    }
                                }
                            }
                        }
                    }
                },
                "employeeTrainingInformation":{
                    "type":"object",
                    "properties":{
                        "employeeTrainingInformationList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "course":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Training course number"
                                    },
                                    "effectiveDate":{
                                        "type":"string",
                                        "format":"date",
                                        "description":"Effective Date"
                                    },
                                    "expirationDate":{
                                        "type":"string",
                                        "format":"date",
                                        "description":"Expiration Date"
                                    },
                                    "employeeNotified":{
                                        "type":"boolean",
                                        "description":"Employee Notified"
                                    },
                                    "supervisorNotified":{
                                        "type":"boolean",
                                        "description":"Supervisor Notified"
                                    }
                                }
                            }
                        }
                    }
                },
                "billableRates":{
                    "type":"object",
                    "properties":{
                        "billableRatesList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "effectiveDate":{
                                        "type":"string",
                                        "format":"date",
                                        "description":"Billable rates effective date"
                                    },
                                    "billableRate":{
                                        "type":"number",
                                        "description":"Billable rate"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : output

Type: object

Show Source

• syncRequestId: string
  (syncRequestId)

{
    "type":"object",
    "properties":{
        "syncRequestId":{
            "type":"string",
            "description":"(syncRequestId)"
        }
    }
}

Nested Schema : employeeInfo

Type: object

Show Source

• addressInformation: object addressInformation
• billableRates: object billableRates
• businessUnit: string
  Maximum Length: 30

  The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.

  Example: US1
• creationUser: string
  Maximum Length: 8

  The system username for the employee. Employees do not necessarily have to be defined as users within the system.
• emailAddress: string
  Maximum Length: 254

  Employee's Email address.
• employeeTrainingInformation: object employeeTrainingInformation
• employeeType: string
  Maximum Length: 30

  Employee Type

  Example: Regular
• externalId: string
  Maximum Length: 60

  Identifier Value
• firstName: string
  Maximum Length: 254

  Employee's First Name.
• hiredDate: string (date)
  Employee's Hired Date.
• hrEmployeeNumber: string
  Maximum Length: 60

  Identifier Value
• jobCode: string
  Maximum Length: 60

  Identifier Value
• jobTitle: string
  Maximum Length: 60

  Identifier Value
• lastName: string
  Maximum Length: 254

  Employee's Last Name.
• phoneNumbers: object phoneNumbers
• principalCraft: string
  Maximum Length: 12

  The main craft that the employee is qualified to work.
• principalCraftExternalId: string
  Maximum Length: 60

  Identifier Value
• status: string
  Maximum Length: 12

  Employee's Current Status.

  Example: ACTIVE or INACTIVE
• supervisor: string
  Maximum Length: 12

  The username of the employee's supervisor
• terminatedDate: string (date)
  Employee's Termination Date.

{
    "type":"object",
    "properties":{
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "hrEmployeeNumber":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "employeeType":{
            "type":"string",
            "maxLength":30,
            "description":"Employee Type",
            "example":"Regular"
        },
        "businessUnit":{
            "type":"string",
            "maxLength":30,
            "description":"The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.",
            "example":"US1"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Employee's Current Status.",
            "example":"ACTIVE or INACTIVE"
        },
        "creationUser":{
            "type":"string",
            "maxLength":8,
            "description":"The system username for the employee. Employees do not necessarily have to be defined as users within the system."
        },
        "supervisor":{
            "type":"string",
            "maxLength":12,
            "description":"The username of the employee's supervisor"
        },
        "principalCraft":{
            "type":"string",
            "maxLength":12,
            "description":"The main craft that the employee is qualified to work."
        },
        "principalCraftExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "hiredDate":{
            "type":"string",
            "format":"date",
            "description":"Employee's Hired Date."
        },
        "jobTitle":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "jobCode":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "firstName":{
            "type":"string",
            "maxLength":254,
            "description":"Employee's First Name."
        },
        "lastName":{
            "type":"string",
            "maxLength":254,
            "description":"Employee's Last Name."
        },
        "emailAddress":{
            "type":"string",
            "maxLength":254,
            "description":"Employee's Email address."
        },
        "terminatedDate":{
            "type":"string",
            "format":"date",
            "description":"Employee's Termination Date."
        },
        "addressInformation":{
            "type":"object",
            "properties":{
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The first line for the address, associated with the Purchase Order."
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The second line for the address, associated with the Purchase Order."
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The third line for the address, associated with the Purchase Order."
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The fourth line for the address, associated with the Purchase Order."
                },
                "crossStreet":{
                    "type":"string",
                    "maxLength":64,
                    "description":"The Cross Street the PO address."
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                    ],
                    "description":"The House Type for the PO address.\n"
                },
                "number1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"Street number 1"
                },
                "number2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Street number 2"
                },
                "geographicCode":{
                    "type":"string",
                    "maxLength":11,
                    "description":"The Geographic Code for the PO address."
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit"
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The City for the PO address."
                },
                "suburb":{
                    "type":"string",
                    "maxLength":64,
                    "description":"The Suburb for the PO address."
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The County for the PO address.",
                    "example":"US"
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"State",
                    "example":"CA"
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The Postal Code for the PO address."
                },
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Country"
                }
            }
        },
        "phoneNumbers":{
            "type":"object",
            "properties":{
                "phoneNumbersList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "phoneType":{
                                "type":"string",
                                "enum":[
                                    "FAX ",
                                    "SMS ",
                                    "W1BS",
                                    "W1HM",
                                    "W1MB",
                                    "W1PR"
                                ],
                                "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
                            },
                            "countryCode":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Country"
                            },
                            "areaCode":{
                                "type":"string",
                                "maxLength":24,
                                "description":"Phone"
                            },
                            "phoneNumber":{
                                "type":"string",
                                "maxLength":24,
                                "description":"Phone"
                            }
                        }
                    }
                }
            }
        },
        "employeeTrainingInformation":{
            "type":"object",
            "properties":{
                "employeeTrainingInformationList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "course":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Training course number"
                            },
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "expirationDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Expiration Date"
                            },
                            "employeeNotified":{
                                "type":"boolean",
                                "description":"Employee Notified"
                            },
                            "supervisorNotified":{
                                "type":"boolean",
                                "description":"Supervisor Notified"
                            }
                        }
                    }
                }
            }
        },
        "billableRates":{
            "type":"object",
            "properties":{
                "billableRatesList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Billable rates effective date"
                            },
                            "billableRate":{
                                "type":"number",
                                "description":"Billable rate"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : addressInformation

Type: object

Show Source

• address1: string
  Maximum Length: 254

  The first line for the address, associated with the Purchase Order.
• address2: string
  Maximum Length: 254

  The second line for the address, associated with the Purchase Order.
• address3: string
  Maximum Length: 254

  The third line for the address, associated with the Purchase Order.
• address4: string
  Maximum Length: 254

  The fourth line for the address, associated with the Purchase Order.
• city: string
  Maximum Length: 90

  The City for the PO address.
• country: string
  Maximum Length: 3

  Country
• county: string
  Maximum Length: 90

  The County for the PO address.

  Example: US
• crossStreet: string
  Maximum Length: 64

  The Cross Street the PO address.
• geographicCode: string
  Maximum Length: 11

  The Geographic Code for the PO address.
• houseType: string
  The House Type for the PO address.
• inCityLimit: boolean
  In City Limit
• number1: string
  Maximum Length: 6

  Street number 1
• number2: string
  Maximum Length: 4

  Street number 2
• postal: string
  Maximum Length: 12

  The Postal Code for the PO address.
• state: string
  Maximum Length: 6

  State

  Example: CA
• suburb: string
  Maximum Length: 64

  The Suburb for the PO address.

{
    "type":"object",
    "properties":{
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"The first line for the address, associated with the Purchase Order."
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"The second line for the address, associated with the Purchase Order."
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"The third line for the address, associated with the Purchase Order."
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"The fourth line for the address, associated with the Purchase Order."
        },
        "crossStreet":{
            "type":"string",
            "maxLength":64,
            "description":"The Cross Street the PO address."
        },
        "houseType":{
            "type":"string",
            "enum":[
            ],
            "description":"The House Type for the PO address.\n"
        },
        "number1":{
            "type":"string",
            "maxLength":6,
            "description":"Street number 1"
        },
        "number2":{
            "type":"string",
            "maxLength":4,
            "description":"Street number 2"
        },
        "geographicCode":{
            "type":"string",
            "maxLength":11,
            "description":"The Geographic Code for the PO address."
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"The City for the PO address."
        },
        "suburb":{
            "type":"string",
            "maxLength":64,
            "description":"The Suburb for the PO address."
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"The County for the PO address.",
            "example":"US"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"State",
            "example":"CA"
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The Postal Code for the PO address."
        },
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"Country"
        }
    }
}

Nested Schema : billableRates

Type: object

Show Source

• billableRatesList: array billableRatesList

{
    "type":"object",
    "properties":{
        "billableRatesList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Billable rates effective date"
                    },
                    "billableRate":{
                        "type":"number",
                        "description":"Billable rate"
                    }
                }
            }
        }
    }
}

Nested Schema : employeeTrainingInformation

Type: object

Show Source

• employeeTrainingInformationList: array employeeTrainingInformationList

{
    "type":"object",
    "properties":{
        "employeeTrainingInformationList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "course":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Training course number"
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "expirationDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Expiration Date"
                    },
                    "employeeNotified":{
                        "type":"boolean",
                        "description":"Employee Notified"
                    },
                    "supervisorNotified":{
                        "type":"boolean",
                        "description":"Supervisor Notified"
                    }
                }
            }
        }
    }
}

Nested Schema : phoneNumbers

Type: object

Show Source

• phoneNumbersList: array phoneNumbersList

{
    "type":"object",
    "properties":{
        "phoneNumbersList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "phoneType":{
                        "type":"string",
                        "enum":[
                            "FAX ",
                            "SMS ",
                            "W1BS",
                            "W1HM",
                            "W1MB",
                            "W1PR"
                        ],
                        "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
                    },
                    "countryCode":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Country"
                    },
                    "areaCode":{
                        "type":"string",
                        "maxLength":24,
                        "description":"Phone"
                    },
                    "phoneNumber":{
                        "type":"string",
                        "maxLength":24,
                        "description":"Phone"
                    }
                }
            }
        }
    }
}

Nested Schema : billableRatesList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Billable rates effective date"
            },
            "billableRate":{
                "type":"number",
                "description":"Billable rate"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billableRate: number
  Billable rate
• effectiveDate: string (date)
  Billable rates effective date

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Billable rates effective date"
        },
        "billableRate":{
            "type":"number",
            "description":"Billable rate"
        }
    }
}

Nested Schema : employeeTrainingInformationList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "course":{
                "type":"string",
                "maxLength":254,
                "description":"Training course number"
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "expirationDate":{
                "type":"string",
                "format":"date",
                "description":"Expiration Date"
            },
            "employeeNotified":{
                "type":"boolean",
                "description":"Employee Notified"
            },
            "supervisorNotified":{
                "type":"boolean",
                "description":"Supervisor Notified"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• course: string
  Maximum Length: 254

  Training course number
• effectiveDate: string (date)
  Effective Date
• employeeNotified: boolean
  Employee Notified
• expirationDate: string (date)
  Expiration Date
• supervisorNotified: boolean
  Supervisor Notified

{
    "type":"object",
    "properties":{
        "course":{
            "type":"string",
            "maxLength":254,
            "description":"Training course number"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "expirationDate":{
            "type":"string",
            "format":"date",
            "description":"Expiration Date"
        },
        "employeeNotified":{
            "type":"boolean",
            "description":"Employee Notified"
        },
        "supervisorNotified":{
            "type":"boolean",
            "description":"Supervisor Notified"
        }
    }
}

Nested Schema : phoneNumbersList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "phoneType":{
                "type":"string",
                "enum":[
                    "FAX ",
                    "SMS ",
                    "W1BS",
                    "W1HM",
                    "W1MB",
                    "W1PR"
                ],
                "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
            },
            "countryCode":{
                "type":"string",
                "maxLength":3,
                "description":"Country"
            },
            "areaCode":{
                "type":"string",
                "maxLength":24,
                "description":"Phone"
            },
            "phoneNumber":{
                "type":"string",
                "maxLength":24,
                "description":"Phone"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• areaCode: string
  Maximum Length: 24

  Phone
• countryCode: string
  Maximum Length: 3

  Country
• phoneNumber: string
  Maximum Length: 24

  Phone
• phoneType: string
  Allowed Values: [ "FAX ", "SMS ", "W1BS", "W1HM", "W1MB", "W1PR" ]

  Phone number type * `FAX ` - Fax, * `SMS ` - Short Message Service, * `W1BS` - Business, * `W1HM` - Home, * `W1MB` - Mobile, * `W1PR` - Primary

{
    "type":"object",
    "properties":{
        "phoneType":{
            "type":"string",
            "enum":[
                "FAX ",
                "SMS ",
                "W1BS",
                "W1HM",
                "W1MB",
                "W1PR"
            ],
            "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
        },
        "countryCode":{
            "type":"string",
            "maxLength":3,
            "description":"Country"
        },
        "areaCode":{
            "type":"string",
            "maxLength":24,
            "description":"Phone"
        },
        "phoneNumber":{
            "type":"string",
            "maxLength":24,
            "description":"Phone"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• W1CreEmpSync: object schema

{
    "type":"object",
    "properties":{
        "W1CreEmpSync":{
            "type":"object",
            "properties":{
                "input":{
                    "type":"object",
                    "properties":{
                        "externalSystem":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Defaulted (value) by the HCM Integration.",
                            "example":"HCM"
                        },
                        "externalReferenceId":{
                            "type":"string",
                            "maxLength":36,
                            "description":"Variable based on the originating system"
                        },
                        "initialLoad":{
                            "type":"string",
                            "maxLength":4,
                            "description":"Defaulted (value) by the HCM Integration."
                        },
                        "employeeInfo":{
                            "type":"object",
                            "properties":{
                                "externalId":{
                                    "type":"string",
                                    "maxLength":60,
                                    "description":"Identifier Value"
                                },
                                "hrEmployeeNumber":{
                                    "type":"string",
                                    "maxLength":60,
                                    "description":"Identifier Value"
                                },
                                "employeeType":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Employee Type",
                                    "example":"Regular"
                                },
                                "businessUnit":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.",
                                    "example":"US1"
                                },
                                "status":{
                                    "type":"string",
                                    "maxLength":12,
                                    "description":"Employee's Current Status.",
                                    "example":"ACTIVE or INACTIVE"
                                },
                                "creationUser":{
                                    "type":"string",
                                    "maxLength":8,
                                    "description":"The system username for the employee. Employees do not necessarily have to be defined as users within the system."
                                },
                                "supervisor":{
                                    "type":"string",
                                    "maxLength":12,
                                    "description":"The username of the employee's supervisor"
                                },
                                "principalCraft":{
                                    "type":"string",
                                    "maxLength":12,
                                    "description":"The main craft that the employee is qualified to work."
                                },
                                "principalCraftExternalId":{
                                    "type":"string",
                                    "maxLength":60,
                                    "description":"Identifier Value"
                                },
                                "hiredDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"Employee's Hired Date."
                                },
                                "jobTitle":{
                                    "type":"string",
                                    "maxLength":60,
                                    "description":"Identifier Value"
                                },
                                "jobCode":{
                                    "type":"string",
                                    "maxLength":60,
                                    "description":"Identifier Value"
                                },
                                "firstName":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Employee's First Name."
                                },
                                "lastName":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Employee's Last Name."
                                },
                                "emailAddress":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Employee's Email address."
                                },
                                "terminatedDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"Employee's Termination Date."
                                },
                                "addressInformation":{
                                    "type":"object",
                                    "properties":{
                                        "address1":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"The first line for the address, associated with the Purchase Order."
                                        },
                                        "address2":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"The second line for the address, associated with the Purchase Order."
                                        },
                                        "address3":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"The third line for the address, associated with the Purchase Order."
                                        },
                                        "address4":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"The fourth line for the address, associated with the Purchase Order."
                                        },
                                        "crossStreet":{
                                            "type":"string",
                                            "maxLength":64,
                                            "description":"The Cross Street the PO address."
                                        },
                                        "houseType":{
                                            "type":"string",
                                            "enum":[
                                            ],
                                            "description":"The House Type for the PO address.\n"
                                        },
                                        "number1":{
                                            "type":"string",
                                            "maxLength":6,
                                            "description":"Street number 1"
                                        },
                                        "number2":{
                                            "type":"string",
                                            "maxLength":4,
                                            "description":"Street number 2"
                                        },
                                        "geographicCode":{
                                            "type":"string",
                                            "maxLength":11,
                                            "description":"The Geographic Code for the PO address."
                                        },
                                        "inCityLimit":{
                                            "type":"boolean",
                                            "description":"In City Limit"
                                        },
                                        "city":{
                                            "type":"string",
                                            "maxLength":90,
                                            "description":"The City for the PO address."
                                        },
                                        "suburb":{
                                            "type":"string",
                                            "maxLength":64,
                                            "description":"The Suburb for the PO address."
                                        },
                                        "county":{
                                            "type":"string",
                                            "maxLength":90,
                                            "description":"The County for the PO address.",
                                            "example":"US"
                                        },
                                        "state":{
                                            "type":"string",
                                            "maxLength":6,
                                            "description":"State",
                                            "example":"CA"
                                        },
                                        "postal":{
                                            "type":"string",
                                            "maxLength":12,
                                            "description":"The Postal Code for the PO address."
                                        },
                                        "country":{
                                            "type":"string",
                                            "maxLength":3,
                                            "description":"Country"
                                        }
                                    }
                                },
                                "phoneNumbers":{
                                    "type":"object",
                                    "properties":{
                                        "phoneNumbersList":{
                                            "type":"array",
                                            "items":{
                                                "type":"object",
                                                "properties":{
                                                    "phoneType":{
                                                        "type":"string",
                                                        "enum":[
                                                            "FAX ",
                                                            "SMS ",
                                                            "W1BS",
                                                            "W1HM",
                                                            "W1MB",
                                                            "W1PR"
                                                        ],
                                                        "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
                                                    },
                                                    "countryCode":{
                                                        "type":"string",
                                                        "maxLength":3,
                                                        "description":"Country"
                                                    },
                                                    "areaCode":{
                                                        "type":"string",
                                                        "maxLength":24,
                                                        "description":"Phone"
                                                    },
                                                    "phoneNumber":{
                                                        "type":"string",
                                                        "maxLength":24,
                                                        "description":"Phone"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "employeeTrainingInformation":{
                                    "type":"object",
                                    "properties":{
                                        "employeeTrainingInformationList":{
                                            "type":"array",
                                            "items":{
                                                "type":"object",
                                                "properties":{
                                                    "course":{
                                                        "type":"string",
                                                        "maxLength":254,
                                                        "description":"Training course number"
                                                    },
                                                    "effectiveDate":{
                                                        "type":"string",
                                                        "format":"date",
                                                        "description":"Effective Date"
                                                    },
                                                    "expirationDate":{
                                                        "type":"string",
                                                        "format":"date",
                                                        "description":"Expiration Date"
                                                    },
                                                    "employeeNotified":{
                                                        "type":"boolean",
                                                        "description":"Employee Notified"
                                                    },
                                                    "supervisorNotified":{
                                                        "type":"boolean",
                                                        "description":"Supervisor Notified"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "billableRates":{
                                    "type":"object",
                                    "properties":{
                                        "billableRatesList":{
                                            "type":"array",
                                            "items":{
                                                "type":"object",
                                                "properties":{
                                                    "effectiveDate":{
                                                        "type":"string",
                                                        "format":"date",
                                                        "description":"Billable rates effective date"
                                                    },
                                                    "billableRate":{
                                                        "type":"number",
                                                        "description":"Billable rate"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "output":{
                    "type":"object",
                    "properties":{
                        "syncRequestId":{
                            "type":"string",
                            "description":"(syncRequestId)"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• input: object input
• output: object output

{
    "type":"object",
    "properties":{
        "input":{
            "type":"object",
            "properties":{
                "externalSystem":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Defaulted (value) by the HCM Integration.",
                    "example":"HCM"
                },
                "externalReferenceId":{
                    "type":"string",
                    "maxLength":36,
                    "description":"Variable based on the originating system"
                },
                "initialLoad":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Defaulted (value) by the HCM Integration."
                },
                "employeeInfo":{
                    "type":"object",
                    "properties":{
                        "externalId":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "hrEmployeeNumber":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "employeeType":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Employee Type",
                            "example":"Regular"
                        },
                        "businessUnit":{
                            "type":"string",
                            "maxLength":30,
                            "description":"The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.",
                            "example":"US1"
                        },
                        "status":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Employee's Current Status.",
                            "example":"ACTIVE or INACTIVE"
                        },
                        "creationUser":{
                            "type":"string",
                            "maxLength":8,
                            "description":"The system username for the employee. Employees do not necessarily have to be defined as users within the system."
                        },
                        "supervisor":{
                            "type":"string",
                            "maxLength":12,
                            "description":"The username of the employee's supervisor"
                        },
                        "principalCraft":{
                            "type":"string",
                            "maxLength":12,
                            "description":"The main craft that the employee is qualified to work."
                        },
                        "principalCraftExternalId":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "hiredDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Employee's Hired Date."
                        },
                        "jobTitle":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "jobCode":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "firstName":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Employee's First Name."
                        },
                        "lastName":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Employee's Last Name."
                        },
                        "emailAddress":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Employee's Email address."
                        },
                        "terminatedDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Employee's Termination Date."
                        },
                        "addressInformation":{
                            "type":"object",
                            "properties":{
                                "address1":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The first line for the address, associated with the Purchase Order."
                                },
                                "address2":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The second line for the address, associated with the Purchase Order."
                                },
                                "address3":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The third line for the address, associated with the Purchase Order."
                                },
                                "address4":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The fourth line for the address, associated with the Purchase Order."
                                },
                                "crossStreet":{
                                    "type":"string",
                                    "maxLength":64,
                                    "description":"The Cross Street the PO address."
                                },
                                "houseType":{
                                    "type":"string",
                                    "enum":[
                                    ],
                                    "description":"The House Type for the PO address.\n"
                                },
                                "number1":{
                                    "type":"string",
                                    "maxLength":6,
                                    "description":"Street number 1"
                                },
                                "number2":{
                                    "type":"string",
                                    "maxLength":4,
                                    "description":"Street number 2"
                                },
                                "geographicCode":{
                                    "type":"string",
                                    "maxLength":11,
                                    "description":"The Geographic Code for the PO address."
                                },
                                "inCityLimit":{
                                    "type":"boolean",
                                    "description":"In City Limit"
                                },
                                "city":{
                                    "type":"string",
                                    "maxLength":90,
                                    "description":"The City for the PO address."
                                },
                                "suburb":{
                                    "type":"string",
                                    "maxLength":64,
                                    "description":"The Suburb for the PO address."
                                },
                                "county":{
                                    "type":"string",
                                    "maxLength":90,
                                    "description":"The County for the PO address.",
                                    "example":"US"
                                },
                                "state":{
                                    "type":"string",
                                    "maxLength":6,
                                    "description":"State",
                                    "example":"CA"
                                },
                                "postal":{
                                    "type":"string",
                                    "maxLength":12,
                                    "description":"The Postal Code for the PO address."
                                },
                                "country":{
                                    "type":"string",
                                    "maxLength":3,
                                    "description":"Country"
                                }
                            }
                        },
                        "phoneNumbers":{
                            "type":"object",
                            "properties":{
                                "phoneNumbersList":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "phoneType":{
                                                "type":"string",
                                                "enum":[
                                                    "FAX ",
                                                    "SMS ",
                                                    "W1BS",
                                                    "W1HM",
                                                    "W1MB",
                                                    "W1PR"
                                                ],
                                                "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
                                            },
                                            "countryCode":{
                                                "type":"string",
                                                "maxLength":3,
                                                "description":"Country"
                                            },
                                            "areaCode":{
                                                "type":"string",
                                                "maxLength":24,
                                                "description":"Phone"
                                            },
                                            "phoneNumber":{
                                                "type":"string",
                                                "maxLength":24,
                                                "description":"Phone"
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "employeeTrainingInformation":{
                            "type":"object",
                            "properties":{
                                "employeeTrainingInformationList":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "course":{
                                                "type":"string",
                                                "maxLength":254,
                                                "description":"Training course number"
                                            },
                                            "effectiveDate":{
                                                "type":"string",
                                                "format":"date",
                                                "description":"Effective Date"
                                            },
                                            "expirationDate":{
                                                "type":"string",
                                                "format":"date",
                                                "description":"Expiration Date"
                                            },
                                            "employeeNotified":{
                                                "type":"boolean",
                                                "description":"Employee Notified"
                                            },
                                            "supervisorNotified":{
                                                "type":"boolean",
                                                "description":"Supervisor Notified"
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "billableRates":{
                            "type":"object",
                            "properties":{
                                "billableRatesList":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "effectiveDate":{
                                                "type":"string",
                                                "format":"date",
                                                "description":"Billable rates effective date"
                                            },
                                            "billableRate":{
                                                "type":"number",
                                                "description":"Billable rate"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "output":{
            "type":"object",
            "properties":{
                "syncRequestId":{
                    "type":"string",
                    "description":"(syncRequestId)"
                }
            }
        }
    }
}

Nested Schema : input

Type: object

Show Source

• employeeInfo: object employeeInfo
• externalReferenceId: string
  Maximum Length: 36

  Variable based on the originating system
• externalSystem: string
  Maximum Length: 30

  Defaulted (value) by the HCM Integration.

  Example: HCM
• initialLoad: string
  Maximum Length: 4

  Defaulted (value) by the HCM Integration.

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"Defaulted (value) by the HCM Integration.",
            "example":"HCM"
        },
        "externalReferenceId":{
            "type":"string",
            "maxLength":36,
            "description":"Variable based on the originating system"
        },
        "initialLoad":{
            "type":"string",
            "maxLength":4,
            "description":"Defaulted (value) by the HCM Integration."
        },
        "employeeInfo":{
            "type":"object",
            "properties":{
                "externalId":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "hrEmployeeNumber":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "employeeType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Employee Type",
                    "example":"Regular"
                },
                "businessUnit":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.",
                    "example":"US1"
                },
                "status":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Employee's Current Status.",
                    "example":"ACTIVE or INACTIVE"
                },
                "creationUser":{
                    "type":"string",
                    "maxLength":8,
                    "description":"The system username for the employee. Employees do not necessarily have to be defined as users within the system."
                },
                "supervisor":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The username of the employee's supervisor"
                },
                "principalCraft":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The main craft that the employee is qualified to work."
                },
                "principalCraftExternalId":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "hiredDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Employee's Hired Date."
                },
                "jobTitle":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "jobCode":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "firstName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Employee's First Name."
                },
                "lastName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Employee's Last Name."
                },
                "emailAddress":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Employee's Email address."
                },
                "terminatedDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Employee's Termination Date."
                },
                "addressInformation":{
                    "type":"object",
                    "properties":{
                        "address1":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The first line for the address, associated with the Purchase Order."
                        },
                        "address2":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The second line for the address, associated with the Purchase Order."
                        },
                        "address3":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The third line for the address, associated with the Purchase Order."
                        },
                        "address4":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The fourth line for the address, associated with the Purchase Order."
                        },
                        "crossStreet":{
                            "type":"string",
                            "maxLength":64,
                            "description":"The Cross Street the PO address."
                        },
                        "houseType":{
                            "type":"string",
                            "enum":[
                            ],
                            "description":"The House Type for the PO address.\n"
                        },
                        "number1":{
                            "type":"string",
                            "maxLength":6,
                            "description":"Street number 1"
                        },
                        "number2":{
                            "type":"string",
                            "maxLength":4,
                            "description":"Street number 2"
                        },
                        "geographicCode":{
                            "type":"string",
                            "maxLength":11,
                            "description":"The Geographic Code for the PO address."
                        },
                        "inCityLimit":{
                            "type":"boolean",
                            "description":"In City Limit"
                        },
                        "city":{
                            "type":"string",
                            "maxLength":90,
                            "description":"The City for the PO address."
                        },
                        "suburb":{
                            "type":"string",
                            "maxLength":64,
                            "description":"The Suburb for the PO address."
                        },
                        "county":{
                            "type":"string",
                            "maxLength":90,
                            "description":"The County for the PO address.",
                            "example":"US"
                        },
                        "state":{
                            "type":"string",
                            "maxLength":6,
                            "description":"State",
                            "example":"CA"
                        },
                        "postal":{
                            "type":"string",
                            "maxLength":12,
                            "description":"The Postal Code for the PO address."
                        },
                        "country":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Country"
                        }
                    }
                },
                "phoneNumbers":{
                    "type":"object",
                    "properties":{
                        "phoneNumbersList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "phoneType":{
                                        "type":"string",
                                        "enum":[
                                            "FAX ",
                                            "SMS ",
                                            "W1BS",
                                            "W1HM",
                                            "W1MB",
                                            "W1PR"
                                        ],
                                        "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
                                    },
                                    "countryCode":{
                                        "type":"string",
                                        "maxLength":3,
                                        "description":"Country"
                                    },
                                    "areaCode":{
                                        "type":"string",
                                        "maxLength":24,
                                        "description":"Phone"
                                    },
                                    "phoneNumber":{
                                        "type":"string",
                                        "maxLength":24,
                                        "description":"Phone"
                                    }
                                }
                            }
                        }
                    }
                },
                "employeeTrainingInformation":{
                    "type":"object",
                    "properties":{
                        "employeeTrainingInformationList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "course":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Training course number"
                                    },
                                    "effectiveDate":{
                                        "type":"string",
                                        "format":"date",
                                        "description":"Effective Date"
                                    },
                                    "expirationDate":{
                                        "type":"string",
                                        "format":"date",
                                        "description":"Expiration Date"
                                    },
                                    "employeeNotified":{
                                        "type":"boolean",
                                        "description":"Employee Notified"
                                    },
                                    "supervisorNotified":{
                                        "type":"boolean",
                                        "description":"Supervisor Notified"
                                    }
                                }
                            }
                        }
                    }
                },
                "billableRates":{
                    "type":"object",
                    "properties":{
                        "billableRatesList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "effectiveDate":{
                                        "type":"string",
                                        "format":"date",
                                        "description":"Billable rates effective date"
                                    },
                                    "billableRate":{
                                        "type":"number",
                                        "description":"Billable rate"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : output

Type: object

Show Source

• syncRequestId: string
  (syncRequestId)

{
    "type":"object",
    "properties":{
        "syncRequestId":{
            "type":"string",
            "description":"(syncRequestId)"
        }
    }
}

Nested Schema : employeeInfo

Type: object

Show Source

• addressInformation: object addressInformation
• billableRates: object billableRates
• businessUnit: string
  Maximum Length: 30

  The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.

  Example: US1
• creationUser: string
  Maximum Length: 8

  The system username for the employee. Employees do not necessarily have to be defined as users within the system.
• emailAddress: string
  Maximum Length: 254

  Employee's Email address.
• employeeTrainingInformation: object employeeTrainingInformation
• employeeType: string
  Maximum Length: 30

  Employee Type

  Example: Regular
• externalId: string
  Maximum Length: 60

  Identifier Value
• firstName: string
  Maximum Length: 254

  Employee's First Name.
• hiredDate: string (date)
  Employee's Hired Date.
• hrEmployeeNumber: string
  Maximum Length: 60

  Identifier Value
• jobCode: string
  Maximum Length: 60

  Identifier Value
• jobTitle: string
  Maximum Length: 60

  Identifier Value
• lastName: string
  Maximum Length: 254

  Employee's Last Name.
• phoneNumbers: object phoneNumbers
• principalCraft: string
  Maximum Length: 12

  The main craft that the employee is qualified to work.
• principalCraftExternalId: string
  Maximum Length: 60

  Identifier Value
• status: string
  Maximum Length: 12

  Employee's Current Status.

  Example: ACTIVE or INACTIVE
• supervisor: string
  Maximum Length: 12

  The username of the employee's supervisor
• terminatedDate: string (date)
  Employee's Termination Date.

{
    "type":"object",
    "properties":{
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "hrEmployeeNumber":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "employeeType":{
            "type":"string",
            "maxLength":30,
            "description":"Employee Type",
            "example":"Regular"
        },
        "businessUnit":{
            "type":"string",
            "maxLength":30,
            "description":"The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.",
            "example":"US1"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Employee's Current Status.",
            "example":"ACTIVE or INACTIVE"
        },
        "creationUser":{
            "type":"string",
            "maxLength":8,
            "description":"The system username for the employee. Employees do not necessarily have to be defined as users within the system."
        },
        "supervisor":{
            "type":"string",
            "maxLength":12,
            "description":"The username of the employee's supervisor"
        },
        "principalCraft":{
            "type":"string",
            "maxLength":12,
            "description":"The main craft that the employee is qualified to work."
        },
        "principalCraftExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "hiredDate":{
            "type":"string",
            "format":"date",
            "description":"Employee's Hired Date."
        },
        "jobTitle":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "jobCode":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "firstName":{
            "type":"string",
            "maxLength":254,
            "description":"Employee's First Name."
        },
        "lastName":{
            "type":"string",
            "maxLength":254,
            "description":"Employee's Last Name."
        },
        "emailAddress":{
            "type":"string",
            "maxLength":254,
            "description":"Employee's Email address."
        },
        "terminatedDate":{
            "type":"string",
            "format":"date",
            "description":"Employee's Termination Date."
        },
        "addressInformation":{
            "type":"object",
            "properties":{
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The first line for the address, associated with the Purchase Order."
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The second line for the address, associated with the Purchase Order."
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The third line for the address, associated with the Purchase Order."
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The fourth line for the address, associated with the Purchase Order."
                },
                "crossStreet":{
                    "type":"string",
                    "maxLength":64,
                    "description":"The Cross Street the PO address."
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                    ],
                    "description":"The House Type for the PO address.\n"
                },
                "number1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"Street number 1"
                },
                "number2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Street number 2"
                },
                "geographicCode":{
                    "type":"string",
                    "maxLength":11,
                    "description":"The Geographic Code for the PO address."
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit"
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The City for the PO address."
                },
                "suburb":{
                    "type":"string",
                    "maxLength":64,
                    "description":"The Suburb for the PO address."
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The County for the PO address.",
                    "example":"US"
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"State",
                    "example":"CA"
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The Postal Code for the PO address."
                },
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Country"
                }
            }
        },
        "phoneNumbers":{
            "type":"object",
            "properties":{
                "phoneNumbersList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "phoneType":{
                                "type":"string",
                                "enum":[
                                    "FAX ",
                                    "SMS ",
                                    "W1BS",
                                    "W1HM",
                                    "W1MB",
                                    "W1PR"
                                ],
                                "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
                            },
                            "countryCode":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Country"
                            },
                            "areaCode":{
                                "type":"string",
                                "maxLength":24,
                                "description":"Phone"
                            },
                            "phoneNumber":{
                                "type":"string",
                                "maxLength":24,
                                "description":"Phone"
                            }
                        }
                    }
                }
            }
        },
        "employeeTrainingInformation":{
            "type":"object",
            "properties":{
                "employeeTrainingInformationList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "course":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Training course number"
                            },
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "expirationDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Expiration Date"
                            },
                            "employeeNotified":{
                                "type":"boolean",
                                "description":"Employee Notified"
                            },
                            "supervisorNotified":{
                                "type":"boolean",
                                "description":"Supervisor Notified"
                            }
                        }
                    }
                }
            }
        },
        "billableRates":{
            "type":"object",
            "properties":{
                "billableRatesList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Billable rates effective date"
                            },
                            "billableRate":{
                                "type":"number",
                                "description":"Billable rate"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : addressInformation

Type: object

Show Source

• address1: string
  Maximum Length: 254

  The first line for the address, associated with the Purchase Order.
• address2: string
  Maximum Length: 254

  The second line for the address, associated with the Purchase Order.
• address3: string
  Maximum Length: 254

  The third line for the address, associated with the Purchase Order.
• address4: string
  Maximum Length: 254

  The fourth line for the address, associated with the Purchase Order.
• city: string
  Maximum Length: 90

  The City for the PO address.
• country: string
  Maximum Length: 3

  Country
• county: string
  Maximum Length: 90

  The County for the PO address.

  Example: US
• crossStreet: string
  Maximum Length: 64

  The Cross Street the PO address.
• geographicCode: string
  Maximum Length: 11

  The Geographic Code for the PO address.
• houseType: string
  The House Type for the PO address.
• inCityLimit: boolean
  In City Limit
• number1: string
  Maximum Length: 6

  Street number 1
• number2: string
  Maximum Length: 4

  Street number 2
• postal: string
  Maximum Length: 12

  The Postal Code for the PO address.
• state: string
  Maximum Length: 6

  State

  Example: CA
• suburb: string
  Maximum Length: 64

  The Suburb for the PO address.

{
    "type":"object",
    "properties":{
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"The first line for the address, associated with the Purchase Order."
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"The second line for the address, associated with the Purchase Order."
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"The third line for the address, associated with the Purchase Order."
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"The fourth line for the address, associated with the Purchase Order."
        },
        "crossStreet":{
            "type":"string",
            "maxLength":64,
            "description":"The Cross Street the PO address."
        },
        "houseType":{
            "type":"string",
            "enum":[
            ],
            "description":"The House Type for the PO address.\n"
        },
        "number1":{
            "type":"string",
            "maxLength":6,
            "description":"Street number 1"
        },
        "number2":{
            "type":"string",
            "maxLength":4,
            "description":"Street number 2"
        },
        "geographicCode":{
            "type":"string",
            "maxLength":11,
            "description":"The Geographic Code for the PO address."
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"The City for the PO address."
        },
        "suburb":{
            "type":"string",
            "maxLength":64,
            "description":"The Suburb for the PO address."
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"The County for the PO address.",
            "example":"US"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"State",
            "example":"CA"
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The Postal Code for the PO address."
        },
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"Country"
        }
    }
}

Nested Schema : billableRates

Type: object

Show Source

• billableRatesList: array billableRatesList

{
    "type":"object",
    "properties":{
        "billableRatesList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Billable rates effective date"
                    },
                    "billableRate":{
                        "type":"number",
                        "description":"Billable rate"
                    }
                }
            }
        }
    }
}

Nested Schema : employeeTrainingInformation

Type: object

Show Source

• employeeTrainingInformationList: array employeeTrainingInformationList

{
    "type":"object",
    "properties":{
        "employeeTrainingInformationList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "course":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Training course number"
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "expirationDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Expiration Date"
                    },
                    "employeeNotified":{
                        "type":"boolean",
                        "description":"Employee Notified"
                    },
                    "supervisorNotified":{
                        "type":"boolean",
                        "description":"Supervisor Notified"
                    }
                }
            }
        }
    }
}

Nested Schema : phoneNumbers

Type: object

Show Source

• phoneNumbersList: array phoneNumbersList

{
    "type":"object",
    "properties":{
        "phoneNumbersList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "phoneType":{
                        "type":"string",
                        "enum":[
                            "FAX ",
                            "SMS ",
                            "W1BS",
                            "W1HM",
                            "W1MB",
                            "W1PR"
                        ],
                        "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
                    },
                    "countryCode":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Country"
                    },
                    "areaCode":{
                        "type":"string",
                        "maxLength":24,
                        "description":"Phone"
                    },
                    "phoneNumber":{
                        "type":"string",
                        "maxLength":24,
                        "description":"Phone"
                    }
                }
            }
        }
    }
}

Nested Schema : billableRatesList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Billable rates effective date"
            },
            "billableRate":{
                "type":"number",
                "description":"Billable rate"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billableRate: number
  Billable rate
• effectiveDate: string (date)
  Billable rates effective date

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Billable rates effective date"
        },
        "billableRate":{
            "type":"number",
            "description":"Billable rate"
        }
    }
}

Nested Schema : employeeTrainingInformationList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "course":{
                "type":"string",
                "maxLength":254,
                "description":"Training course number"
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "expirationDate":{
                "type":"string",
                "format":"date",
                "description":"Expiration Date"
            },
            "employeeNotified":{
                "type":"boolean",
                "description":"Employee Notified"
            },
            "supervisorNotified":{
                "type":"boolean",
                "description":"Supervisor Notified"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• course: string
  Maximum Length: 254

  Training course number
• effectiveDate: string (date)
  Effective Date
• employeeNotified: boolean
  Employee Notified
• expirationDate: string (date)
  Expiration Date
• supervisorNotified: boolean
  Supervisor Notified

{
    "type":"object",
    "properties":{
        "course":{
            "type":"string",
            "maxLength":254,
            "description":"Training course number"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "expirationDate":{
            "type":"string",
            "format":"date",
            "description":"Expiration Date"
        },
        "employeeNotified":{
            "type":"boolean",
            "description":"Employee Notified"
        },
        "supervisorNotified":{
            "type":"boolean",
            "description":"Supervisor Notified"
        }
    }
}

Nested Schema : phoneNumbersList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "phoneType":{
                "type":"string",
                "enum":[
                    "FAX ",
                    "SMS ",
                    "W1BS",
                    "W1HM",
                    "W1MB",
                    "W1PR"
                ],
                "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
            },
            "countryCode":{
                "type":"string",
                "maxLength":3,
                "description":"Country"
            },
            "areaCode":{
                "type":"string",
                "maxLength":24,
                "description":"Phone"
            },
            "phoneNumber":{
                "type":"string",
                "maxLength":24,
                "description":"Phone"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• areaCode: string
  Maximum Length: 24

  Phone
• countryCode: string
  Maximum Length: 3

  Country
• phoneNumber: string
  Maximum Length: 24

  Phone
• phoneType: string
  Allowed Values: [ "FAX ", "SMS ", "W1BS", "W1HM", "W1MB", "W1PR" ]

  Phone number type * `FAX ` - Fax, * `SMS ` - Short Message Service, * `W1BS` - Business, * `W1HM` - Home, * `W1MB` - Mobile, * `W1PR` - Primary

{
    "type":"object",
    "properties":{
        "phoneType":{
            "type":"string",
            "enum":[
                "FAX ",
                "SMS ",
                "W1BS",
                "W1HM",
                "W1MB",
                "W1PR"
            ],
            "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
        },
        "countryCode":{
            "type":"string",
            "maxLength":3,
            "description":"Country"
        },
        "areaCode":{
            "type":"string",
            "maxLength":24,
            "description":"Phone"
        },
        "phoneNumber":{
            "type":"string",
            "maxLength":24,
            "description":"Phone"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : SYNCEMPLOYEE_response

Type: object

Show Source

• W1CreEmpSync: object W1CreEmpSync

{
    "type":"object",
    "properties":{
        "W1CreEmpSync":{
            "type":"object",
            "properties":{
                "input":{
                    "type":"object",
                    "properties":{
                        "externalSystem":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Defaulted (value) by the HCM Integration.",
                            "example":"HCM"
                        },
                        "externalReferenceId":{
                            "type":"string",
                            "maxLength":36,
                            "description":"Variable based on the originating system"
                        },
                        "initialLoad":{
                            "type":"string",
                            "maxLength":4,
                            "description":"Defaulted (value) by the HCM Integration."
                        },
                        "employeeInfo":{
                            "type":"object",
                            "properties":{
                                "externalId":{
                                    "type":"string",
                                    "maxLength":60,
                                    "description":"Identifier Value"
                                },
                                "hrEmployeeNumber":{
                                    "type":"string",
                                    "maxLength":60,
                                    "description":"Identifier Value"
                                },
                                "employeeType":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Employee Type",
                                    "example":"Regular"
                                },
                                "businessUnit":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.",
                                    "example":"US1"
                                },
                                "status":{
                                    "type":"string",
                                    "maxLength":12,
                                    "description":"Employee's Current Status.",
                                    "example":"ACTIVE or INACTIVE"
                                },
                                "creationUser":{
                                    "type":"string",
                                    "maxLength":8,
                                    "description":"The system username for the employee. Employees do not necessarily have to be defined as users within the system."
                                },
                                "supervisor":{
                                    "type":"string",
                                    "maxLength":12,
                                    "description":"The username of the employee's supervisor"
                                },
                                "principalCraft":{
                                    "type":"string",
                                    "maxLength":12,
                                    "description":"The main craft that the employee is qualified to work."
                                },
                                "principalCraftExternalId":{
                                    "type":"string",
                                    "maxLength":60,
                                    "description":"Identifier Value"
                                },
                                "hiredDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"Employee's Hired Date."
                                },
                                "jobTitle":{
                                    "type":"string",
                                    "maxLength":60,
                                    "description":"Identifier Value"
                                },
                                "jobCode":{
                                    "type":"string",
                                    "maxLength":60,
                                    "description":"Identifier Value"
                                },
                                "firstName":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Employee's First Name."
                                },
                                "lastName":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Employee's Last Name."
                                },
                                "emailAddress":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Employee's Email address."
                                },
                                "terminatedDate":{
                                    "type":"string",
                                    "format":"date",
                                    "description":"Employee's Termination Date."
                                },
                                "addressInformation":{
                                    "type":"object",
                                    "properties":{
                                        "address1":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"The first line for the address, associated with the Purchase Order."
                                        },
                                        "address2":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"The second line for the address, associated with the Purchase Order."
                                        },
                                        "address3":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"The third line for the address, associated with the Purchase Order."
                                        },
                                        "address4":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"The fourth line for the address, associated with the Purchase Order."
                                        },
                                        "crossStreet":{
                                            "type":"string",
                                            "maxLength":64,
                                            "description":"The Cross Street the PO address."
                                        },
                                        "houseType":{
                                            "type":"string",
                                            "enum":[
                                            ],
                                            "description":"The House Type for the PO address.\n"
                                        },
                                        "number1":{
                                            "type":"string",
                                            "maxLength":6,
                                            "description":"Street number 1"
                                        },
                                        "number2":{
                                            "type":"string",
                                            "maxLength":4,
                                            "description":"Street number 2"
                                        },
                                        "geographicCode":{
                                            "type":"string",
                                            "maxLength":11,
                                            "description":"The Geographic Code for the PO address."
                                        },
                                        "inCityLimit":{
                                            "type":"boolean",
                                            "description":"In City Limit"
                                        },
                                        "city":{
                                            "type":"string",
                                            "maxLength":90,
                                            "description":"The City for the PO address."
                                        },
                                        "suburb":{
                                            "type":"string",
                                            "maxLength":64,
                                            "description":"The Suburb for the PO address."
                                        },
                                        "county":{
                                            "type":"string",
                                            "maxLength":90,
                                            "description":"The County for the PO address.",
                                            "example":"US"
                                        },
                                        "state":{
                                            "type":"string",
                                            "maxLength":6,
                                            "description":"State",
                                            "example":"CA"
                                        },
                                        "postal":{
                                            "type":"string",
                                            "maxLength":12,
                                            "description":"The Postal Code for the PO address."
                                        },
                                        "country":{
                                            "type":"string",
                                            "maxLength":3,
                                            "description":"Country"
                                        }
                                    }
                                },
                                "phoneNumbers":{
                                    "type":"object",
                                    "properties":{
                                        "phoneNumbersList":{
                                            "type":"array",
                                            "items":{
                                                "type":"object",
                                                "properties":{
                                                    "phoneType":{
                                                        "type":"string",
                                                        "enum":[
                                                            "FAX ",
                                                            "SMS ",
                                                            "W1BS",
                                                            "W1HM",
                                                            "W1MB",
                                                            "W1PR"
                                                        ],
                                                        "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
                                                    },
                                                    "countryCode":{
                                                        "type":"string",
                                                        "maxLength":3,
                                                        "description":"Country"
                                                    },
                                                    "areaCode":{
                                                        "type":"string",
                                                        "maxLength":24,
                                                        "description":"Phone"
                                                    },
                                                    "phoneNumber":{
                                                        "type":"string",
                                                        "maxLength":24,
                                                        "description":"Phone"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "employeeTrainingInformation":{
                                    "type":"object",
                                    "properties":{
                                        "employeeTrainingInformationList":{
                                            "type":"array",
                                            "items":{
                                                "type":"object",
                                                "properties":{
                                                    "course":{
                                                        "type":"string",
                                                        "maxLength":254,
                                                        "description":"Training course number"
                                                    },
                                                    "effectiveDate":{
                                                        "type":"string",
                                                        "format":"date",
                                                        "description":"Effective Date"
                                                    },
                                                    "expirationDate":{
                                                        "type":"string",
                                                        "format":"date",
                                                        "description":"Expiration Date"
                                                    },
                                                    "employeeNotified":{
                                                        "type":"boolean",
                                                        "description":"Employee Notified"
                                                    },
                                                    "supervisorNotified":{
                                                        "type":"boolean",
                                                        "description":"Supervisor Notified"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "billableRates":{
                                    "type":"object",
                                    "properties":{
                                        "billableRatesList":{
                                            "type":"array",
                                            "items":{
                                                "type":"object",
                                                "properties":{
                                                    "effectiveDate":{
                                                        "type":"string",
                                                        "format":"date",
                                                        "description":"Billable rates effective date"
                                                    },
                                                    "billableRate":{
                                                        "type":"number",
                                                        "description":"Billable rate"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "output":{
                    "type":"object",
                    "properties":{
                        "syncRequestId":{
                            "type":"string",
                            "description":"(syncRequestId)"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : W1CreEmpSync

Type: object

Show Source

• input: object input
• output: object output

{
    "type":"object",
    "properties":{
        "input":{
            "type":"object",
            "properties":{
                "externalSystem":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Defaulted (value) by the HCM Integration.",
                    "example":"HCM"
                },
                "externalReferenceId":{
                    "type":"string",
                    "maxLength":36,
                    "description":"Variable based on the originating system"
                },
                "initialLoad":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Defaulted (value) by the HCM Integration."
                },
                "employeeInfo":{
                    "type":"object",
                    "properties":{
                        "externalId":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "hrEmployeeNumber":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "employeeType":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Employee Type",
                            "example":"Regular"
                        },
                        "businessUnit":{
                            "type":"string",
                            "maxLength":30,
                            "description":"The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.",
                            "example":"US1"
                        },
                        "status":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Employee's Current Status.",
                            "example":"ACTIVE or INACTIVE"
                        },
                        "creationUser":{
                            "type":"string",
                            "maxLength":8,
                            "description":"The system username for the employee. Employees do not necessarily have to be defined as users within the system."
                        },
                        "supervisor":{
                            "type":"string",
                            "maxLength":12,
                            "description":"The username of the employee's supervisor"
                        },
                        "principalCraft":{
                            "type":"string",
                            "maxLength":12,
                            "description":"The main craft that the employee is qualified to work."
                        },
                        "principalCraftExternalId":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "hiredDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Employee's Hired Date."
                        },
                        "jobTitle":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "jobCode":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "firstName":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Employee's First Name."
                        },
                        "lastName":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Employee's Last Name."
                        },
                        "emailAddress":{
                            "type":"string",
                            "maxLength":254,
                            "description":"Employee's Email address."
                        },
                        "terminatedDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Employee's Termination Date."
                        },
                        "addressInformation":{
                            "type":"object",
                            "properties":{
                                "address1":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The first line for the address, associated with the Purchase Order."
                                },
                                "address2":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The second line for the address, associated with the Purchase Order."
                                },
                                "address3":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The third line for the address, associated with the Purchase Order."
                                },
                                "address4":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The fourth line for the address, associated with the Purchase Order."
                                },
                                "crossStreet":{
                                    "type":"string",
                                    "maxLength":64,
                                    "description":"The Cross Street the PO address."
                                },
                                "houseType":{
                                    "type":"string",
                                    "enum":[
                                    ],
                                    "description":"The House Type for the PO address.\n"
                                },
                                "number1":{
                                    "type":"string",
                                    "maxLength":6,
                                    "description":"Street number 1"
                                },
                                "number2":{
                                    "type":"string",
                                    "maxLength":4,
                                    "description":"Street number 2"
                                },
                                "geographicCode":{
                                    "type":"string",
                                    "maxLength":11,
                                    "description":"The Geographic Code for the PO address."
                                },
                                "inCityLimit":{
                                    "type":"boolean",
                                    "description":"In City Limit"
                                },
                                "city":{
                                    "type":"string",
                                    "maxLength":90,
                                    "description":"The City for the PO address."
                                },
                                "suburb":{
                                    "type":"string",
                                    "maxLength":64,
                                    "description":"The Suburb for the PO address."
                                },
                                "county":{
                                    "type":"string",
                                    "maxLength":90,
                                    "description":"The County for the PO address.",
                                    "example":"US"
                                },
                                "state":{
                                    "type":"string",
                                    "maxLength":6,
                                    "description":"State",
                                    "example":"CA"
                                },
                                "postal":{
                                    "type":"string",
                                    "maxLength":12,
                                    "description":"The Postal Code for the PO address."
                                },
                                "country":{
                                    "type":"string",
                                    "maxLength":3,
                                    "description":"Country"
                                }
                            }
                        },
                        "phoneNumbers":{
                            "type":"object",
                            "properties":{
                                "phoneNumbersList":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "phoneType":{
                                                "type":"string",
                                                "enum":[
                                                    "FAX ",
                                                    "SMS ",
                                                    "W1BS",
                                                    "W1HM",
                                                    "W1MB",
                                                    "W1PR"
                                                ],
                                                "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
                                            },
                                            "countryCode":{
                                                "type":"string",
                                                "maxLength":3,
                                                "description":"Country"
                                            },
                                            "areaCode":{
                                                "type":"string",
                                                "maxLength":24,
                                                "description":"Phone"
                                            },
                                            "phoneNumber":{
                                                "type":"string",
                                                "maxLength":24,
                                                "description":"Phone"
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "employeeTrainingInformation":{
                            "type":"object",
                            "properties":{
                                "employeeTrainingInformationList":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "course":{
                                                "type":"string",
                                                "maxLength":254,
                                                "description":"Training course number"
                                            },
                                            "effectiveDate":{
                                                "type":"string",
                                                "format":"date",
                                                "description":"Effective Date"
                                            },
                                            "expirationDate":{
                                                "type":"string",
                                                "format":"date",
                                                "description":"Expiration Date"
                                            },
                                            "employeeNotified":{
                                                "type":"boolean",
                                                "description":"Employee Notified"
                                            },
                                            "supervisorNotified":{
                                                "type":"boolean",
                                                "description":"Supervisor Notified"
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "billableRates":{
                            "type":"object",
                            "properties":{
                                "billableRatesList":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "effectiveDate":{
                                                "type":"string",
                                                "format":"date",
                                                "description":"Billable rates effective date"
                                            },
                                            "billableRate":{
                                                "type":"number",
                                                "description":"Billable rate"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "output":{
            "type":"object",
            "properties":{
                "syncRequestId":{
                    "type":"string",
                    "description":"(syncRequestId)"
                }
            }
        }
    }
}

Nested Schema : input

Type: object

Show Source

• employeeInfo: object employeeInfo
• externalReferenceId: string
  Maximum Length: 36

  Variable based on the originating system
• externalSystem: string
  Maximum Length: 30

  Defaulted (value) by the HCM Integration.

  Example: HCM
• initialLoad: string
  Maximum Length: 4

  Defaulted (value) by the HCM Integration.

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"Defaulted (value) by the HCM Integration.",
            "example":"HCM"
        },
        "externalReferenceId":{
            "type":"string",
            "maxLength":36,
            "description":"Variable based on the originating system"
        },
        "initialLoad":{
            "type":"string",
            "maxLength":4,
            "description":"Defaulted (value) by the HCM Integration."
        },
        "employeeInfo":{
            "type":"object",
            "properties":{
                "externalId":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "hrEmployeeNumber":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "employeeType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Employee Type",
                    "example":"Regular"
                },
                "businessUnit":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.",
                    "example":"US1"
                },
                "status":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Employee's Current Status.",
                    "example":"ACTIVE or INACTIVE"
                },
                "creationUser":{
                    "type":"string",
                    "maxLength":8,
                    "description":"The system username for the employee. Employees do not necessarily have to be defined as users within the system."
                },
                "supervisor":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The username of the employee's supervisor"
                },
                "principalCraft":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The main craft that the employee is qualified to work."
                },
                "principalCraftExternalId":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "hiredDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Employee's Hired Date."
                },
                "jobTitle":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "jobCode":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "firstName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Employee's First Name."
                },
                "lastName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Employee's Last Name."
                },
                "emailAddress":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Employee's Email address."
                },
                "terminatedDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Employee's Termination Date."
                },
                "addressInformation":{
                    "type":"object",
                    "properties":{
                        "address1":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The first line for the address, associated with the Purchase Order."
                        },
                        "address2":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The second line for the address, associated with the Purchase Order."
                        },
                        "address3":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The third line for the address, associated with the Purchase Order."
                        },
                        "address4":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The fourth line for the address, associated with the Purchase Order."
                        },
                        "crossStreet":{
                            "type":"string",
                            "maxLength":64,
                            "description":"The Cross Street the PO address."
                        },
                        "houseType":{
                            "type":"string",
                            "enum":[
                            ],
                            "description":"The House Type for the PO address.\n"
                        },
                        "number1":{
                            "type":"string",
                            "maxLength":6,
                            "description":"Street number 1"
                        },
                        "number2":{
                            "type":"string",
                            "maxLength":4,
                            "description":"Street number 2"
                        },
                        "geographicCode":{
                            "type":"string",
                            "maxLength":11,
                            "description":"The Geographic Code for the PO address."
                        },
                        "inCityLimit":{
                            "type":"boolean",
                            "description":"In City Limit"
                        },
                        "city":{
                            "type":"string",
                            "maxLength":90,
                            "description":"The City for the PO address."
                        },
                        "suburb":{
                            "type":"string",
                            "maxLength":64,
                            "description":"The Suburb for the PO address."
                        },
                        "county":{
                            "type":"string",
                            "maxLength":90,
                            "description":"The County for the PO address.",
                            "example":"US"
                        },
                        "state":{
                            "type":"string",
                            "maxLength":6,
                            "description":"State",
                            "example":"CA"
                        },
                        "postal":{
                            "type":"string",
                            "maxLength":12,
                            "description":"The Postal Code for the PO address."
                        },
                        "country":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Country"
                        }
                    }
                },
                "phoneNumbers":{
                    "type":"object",
                    "properties":{
                        "phoneNumbersList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "phoneType":{
                                        "type":"string",
                                        "enum":[
                                            "FAX ",
                                            "SMS ",
                                            "W1BS",
                                            "W1HM",
                                            "W1MB",
                                            "W1PR"
                                        ],
                                        "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
                                    },
                                    "countryCode":{
                                        "type":"string",
                                        "maxLength":3,
                                        "description":"Country"
                                    },
                                    "areaCode":{
                                        "type":"string",
                                        "maxLength":24,
                                        "description":"Phone"
                                    },
                                    "phoneNumber":{
                                        "type":"string",
                                        "maxLength":24,
                                        "description":"Phone"
                                    }
                                }
                            }
                        }
                    }
                },
                "employeeTrainingInformation":{
                    "type":"object",
                    "properties":{
                        "employeeTrainingInformationList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "course":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Training course number"
                                    },
                                    "effectiveDate":{
                                        "type":"string",
                                        "format":"date",
                                        "description":"Effective Date"
                                    },
                                    "expirationDate":{
                                        "type":"string",
                                        "format":"date",
                                        "description":"Expiration Date"
                                    },
                                    "employeeNotified":{
                                        "type":"boolean",
                                        "description":"Employee Notified"
                                    },
                                    "supervisorNotified":{
                                        "type":"boolean",
                                        "description":"Supervisor Notified"
                                    }
                                }
                            }
                        }
                    }
                },
                "billableRates":{
                    "type":"object",
                    "properties":{
                        "billableRatesList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "effectiveDate":{
                                        "type":"string",
                                        "format":"date",
                                        "description":"Billable rates effective date"
                                    },
                                    "billableRate":{
                                        "type":"number",
                                        "description":"Billable rate"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : output

Type: object

Show Source

• syncRequestId: string
  (syncRequestId)

{
    "type":"object",
    "properties":{
        "syncRequestId":{
            "type":"string",
            "description":"(syncRequestId)"
        }
    }
}

Nested Schema : employeeInfo

Type: object

Show Source

• addressInformation: object addressInformation
• billableRates: object billableRates
• businessUnit: string
  Maximum Length: 30

  The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.

  Example: US1
• creationUser: string
  Maximum Length: 8

  The system username for the employee. Employees do not necessarily have to be defined as users within the system.
• emailAddress: string
  Maximum Length: 254

  Employee's Email address.
• employeeTrainingInformation: object employeeTrainingInformation
• employeeType: string
  Maximum Length: 30

  Employee Type

  Example: Regular
• externalId: string
  Maximum Length: 60

  Identifier Value
• firstName: string
  Maximum Length: 254

  Employee's First Name.
• hiredDate: string (date)
  Employee's Hired Date.
• hrEmployeeNumber: string
  Maximum Length: 60

  Identifier Value
• jobCode: string
  Maximum Length: 60

  Identifier Value
• jobTitle: string
  Maximum Length: 60

  Identifier Value
• lastName: string
  Maximum Length: 254

  Employee's Last Name.
• phoneNumbers: object phoneNumbers
• principalCraft: string
  Maximum Length: 12

  The main craft that the employee is qualified to work.
• principalCraftExternalId: string
  Maximum Length: 60

  Identifier Value
• status: string
  Maximum Length: 12

  Employee's Current Status.

  Example: ACTIVE or INACTIVE
• supervisor: string
  Maximum Length: 12

  The username of the employee's supervisor
• terminatedDate: string (date)
  Employee's Termination Date.

{
    "type":"object",
    "properties":{
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "hrEmployeeNumber":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "employeeType":{
            "type":"string",
            "maxLength":30,
            "description":"Employee Type",
            "example":"Regular"
        },
        "businessUnit":{
            "type":"string",
            "maxLength":30,
            "description":"The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.",
            "example":"US1"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Employee's Current Status.",
            "example":"ACTIVE or INACTIVE"
        },
        "creationUser":{
            "type":"string",
            "maxLength":8,
            "description":"The system username for the employee. Employees do not necessarily have to be defined as users within the system."
        },
        "supervisor":{
            "type":"string",
            "maxLength":12,
            "description":"The username of the employee's supervisor"
        },
        "principalCraft":{
            "type":"string",
            "maxLength":12,
            "description":"The main craft that the employee is qualified to work."
        },
        "principalCraftExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "hiredDate":{
            "type":"string",
            "format":"date",
            "description":"Employee's Hired Date."
        },
        "jobTitle":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "jobCode":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "firstName":{
            "type":"string",
            "maxLength":254,
            "description":"Employee's First Name."
        },
        "lastName":{
            "type":"string",
            "maxLength":254,
            "description":"Employee's Last Name."
        },
        "emailAddress":{
            "type":"string",
            "maxLength":254,
            "description":"Employee's Email address."
        },
        "terminatedDate":{
            "type":"string",
            "format":"date",
            "description":"Employee's Termination Date."
        },
        "addressInformation":{
            "type":"object",
            "properties":{
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The first line for the address, associated with the Purchase Order."
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The second line for the address, associated with the Purchase Order."
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The third line for the address, associated with the Purchase Order."
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The fourth line for the address, associated with the Purchase Order."
                },
                "crossStreet":{
                    "type":"string",
                    "maxLength":64,
                    "description":"The Cross Street the PO address."
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                    ],
                    "description":"The House Type for the PO address.\n"
                },
                "number1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"Street number 1"
                },
                "number2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Street number 2"
                },
                "geographicCode":{
                    "type":"string",
                    "maxLength":11,
                    "description":"The Geographic Code for the PO address."
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit"
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The City for the PO address."
                },
                "suburb":{
                    "type":"string",
                    "maxLength":64,
                    "description":"The Suburb for the PO address."
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The County for the PO address.",
                    "example":"US"
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"State",
                    "example":"CA"
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The Postal Code for the PO address."
                },
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Country"
                }
            }
        },
        "phoneNumbers":{
            "type":"object",
            "properties":{
                "phoneNumbersList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "phoneType":{
                                "type":"string",
                                "enum":[
                                    "FAX ",
                                    "SMS ",
                                    "W1BS",
                                    "W1HM",
                                    "W1MB",
                                    "W1PR"
                                ],
                                "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
                            },
                            "countryCode":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Country"
                            },
                            "areaCode":{
                                "type":"string",
                                "maxLength":24,
                                "description":"Phone"
                            },
                            "phoneNumber":{
                                "type":"string",
                                "maxLength":24,
                                "description":"Phone"
                            }
                        }
                    }
                }
            }
        },
        "employeeTrainingInformation":{
            "type":"object",
            "properties":{
                "employeeTrainingInformationList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "course":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Training course number"
                            },
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "expirationDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Expiration Date"
                            },
                            "employeeNotified":{
                                "type":"boolean",
                                "description":"Employee Notified"
                            },
                            "supervisorNotified":{
                                "type":"boolean",
                                "description":"Supervisor Notified"
                            }
                        }
                    }
                }
            }
        },
        "billableRates":{
            "type":"object",
            "properties":{
                "billableRatesList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Billable rates effective date"
                            },
                            "billableRate":{
                                "type":"number",
                                "description":"Billable rate"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : addressInformation

Type: object

Show Source

• address1: string
  Maximum Length: 254

  The first line for the address, associated with the Purchase Order.
• address2: string
  Maximum Length: 254

  The second line for the address, associated with the Purchase Order.
• address3: string
  Maximum Length: 254

  The third line for the address, associated with the Purchase Order.
• address4: string
  Maximum Length: 254

  The fourth line for the address, associated with the Purchase Order.
• city: string
  Maximum Length: 90

  The City for the PO address.
• country: string
  Maximum Length: 3

  Country
• county: string
  Maximum Length: 90

  The County for the PO address.

  Example: US
• crossStreet: string
  Maximum Length: 64

  The Cross Street the PO address.
• geographicCode: string
  Maximum Length: 11

  The Geographic Code for the PO address.
• houseType: string
  The House Type for the PO address.
• inCityLimit: boolean
  In City Limit
• number1: string
  Maximum Length: 6

  Street number 1
• number2: string
  Maximum Length: 4

  Street number 2
• postal: string
  Maximum Length: 12

  The Postal Code for the PO address.
• state: string
  Maximum Length: 6

  State

  Example: CA
• suburb: string
  Maximum Length: 64

  The Suburb for the PO address.

{
    "type":"object",
    "properties":{
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"The first line for the address, associated with the Purchase Order."
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"The second line for the address, associated with the Purchase Order."
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"The third line for the address, associated with the Purchase Order."
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"The fourth line for the address, associated with the Purchase Order."
        },
        "crossStreet":{
            "type":"string",
            "maxLength":64,
            "description":"The Cross Street the PO address."
        },
        "houseType":{
            "type":"string",
            "enum":[
            ],
            "description":"The House Type for the PO address.\n"
        },
        "number1":{
            "type":"string",
            "maxLength":6,
            "description":"Street number 1"
        },
        "number2":{
            "type":"string",
            "maxLength":4,
            "description":"Street number 2"
        },
        "geographicCode":{
            "type":"string",
            "maxLength":11,
            "description":"The Geographic Code for the PO address."
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"The City for the PO address."
        },
        "suburb":{
            "type":"string",
            "maxLength":64,
            "description":"The Suburb for the PO address."
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"The County for the PO address.",
            "example":"US"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"State",
            "example":"CA"
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The Postal Code for the PO address."
        },
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"Country"
        }
    }
}

Nested Schema : billableRates

Type: object

Show Source

• billableRatesList: array billableRatesList

{
    "type":"object",
    "properties":{
        "billableRatesList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Billable rates effective date"
                    },
                    "billableRate":{
                        "type":"number",
                        "description":"Billable rate"
                    }
                }
            }
        }
    }
}

Nested Schema : employeeTrainingInformation

Type: object

Show Source

• employeeTrainingInformationList: array employeeTrainingInformationList

{
    "type":"object",
    "properties":{
        "employeeTrainingInformationList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "course":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Training course number"
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "expirationDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Expiration Date"
                    },
                    "employeeNotified":{
                        "type":"boolean",
                        "description":"Employee Notified"
                    },
                    "supervisorNotified":{
                        "type":"boolean",
                        "description":"Supervisor Notified"
                    }
                }
            }
        }
    }
}

Nested Schema : phoneNumbers

Type: object

Show Source

• phoneNumbersList: array phoneNumbersList

{
    "type":"object",
    "properties":{
        "phoneNumbersList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "phoneType":{
                        "type":"string",
                        "enum":[
                            "FAX ",
                            "SMS ",
                            "W1BS",
                            "W1HM",
                            "W1MB",
                            "W1PR"
                        ],
                        "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
                    },
                    "countryCode":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Country"
                    },
                    "areaCode":{
                        "type":"string",
                        "maxLength":24,
                        "description":"Phone"
                    },
                    "phoneNumber":{
                        "type":"string",
                        "maxLength":24,
                        "description":"Phone"
                    }
                }
            }
        }
    }
}

Nested Schema : billableRatesList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Billable rates effective date"
            },
            "billableRate":{
                "type":"number",
                "description":"Billable rate"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• billableRate: number
  Billable rate
• effectiveDate: string (date)
  Billable rates effective date

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Billable rates effective date"
        },
        "billableRate":{
            "type":"number",
            "description":"Billable rate"
        }
    }
}

Nested Schema : employeeTrainingInformationList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "course":{
                "type":"string",
                "maxLength":254,
                "description":"Training course number"
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "expirationDate":{
                "type":"string",
                "format":"date",
                "description":"Expiration Date"
            },
            "employeeNotified":{
                "type":"boolean",
                "description":"Employee Notified"
            },
            "supervisorNotified":{
                "type":"boolean",
                "description":"Supervisor Notified"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• course: string
  Maximum Length: 254

  Training course number
• effectiveDate: string (date)
  Effective Date
• employeeNotified: boolean
  Employee Notified
• expirationDate: string (date)
  Expiration Date
• supervisorNotified: boolean
  Supervisor Notified

{
    "type":"object",
    "properties":{
        "course":{
            "type":"string",
            "maxLength":254,
            "description":"Training course number"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "expirationDate":{
            "type":"string",
            "format":"date",
            "description":"Expiration Date"
        },
        "employeeNotified":{
            "type":"boolean",
            "description":"Employee Notified"
        },
        "supervisorNotified":{
            "type":"boolean",
            "description":"Supervisor Notified"
        }
    }
}

Nested Schema : phoneNumbersList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "phoneType":{
                "type":"string",
                "enum":[
                    "FAX ",
                    "SMS ",
                    "W1BS",
                    "W1HM",
                    "W1MB",
                    "W1PR"
                ],
                "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
            },
            "countryCode":{
                "type":"string",
                "maxLength":3,
                "description":"Country"
            },
            "areaCode":{
                "type":"string",
                "maxLength":24,
                "description":"Phone"
            },
            "phoneNumber":{
                "type":"string",
                "maxLength":24,
                "description":"Phone"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• areaCode: string
  Maximum Length: 24

  Phone
• countryCode: string
  Maximum Length: 3

  Country
• phoneNumber: string
  Maximum Length: 24

  Phone
• phoneType: string
  Allowed Values: [ "FAX ", "SMS ", "W1BS", "W1HM", "W1MB", "W1PR" ]

  Phone number type * `FAX ` - Fax, * `SMS ` - Short Message Service, * `W1BS` - Business, * `W1HM` - Home, * `W1MB` - Mobile, * `W1PR` - Primary

{
    "type":"object",
    "properties":{
        "phoneType":{
            "type":"string",
            "enum":[
                "FAX ",
                "SMS ",
                "W1BS",
                "W1HM",
                "W1MB",
                "W1PR"
            ],
            "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary"
        },
        "countryCode":{
            "type":"string",
            "maxLength":3,
            "description":"Country"
        },
        "areaCode":{
            "type":"string",
            "maxLength":24,
            "description":"Phone"
        },
        "phoneNumber":{
            "type":"string",
            "maxLength":24,
            "description":"Phone"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : SYNCEMPLOYEE_error

Type: object

Show Source

• problemDetailDocument: object problemDetailDocument

{
    "type":"object",
    "properties":{
        "problemDetailDocument":{
            "type":"object",
            "properties":{
                "problemType":{
                    "type":"string",
                    "maxLength":60,
                    "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
                },
                "title":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "httpStatus":{
                    "type":"number",
                    "maximum":9999,
                    "minimum":0,
                    "description":"The HTTP Status code for the error."
                },
                "detail":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                },
                "problemInstance":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
                },
                "stackTrace":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The stack trace shows where the error occurs during the execution of a program."
                },
                "serverMessage":{
                    "type":"object",
                    "properties":{
                        "messageCategory":{
                            "type":"number",
                            "maximum":0,
                            "minimum":0,
                            "description":"Message Category within Oracle Utilities Application Framework."
                        },
                        "messageNbr":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Number within Oracle Utilities Application Framework."
                        },
                        "callSequence":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Delimited sequence of programs called."
                        },
                        "programName":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Name of the program that encountered the error."
                        },
                        "messageText":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                        },
                        "longDescription":{
                            "type":"string",
                            "maxLength":60,
                            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : SYNCEMPLOYEE_error

Type: object

Show Source

• problemDetailDocument: object problemDetailDocument

{
    "type":"object",
    "properties":{
        "problemDetailDocument":{
            "type":"object",
            "properties":{
                "problemType":{
                    "type":"string",
                    "maxLength":60,
                    "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
                },
                "title":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "httpStatus":{
                    "type":"number",
                    "maximum":9999,
                    "minimum":0,
                    "description":"The HTTP Status code for the error."
                },
                "detail":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                },
                "problemInstance":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
                },
                "stackTrace":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The stack trace shows where the error occurs during the execution of a program."
                },
                "serverMessage":{
                    "type":"object",
                    "properties":{
                        "messageCategory":{
                            "type":"number",
                            "maximum":0,
                            "minimum":0,
                            "description":"Message Category within Oracle Utilities Application Framework."
                        },
                        "messageNbr":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Number within Oracle Utilities Application Framework."
                        },
                        "callSequence":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Delimited sequence of programs called."
                        },
                        "programName":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Name of the program that encountered the error."
                        },
                        "messageText":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                        },
                        "longDescription":{
                            "type":"string",
                            "maxLength":60,
                            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top