2.0info: 2.12.2 employeejourney description: Serviço da Jornada do Colaborador: provê informações sobre o colaborador x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: employeejourney contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /hcm/employeejourneysecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /entities/companyWithBranches: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/companyWithBranches responses: 200: description: The created resource schema: #/definitions/companyWithBranches default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/companyWithBranches responses: 200: description: The created resource schema: #/definitions/companyWithBranches default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/companyWithBranches default: description: Error response schema: #/definitions/genericError /entities/companyWithBranches/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companyWithBranches responses: 200: description: Ok schema: #/definitions/companyWithBranches default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companyWithBranches responses: 200: description: Ok schema: #/definitions/companyWithBranches default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyWithBranches default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/companyWithBranches/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/companyWithBranches responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/company: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/company responses: 200: description: The created resource schema: #/definitions/company default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/company responses: 200: description: The created resource schema: #/definitions/company default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/company default: description: Error response schema: #/definitions/genericError /entities/company/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/company default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/company/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/department: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/department responses: 200: description: The created resource schema: #/definitions/department default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/department responses: 200: description: The created resource schema: #/definitions/department default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/department default: description: Error response schema: #/definitions/genericError /entities/department/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/department responses: 200: description: Ok schema: #/definitions/department default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/department responses: 200: description: Ok schema: #/definitions/department default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/department default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/department/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/department responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/employee: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/employee responses: 200: description: The created resource schema: #/definitions/employee default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/employee responses: 200: description: The created resource schema: #/definitions/employee default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/employee default: description: Error response schema: #/definitions/genericError /entities/employee/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employee responses: 200: description: Ok schema: #/definitions/employee default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employee responses: 200: description: Ok schema: #/definitions/employee default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employee default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/employee/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/employee responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/costCenter: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/costCenter responses: 200: description: The created resource schema: #/definitions/costCenter default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/costCenter responses: 200: description: The created resource schema: #/definitions/costCenter default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/costCenter default: description: Error response schema: #/definitions/genericError /entities/costCenter/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/costCenter responses: 200: description: Ok schema: #/definitions/costCenter default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/costCenter responses: 200: description: Ok schema: #/definitions/costCenter default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/costCenter default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/costCenter/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/costCenter responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/address: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/address responses: 200: description: The created resource schema: #/definitions/address default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/address responses: 200: description: The created resource schema: #/definitions/address default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/address default: description: Error response schema: #/definitions/genericError /entities/address/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/address responses: 200: description: Ok schema: #/definitions/address default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/address responses: 200: description: Ok schema: #/definitions/address default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/address default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/address/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/address responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/person: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/person responses: 200: description: The created resource schema: #/definitions/person default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/person responses: 200: description: The created resource schema: #/definitions/person default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/person default: description: Error response schema: #/definitions/genericError /entities/person/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/person responses: 200: description: Ok schema: #/definitions/person default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/person responses: 200: description: Ok schema: #/definitions/person default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/person default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/person/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/person responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /apis/address: post: description: The create request primitive for the address facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/addressFacade responses: 200: description: Ok schema: #/definitions/addressFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the address facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/addressFacade default: description: Error response schema: #/definitions/genericError /apis/address/{id}: put: description: The update request primitive for the address facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/addressFacade responses: 200: description: Ok schema: #/definitions/addressFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the address facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/addressFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the address facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/department: post: description: The create request primitive for the department facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/departmentFacade responses: 200: description: Ok schema: #/definitions/departmentFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the department facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/departmentFacade default: description: Error response schema: #/definitions/genericError /apis/department/{id}: put: description: The update request primitive for the department facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/departmentFacade responses: 200: description: Ok schema: #/definitions/departmentFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the department facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/departmentFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the department facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/company: post: description: The create request primitive for the company facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/companyFacade responses: 200: description: Ok schema: #/definitions/companyFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the company facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/companyFacade default: description: Error response schema: #/definitions/genericError /apis/company/{id}: put: description: The update request primitive for the company facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/companyFacade responses: 200: description: Ok schema: #/definitions/companyFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the company facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the company facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/costCenter: post: description: The create request primitive for the costCenter facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/costCenterFacade responses: 200: description: Ok schema: #/definitions/costCenterFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the costCenter facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/costCenterFacade default: description: Error response schema: #/definitions/genericError /apis/costCenter/{id}: put: description: The update request primitive for the costCenter facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/costCenterFacade responses: 200: description: Ok schema: #/definitions/costCenterFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the costCenter facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/costCenterFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the costCenter facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/employee: post: description: The create request primitive for the employee facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/employeeFacade responses: 200: description: Ok schema: #/definitions/employeeFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the employee facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/employeeFacade default: description: Error response schema: #/definitions/genericError /apis/employee/{id}: put: description: The update request primitive for the employee facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/employeeFacade responses: 200: description: Ok schema: #/definitions/employeeFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the employee facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employeeFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the employee facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/companyWithBranches: post: description: The create request primitive for the companyWithBranches facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/companyWithBranchesFacade responses: 200: description: Ok schema: #/definitions/companyWithBranchesFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the companyWithBranches facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/companyWithBranchesFacade default: description: Error response schema: #/definitions/genericError /apis/companyWithBranches/{id}: put: description: The update request primitive for the companyWithBranches facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/companyWithBranchesFacade responses: 200: description: Ok schema: #/definitions/companyWithBranchesFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the companyWithBranches facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyWithBranchesFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the companyWithBranches facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/person: post: description: The create request primitive for the person facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/personFacade responses: 200: description: Ok schema: #/definitions/personFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the person facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/personFacade default: description: Error response schema: #/definitions/genericError /apis/person/{id}: put: description: The update request primitive for the person facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/personFacade responses: 200: description: Ok schema: #/definitions/personFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the person facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the person facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: genderType: type: string enum: – MALE – FEMALE maritalStatusType: type: string enum: – SINGLE – MARRIED – DIVORCED – WIDOWER – CONCUBINAGE – SEPARATED – STABLE_UNION – OTHER racialType: type: string enum: – NOT_INFORMED – WHITE – BLACK – BROWN – YELLOW – INDIAN emailType: type: string enum: – PERSONAL – PROFESSIONAL phoneContactType: type: string enum: – PERSONAL – PROFESSIONAL – MOBILE – BUSINESS_FAX – PERSONAL_FAX – OTHER disabilityType: type: string enum: – PHYSICAL – HEARING – VISUAL – MENTAL – INTELLECTUAL – OTHER companyType: type: string enum: – BRANCH_OFFICE – HEAD_OFFICE – WORK – TEMPORARY – WORK_COOPERATIVE – DOMESTIC_WORKER – EMPLOYER_ESOCIAL contractType: type: string enum: – EMPLOYEE – MANAGER – FARM_WORKER – RETIRED – TRAINEE – APRENDIZ – FIXED_DUE_DATE – RETIRED_MANAGER – PUBLIC_AGENT – TEACHER – COOPERATIVE_WORKER – DOMESTIC_WORKER – TEACHER_FIXED_DUE_DATE – THIRD_PARTY employeeType: type: string enum: – EMPLOYEE – THIRDPARTY – PARTNER employmentRelationshipType: type: string enum: – EMPREGADO_GERAL – EMPREGADO_TRABALHADOR_RURAL_POR_PEQUENO_PRAZO_DA_LEI_11_718_2008 – EMPREGADO_APRENDIZ – EMPREGADO_DOMESTICO – EMPREGADO_CONTRATO_A_TERMO_FIRMADO_NOS_TERMOS_DA_LEI_9601_98 – TRABALHADOR_TEMPORARIO_CONTRATO_NOS_TERMOS_DA_LEI_6019_74 – EMPREGADO_CONTRATO_DE_TRABALHO_VERDE_E_AMARELO_SEM_ACORDO_PARA_ANTECIPACAO_MENSAL_DA_MULTA_RESCISORIA_DO_FGTS – EMPREGADO_CONTRATO_DE_TRABALHO_VERDE_E_AMARELO_COM_ACORDO_PARA_ANTECIPACAO_MENSAL_DA_MULTA_RESCISORIA_DO_FGTS – EMPREGADO_CONTRATO_DE_TRABALHO_INTERMITENTE – TRABALHADOR_AVULSO_PORTUARIO – TRABALHADOR_AVULSO_NAO_PORTUARIO – SERVIDOR_PUBLICO_TITULAR_DE_CARGO_EFETIVO_MAGISTRADO_MINISTRO_DE_TRIBUNAL_DE_CONTAS_CONSELHEIRO_DE_TRIBUNAL_CONTAS_E_MEMBRO_DO_MINISTERIO_PUBLICO – SERVIDOR_PUBLICO_OCUPANTE_DE_CARGO_EXCLUSIVO_EM_COMISSAO – EXERCENTE_DE_MANDATO_ELETIVO – SERVIDOR_PUBLICO_EXERCENTE_DE_MANDATO_ELETIVO_INCLUSIVE_COM_EXERCICIO_DE_CARGO_EM_COMISSAO – SERVIDOR_PUBLICO_INDICADO_PARA_CONSELHO_OU_ORGAO_REPRESENTATIVO_NA_CONDICAO_DE_REPRESENTANTE_DO_GOVERNO_ORGAO_OU_ENTIDADE_DA_ADMINISTRACAO_PUBLICA – SERVIDOR_PUBLICO_CONTRATADO_POR_TEMPO_DETERMINADO_SUJEITO_A_REGIME_ADMINISTRATIVO_ESPECIAL_DEFINIDO_EM_LEI_PROPRIA – MILITAR – CONSCRITO – AGENTE_PUBLICO_OUTROS – SERVIDOR_PUBLICO_EVENTUAL – MINISTROS_JUIZES_PROCURADORES_PROMOTORES_OU_OFICIAIS_DE_JUSTICA_A_DISPOSICAO_DA_JUSTICA_ELEITORAL – AUXILIAR_LOCAL – SERVIDOR_PUBLICO_EXERCENTE_DE_ATIVIDADE_DE_INSTRUTORIA_CAPACITACAO_TREINAMENTO_CURSO_OU_CONCURSO_OU_CONVOCADO_PARA_PARECERES_TECNICOS_OU_DEPOIMENTOS – DIRIGENTE_SINDICAL_INFORMACAO_PRESTADA_PELO_SINDICATO – TRABALHADOR_CEDIDO_EXERCICIO_EM_OUTRO_ORGAO_JUIZ_AUXILIAR_INFORMACAO_PRESTADA_PELO_CESSIONARIO_DESTINO – CONTRIBUINTE_INDIVIDUAL_AUTONOMO_EM_GERAL_EXCETO_SE_ENQUADRADO_EM_UMA_DAS_DEMAIS_CATEGORIAS_DE_CONTRIBUINTE_INDIVIDUAL – CONTRIBUINTE_INDIVIDUAL_TRANSPORTADOR_AUTONOMO_DE_PASSAGEIROS – CONTRIBUINTE_INDIVIDUAL_TRANSPORTADOR_AUTONOMO_DE_CARGA – CONTRIBUINTE_INDIVIDUAL_DIRETOR_NAO_EMPREGADO_COM_FGTS – CONTRIBUINTE_INDIVIDUAL_DIRETOR_NAO_EMPREGADO_SEM_FGTS – CONTRIBUINTE_INDIVIDUAL_EMPRESARIOS_SOCIOS_E_MEMBRO_DE_CONSELHO_DE_ADMINISTRACAO_OU_FISCAL – CONTRIBUINTE_INDIVIDUAL_COOPERADO_QUE_PRESTA_SERVICOS_A_EMPRESA_POR_INTERMEDIO_DE_COOPERATIVA_DE_TRABALHO – CONTRIBUINTE_INDIVIDUAL_TRANSPORTADOR_COOPERADO_QUE_PRESTA_SERVICOS_POR_INTERMEDIO_DE_COOPERATIVA_DE_TRABALHO – CONTRIBUINTE_INDIVIDUAL_COOPERADO_FILIADO_A_COOPERATIVA_DE_PRODUCAO – CONTRIBUINTE_INDIVIDUAL_MICRO_EMPREENDEDOR_INDIVIDUAL – CONTRIBUINTE_INDIVIDUAL_MAGISTRADO_CLASSISTA_TEMPORARIO_DA_JUSTICA_DO_TRABALHO_OU_DA_JUSTICA_ELEITORAL_QUE_SEJA_APOSENTADO_DE_QUALQUER_REGIME_PREVIDENCIARIO – CONTRIBUINTE_INDIVIDUAL_ASSOCIADO_ELEITO_PARA_DIRECAO_DE_COOPERATIVA_ASSOCIACAO_OU_ENTIDADE_DE_CLASSE_DE_QUALQUER_NATUREZA_OU_FINALIDADE_BEM_COMO_O_SINDICO_OU_ADM_DESDE_QUE_RECEBAM_REMUNERACAO – CONTRIBUINTE_INDIVIDUAL_MEMBRO_DE_CONSELHO_TUTELAR_NOS_TERMOS_DA_LEI_N_8_069_DE_13_DE_JULHO_DE_1990 – MINISTRO_DE_CONFISSAO_RELIGIOSA_OU_MEMBRO_DE_VIDA_CONSAGRADA_DE_CONGREGACAO_OU_DE_ORDEM_RELIGIOSA – ESTAGIARIO – MEDICO_RESIDENTE – BOLSISTA_NOS_TERMOS_DA_LEI_8958_1994 – PARTICIPANTE_DE_CURSO_DE_FORMACAO_COMO_ETAPA_DE_CONCURSO_PUBLICO_SEM_VINCULO_DE_EMPREGO_ESTATUTARIO – ATLETA_NAO_PROFISSIONAL_EM_FORMACAO_QUE_RECEBA_BOLSA – BENEFICIARIO_ENTE_PUBLICO – BENEFICIARIO_ENTE_PUBLICO_SOMENTE_CADASTRO_BENEFICIO – DEMITIDO_COM_DATA_ANTERIOR_A_SUCESSAO_CATEGORIA_EXCLUSIVA_SENIOR – NAO_SE_APLICA stabilityType: type: string enum: – NOT_STABLE – ELECTED_CIPA – WORK_ACCIDENT – MATERNITY_ASSISTANCE – MILITARY_SERVICE – UNION_MANDATE – GOVERNMENT_EMPLOYEE – RETURN_HOLIDAYS – SICK_PAY – NEAR_RETIREMENT – COLLECTIVE_AGREEMENT – PREVIOUS_TIME_FGTS_OPTION – NOT_OPTING_FGTS – CIPA_EMPLOYER – MEMBER_OF_COMISSION_FOR_PRIOR_CONCILIATION – MEMBER_OF_FGTS_CURATOR_COUNCIL – MEMBER_OF_NATIONAL_COUNCIL_OF_SOCIAL_SECURITY – EDUCATION_AID – CONSUMER_COOPERATIVE – CREDIT_UNION – PERSON_WITH_DISABILITY – COOPERATIVE_OF_SYNDICATE – CIPATR – PATERNITY_LEAVE – ELECTORAL_MANDATE – CIPA_CANDIDATE – ELECT_ALTERNATE_CIPA – OTHER – ELECTED_EMPLOYEE_REPRESENTATIVES_COMMITTEE – JOURNEY_REDUCTION_COVID_19_25_50 – JOURNEY_REDUCTION_COVID_19_50_70 – JOURNEY_REDUCTION_COVID_19_70 – TEMPORARY_SUSPENSION_COVID_19 – GESTATION_PERIOD person: type: object required: – firstname – lastname – socialName – nickname – gender – maritalstatus – race – nationality – educationDegree properties: id: type: string description: ID da Pessoa firstname: type: string description: Primeiro nome da pessoa middlename: type: string description: Segundo nome da pessoa lastname: type: string description: Último nome da pessoa (Sobrenome) socialName: type: string description: Nome social nickname: type: string description: Apelido da pessoa fullName: type: string description: Nome completo da pessoa birthday: type: string description: Data de nascimento da pessoa format: date gender: #/definitions/genderType maritalstatus: #/definitions/maritalStatusType race: #/definitions/racialType cpf: type: string description: CPF (Cadastro de Pessoas Físicas) da pessoa nis: type: array items: #/definitions/nisRecord description: Programa Integração Social (pis) emails: type: array items: #/definitions/emailRecord description: E-mails da pessoa nationality: #/definitions/nationalityRecord naturality: #/definitions/cityRecord educationDegree: #/definitions/educationDegreeRecord phoneContact: type: array items: #/definitions/phoneContactRecord description: Contato telefônico addresses: type: array items: type: string description: ID do endereço da pessoa disabilities: type: array items: #/definitions/personDisabilityRecord description: Deficiências nisRecord: type: object properties: id: type: string description: Id do documento number: type: string description: Número do documento registrationDate: type: string description: Data de registro do documento format: date emailRecord: type: object required: – email – emailType properties: id: type: string description: ID do email email: type: string description: Email da pessoa emailType: #/definitions/emailType nationalityRecord: type: object properties: id: type: string description: ID Nacionalidade name: type: string description: Nome Nacionalidade code: type: integer description: Código G5 cityRecord: type: object required: – name – state – code properties: id: type: string description: ID da Cidade name: type: string description: Nome da Cidade state: #/definitions/stateRecord code: type: integer description: Código G5 stateRecord: type: object required: – abbreviation – name – code properties: id: type: string description: ID do Estado abbreviation: type: string description: Sigla name: type: string description: Nome do Estado code: type: integer description: Código G5 educationDegreeRecord: type: object properties: id: type: string description: ID grau de educação name: type: string description: Nome Grau de Educação code: type: integer description: Código de Grau de Instrução phoneContactRecord: type: object required: – carrier – countryCode – localCode – number – extention – phoneContactType properties: id: type: string description: ID do telefone de contato carrier: type: string description: Operador countryCode: type: integer description: Código do País localCode: type: integer description: DDD number: type: string description: Número extention: type: string description: extensão phoneContactType: #/definitions/phoneContactType personDisabilityRecord: type: object required: – disability – mainDisability – isRehabilitated – dateWhen properties: id: type: string description: ID da entidade disability: #/definitions/disabilityRecord mainDisability: type: boolean description: Deficiência principal isRehabilitated: type: boolean description: é uma pessoa reabilitada dateWhen: type: string description: Data da deficiência format: date disabilityRecord: type: object required: – code – name – type properties: id: type: string description: ID da entidade code: type: integer description: Código da deficiência name: type: string description: Nome da deficiência type: #/definitions/disabilityType address: type: object required: – address – additional – neighborhood – city – person properties: id: type: string description: ID do endereço address: type: string description:
Logradouro/Rua a qual pertence este endereço additional: type: string description: Informação adicional referente ao endereço. (e.g. Número do apartamento, Bloco do residencial, Ponto de referência) neighborhood: type: string description: Bairro/Distrito a qual pertence este endereço city: #/definitions/cityRecord person: type: string description: ID da pessoa com esse endereço company: type: object properties: id: type: string description: ID da empresa numemp: type: integer description: Código da empresa tradingName: type: string description: Nome Social companyName: type: string description: Nome da Empresa cnpj: type: string description: CNPJ companyType: #/definitions/companyType cnae: type: string description: CNAE da empresa address: #/definitions/addressRecord headquarter: #/definitions/companyRecord addressRecord: type: object required: – additional – neighborhood – address – city properties: id: type: string description: ID do endereço additional: type: string description: Informação adicional referente ao endereço. (e.g. Número do apartamento, Bloco do residencial, Ponto de referência) neighborhood: type: string description: Bairro/Distrito a qual pertence este endereço address: type: string description: Logradouro/Rua a qual pertence este endereço city: #/definitions/cityRecord companyRecord: type: object properties: id: type: string description: ID da empresa numemp: type: integer description: Código da empresa tradingName: type: string description: Nome Social companyName: type: string description: Nome da Empresa cnpj: type: string description: CNPJ companyType: #/definitions/companyType cnae: type: string description: CNAE da empresa address: #/definitions/addressRecord headquarter: #/definitions/companyRecord companyWithBranches: type: object properties: id: type: string description: ID da matriz numemp: type: integer description: Código da matriz tradingName: type: string description: Nome fantasia da matriz companyName: type: string description: Nome da matriz cnpj: type: string description: CNPJ companyType: #/definitions/companyType cnae: type: string description: CNAE da matriz address: #/definitions/addressRecord companyBranches: type: array items: #/definitions/companyBranchesRecord description: Filiais companyBranchesRecord: type: object properties: id: type: string description: ID da filial numemp: type: integer description: Código da filial tradingName: type: string description: Nome fantasia da filial companyName: type: string description: Nome da filial cnpj: type: string description: CNPJ companyType: #/definitions/companyType cnae: type: string description: CNAE da filial address: #/definitions/addressRecord employee: type: object required: – contractType – hireDate – dismissalDate – employeeType – employmentrelationshiptype – jobPosition – department – costCenter – workShift – workstation properties: id: type: string description: ID do Colaborador contractType: #/definitions/contractType hireDate: type: string description: Data de admissão format: date dismissalDate: type: string description: Data de demissão format: date employeeType: #/definitions/employeeType registerNumber: type: integer description: Número da matrícula na G5 (numcad) employmentrelationshiptype: #/definitions/employmentRelationshipType jobPosition: #/definitions/jobPositionRecord department: #/definitions/departmentRecord costCenter: #/definitions/costCenterRecord workShift: #/definitions/workShiftRecord employer: #/definitions/companyRecord person: #/definitions/personRecord phoneContact: type: array items: #/definitions/phoneContactRecord description: Contato telefônico emails: type: array items: #/definitions/employeeEmailRecord description: Emails vinculado ao colaborador workstation: #/definitions/workstationRecord historicStability: type: array items: #/definitions/historicStabilityRecord description: Histórico de estabilidade jobPositionRecord: type: object required: – codcar properties: id: type: string description: ID do Cargo name: type: string description: Nome do cargo codcar: type: string description: Código do Cargo departmentRecord: type: object properties: id: type: string description: ID Departamento tableCode: type: integer description: Tabela de organograma position: type: string description: Posição address: #/definitions/addressRecord code: type: string description: Código G5 do departamento/local (codloc) name: type: string description: Nome do departamento creationDate: type: string description: Data de criação format: date expirationDate: type: string description: Data de expiração format: date historicExpirationDate: type: string description: Histórico data de expiração format: date costCenterRecord: type: object required: – codccu properties: id: type: string description: ID da entidade name: type: string description: Nome do centro de custo codccu: type: string description: Código do centro de custo descriptionCode: type: string description: Descrição do código creationDate: type: string description: Data de criação format: date expirationDate: type: string description: Data de expiração format: date company: #/definitions/companyRecord workShiftRecord: type: object required: – name – codesc – workload properties: id: type: string description: ID do turno name: type: string description: Descrição do turno codesc: type: integer description: Código do turno workload: type: integer description: Carga horária do turno (em min/mês) personRecord: type: object required: – firstname – lastname – socialName – nickname – fullName – gender – maritalstatus – race – nationality – naturality – educationDegree properties: id: type: string description: ID da Pessoa firstname: type: string description: Primeiro nome da pessoa middlename: type: string description: Segundo nome da pessoa lastname: type: string description: Último nome da pessoa (Sobrenome) socialName: type: string description: Nome social nickname: type: string description: Apelido da pessoa fullName: type: string description: Nome completo birthday: type: string description: Data de nascimento da pessoa format: date gender: #/definitions/genderType maritalstatus: #/definitions/maritalStatusType race: #/definitions/racialType cpf: type: string description: CPF (Cadastro de Pessoas Físicas) da pessoa nis: type: array items: #/definitions/nisRecord description: Programa Integração Social (pis) emails: type: array items: #/definitions/emailRecord description: E-mails da pessoa nationality: #/definitions/nationalityRecord naturality: #/definitions/cityRecord educationDegree: #/definitions/educationDegreeRecord phoneContact: type: array items: #/definitions/phoneContactRecord description: Contato telefônico address: type: array items: #/definitions/addressRecord description: ID do endereço da pessoa disabilities: type: array items: #/definitions/personDisabilityRecord description: Deficiências employeeEmailRecord: type: object required: – id – email properties: id: type: string description: ID do email email: type: string description: E-mail da pessoal vinculada workstationRecord: type: object required: – id – workstationGroup properties: id: type: string description: ID da entidade workstationGroup: #/definitions/workstationGroupRecord hierarchyItem: #/definitions/hierarchyItemRecord workstationGroupRecord: type: object required: – id – postra properties: id: type: string description: ID da entidade name: type: string description: Nome do grupo de trabalho postra: type: string description: Código do posto de Trabalho hierarchyItemRecord: type: object required: – id – parent properties: id: type: string description: ID do item parent: #/definitions/hierarchyItemRecord historicStabilityRecord: type: object required: – id – startDate – endDate – stabilityType properties: id: type: string description: Identificador do histórico de estabilidade startDate: type: string description: Data de início da estabilidade format: date endDate: type: string description: Data final da estabilidade format: date stabilityType: #/definitions/stabilityType department: type: object properties: id: type: string description: ID Departamento tableCode: type: integer description: Tabela de organograma code: type: string description: Código G5 do departamento/local (codloc) position: type: string description: Posição name: type: string description: Nome do departamento creationDate: type: string description: Data de criação format: date expirationDate: type: string description: Data de expiração format: date historicExpirationDate: type: string description: Histórico data de expiração format: date address: #/definitions/addressRecord costCenter: type: object properties: id: type: string description: Id Centro de Custo name: type: string description: Nome do centro de custo codccu: type: string description: Código do centro de custo descriptionCode: type: string description: Descrição código creationDate: type: string description: Data de criação format: date expirationDate: type: string description: Data de expiração format: date company: #/definitions/companyRecord addressFacade: type: object required: – address – additional – neighborhood – city – person properties: id: type: string description: ID do endereço address: type: string description:
Logradouro/Rua a qual pertence este endereço additional: type: string description: Informação adicional referente ao endereço. (e.g. Número do apartamento, Bloco do residencial, Ponto de referência) neighborhood: type: string description: Bairro/Distrito a qual pertence este endereço city: #/definitions/cityRecord person: type: string description: ID da pessoa com esse endereço companyFacade: type: object properties: id: type: string description: ID da empresa numemp: type: integer description: Código da empresa tradingName: type: string description: Nome Social companyName: type: string description: Nome da Empresa cnpj: type: string description: CNPJ companyType: #/definitions/companyType cnae: type: string description: CNAE da empresa address: #/definitions/addressRecord headquarter: #/definitions/companyRecord companyWithBranchesFacade: type: object properties: id: type: string description: ID da matriz numemp: type: integer description: Código da matriz tradingName: type: string description: Nome fantasia da matriz companyName: type: string description: Nome da matriz cnpj: type: string description: CNPJ companyType: #/definitions/companyType cnae: type: string description: CNAE da matriz address: #/definitions/addressRecord companyBranches: type: array items: #/definitions/companyBranchesRecord description: Filiais costCenterFacade: type: object properties: id: type: string description: Id Centro de Custo name: type: string description: Nome do centro de custo codccu: type: string description: Código do centro de custo descriptionCode: type: string description: Descrição código creationDate: type: string description: Data de criação format: date expirationDate: type: string description: Data de expiração format: date company: #/definitions/companyRecord departmentFacade: type: object properties: id: type: string description: ID Departamento tableCode: type: integer description: Tabela de organograma code: type: string description: Código G5 do departamento/local (codloc) position: type: string description: Posição name: type: string description: Nome do departamento creationDate: type: string description: Data de criação format: date expirationDate: type: string description: Data de expiração format: date historicExpirationDate: type: string description: Histórico data de expiração format: date address: #/definitions/addressRecord employeeFacade: type: object required: – contractType – hireDate – dismissalDate – employeeType – employmentrelationshiptype – jobPosition – department – costCenter – workShift – workstation properties: id: type: string description: ID do Colaborador contractType: #/definitions/contractType hireDate: type: string description: Data de admissão format: date dismissalDate: type: string description: Data de demissão format: date employeeType: #/definitions/employeeType registerNumber: type: integer description: Número da matrícula na G5 (numcad) employmentrelationshiptype: #/definitions/employmentRelationshipType jobPosition: #/definitions/jobPositionRecord department: #/definitions/departmentRecord costCenter: #/definitions/costCenterRecord workShift: #/definitions/workShiftRecord employer: #/definitions/companyRecord person: #/definitions/personRecord phoneContact: type: array items: #/definitions/phoneContactRecord description: Contato telefônico emails: type: array items: #/definitions/employeeEmailRecord description: Emails vinculado ao colaborador workstation: #/definitions/workstationRecord historicStability: type: array items: #/definitions/historicStabilityRecord description: Histórico de estabilidade personFacade: type: object required: – firstname – lastname – socialName – nickname – gender – maritalstatus – race – nationality – educationDegree properties: id: type: string description: ID da Pessoa firstname: type: string description: Primeiro nome da pessoa middlename: type: string description: Segundo nome da pessoa lastname: type: string description: Último nome da pessoa (Sobrenome) socialName: type: string description: Nome social nickname: type: string description: Apelido da pessoa fullName: type: string description: Nome completo da pessoa birthday: type: string description: Data de nascimento da pessoa format: date gender: #/definitions/genderType maritalstatus: #/definitions/maritalStatusType race: #/definitions/racialType cpf: type: string description: CPF (Cadastro de Pessoas Físicas) da pessoa nis: type: array items: #/definitions/nisRecord description: Programa Integração Social (pis) emails: type: array items: #/definitions/emailRecord description: E-mails da pessoa nationality: #/definitions/nationalityRecord naturality: #/definitions/cityRecord educationDegree: #/definitions/educationDegreeRecord phoneContact: type: array items: #/definitions/phoneContactRecord description: Contato telefônico addresses: type: array items: type: string description: ID do endereço da pessoa disabilities: type: array items: #/definitions/personDisabilityRecord description: Deficiências genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE