2.0info: 1.9.2 papeisfiliais x-senior-domain: tms x-senior-domain-path: tms x-senior-service-path: papeisfiliais contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/tmssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /papeisfiliais/queries/buscarFiliaisPapel: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: dsErro: type: string description: listaResultado: type: array items: type: object allOf: #/definitions/recMCEPAPFL minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idPapel description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: dsErro: type: string description: listaResultado: type: array items: type: object allOf: #/definitions/recMCEPAPFL minimum: 1 description: default: description: Error response schema: #/definitions/genericError /papeisfiliais/queries/buscarPermissaoPapel: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: idPapel: type: string description: idUsuario: type: string description: responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: dsErro: type: string description: resultado: type: object allOf: #/definitions/recMCEPAPPE description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idPapel description: in: query type: string – name: idUsuario description: in: query type: string responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: dsErro: type: string description: resultado: type: object allOf: #/definitions/recMCEPAPPE description: default: description: Error response schema: #/definitions/genericError /papeisfiliais/queries/buscarPermissaoPapelUsuarioLogado: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: dsErro: type: string description: resultado: type: object allOf: #/definitions/recMCEPAPPE description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: dsErro: type: string description: resultado: type: object allOf: #/definitions/recMCEPAPPE description: default: description: Error response schema: #/definitions/genericError /papeisfiliais/queries/buscarFiliaisUsuario: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idUsuario properties: idUsuario: type: string description: carregaDepDefinicoes: type: boolean description: responses: 200: description: Ok schema: type: object required: – ok – dsErro – filiais properties: ok: type: boolean description: dsErro: type: string description: filiais: type: array items: type: object allOf: #/definitions/recFilialCompl minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idUsuario description: in: query required: true type: string – name: carregaDepDefinicoes description: in: query type: boolean responses: 200: description: Ok schema: type: object required: – ok – dsErro – filiais properties: ok: type: boolean description: dsErro: type: string description: filiais: type: array items: type: object allOf: #/definitions/recFilialCompl minimum: 1 description: default: description: Error response schema: #/definitions/genericError /papeisfiliais/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /papeisfiliais/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /papeisfiliais/actions/inserirMCEPAPFL: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idPapel – nrCNPJ properties: idPapel: type: string description: nrCNPJ: type: string description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /papeisfiliais/actions/inserirFiliaisPapel: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: inPermAltRoteirizacao: type: integer format: int64 description: inPermAltRestricao: type: integer format: int64 description: inPermAltRotaExec: type: integer format: int64 description: inPermiteFinRotSemOcorr: type: integer format: int64 description: inPermAltEmpresa: type: integer format: int64 description: filiais: type: array items: type: object allOf: #/definitions/recFilial description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /papeisfiliais/actions/deletarMCEPAPFL: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idPapel – nrCNPJ properties: idPapel: type: string description: nrCNPJ: type: string description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /papeisfiliais/actions/deletarFiliaisPapel: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /papeisfiliais/actions/deletarPapeisFilial: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJ properties: nrCNPJ: type: string description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /papeisfiliais/actions/inicializaPapelPadrao: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError definitions: userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT recFilial: description: type: object required: – nrCNPJ properties: nrCNPJ: type: string description: recFilialCompl: description: type: object properties: cdEmpresa: type: integer format: int64 description: nrCNPJ: type: string description: inTpFilial: type: integer format: int64 description: dsFilial: type: string description: dsEndereco: type: string description: nrCEP: type: integer format: int64 description: nrTelefone: type: string description: dsLatitude: type: string description: dsLongitude: type: string description: definicoes: type: object allOf: #/definitions/MCEDEFRec description: MCEDEFRec: description: type: object required: – nrCNPJFilial – qtTempoAtendPad – qtTempoAlertaAtraso – qtTempoAltRotExec – inConsQtMinAtv – inConsOcupMinVeic – inFatorTrafego properties: nrCNPJFilial: type: string description: hrCorte: type: string format: date-time description: qtTempoAtendPad: type: string format: date-time description: qtTempoAlertaAtraso: type: string format: date-time description: qtTempoAltRotExec: type: string format: date-time description: inConsQtMinAtv: type: integer format: int64 description: inConsOcupMinVeic: type: integer format: int64 description: inConsJornadaTrab: type: integer format: int64 description: inConsJanela: type: integer format: int64 description: inRestricaoDestino: type: integer format: int64 description: inRestricaoRegiao: type: integer format: int64 description: inRestricaoOperacao: type: integer format: int64 description: inRestricaoTpCarga: type: integer format: int64 description: vlGasolina: type: number format: double description: vlEtanol: type: number format: double description: vlDiesel: type: number format: double description: vlGnv: type: number format: double description: inFatorTrafego: type: integer format: int64 description: inSegundaUtil: type: integer format: int64 description: inTercaUtil: type: integer format: int64 description: inQuartaUtil: type: integer format: int64 description: inQuintaUtil: type: integer format: int64 description: inSextaUtil: type: integer format: int64 description: inSabadoUtil: type: integer format: int64 description: inDomingoUtil: type: integer format: int64 description: inRoteirizacao: type: integer format: int64 description: inPermiteRoteirizar: type: integer format: int64 description: inPermiteRoteirizacaoExterna: type: integer format: int64 description: inPermiteFinRotSemOcorr: type: integer format: int64 description: recMCEPAPFL: description: type: object required: – idPapel – nrCNPJ properties: idPapel: type: string description: nrCNPJ: type: string description: recMCEPAPPE: description: type: object required: – idPapel properties: idPapel: type: string description: inPermAltRoteirizacao: type: integer format: int64 description: inPermAltRestricao: type: integer format: int64 description: inPermAltRotaExec: type: integer format: int64 description: inPermiteFinRotSemOcorr: type: integer format: int64 description: inPermAltEmpresa: type: integer format: int64 description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service 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