SIP2 Messages

O BNWeb suporta comunicação por mensagens SIP2 de acordo com as definições do protocolo SIP2. Logo a seguir estão detalhados todas as mensagens suportadas e seus campos. Note que há descrições que de campos que não são suportados pelo BNWeb:

Serviço Campo ID Descrição
Empréstimo (11)
11NN20101005 08062920101021 030629AOBC|AActy|ADCty123|AB6
scRenewalPolicy Y/N – Indica se permite a renovação do empréstimo no caso do registro já esteja emprestado com o usuário
noBlock Não suportado
transactionDate Data atual da transação
nbDueDate Não suportado
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
itemIdentifier AB Código do registro fornecido pelo BNWeb
terminalPassword AC Não suportado
itemProperties CH Não suportado
patronPassword AD Senha da matrícula do usuário fornecida pelo BNWeb
feeAcknowledged BO Não suportado
cancel BI Não suportado pois poderá criar conflito nos mecanismos de reserva, espera e e-mails
Resposta do Empréstimo (12)
121NUY20190411 020627AOBC|AActy|AB6|AJ4|AH20190418 000000|BT04|CIY|BHBRD|BV0,49|CK001|BK2031|AFEmpréstimo realizado com sucesso!
Ok 1/0 – indica se o empréstimo ou a renovação foi realizada com sucesso
renewalOk Y/N – indica se a renovação foi realizada com sucesso no caso do registro já esteja emprestado com o usuário e que o campo scRenewalPolicy seja igual a ‘Y’
magenticMedia Não suportado
desensitize Y/N – indica se o item pode ser removido da biblioteca
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb na qual foi realizado o empréstimo ou a renovação
itemIdentifier AB Código do registro fornecido pelo BNWeb
titleIdentifier AJ Código do acervo fornecido pelo BNWeb
dueDate AH Data de previsão da devolução
feeType BT 04 – (Multa por atraso)
securityInhibit CI Y – (Herança segura)
currencyType BH BRD – (Tipo de moeda brasileira)
feeAmount BV Total de multas do usuário
mediaType CK Tipo de material de acordo com SIP2
itemProperties CH Não suportado
transactionId BK Não suportado
screenMessage AF Mensagem descritiva para indicar o status da execução do serviço
printLine AG Não suportado
Serviço Campo ID Descrição
Devolução (09)
09N20100930 09384820100930 093848AP|AOBC|AB6
noBlock Não suportado
transactionDate Data atual da transação
returnDate Não suportado
currentLocation AP Não suportado
institutionId AO Sigla da unidade da instituição
Ex.: BC
itemIdentifier AB Código do registro fornecido pelo BNWeb
terminalPassword AC Não suportado
itemProperties CH Não suportado
cancel BI Não suportado pois poderá criar conflito nos mecanismos de reserva, espera e e-mails
Resposta da Devolução (10)
101YUN20190411 020726AOBC|AB6|AQBC|AJ4|AActy|CK001|AFDevolução realizada com sucesso!
ok 1/0 – indica se a devolução foi realizada com sucesso
resensitize Y/N – indica se o item não pode ser removido da biblioteca
magneticMedia U – (Media magnética não identificada)
alert Y/N – indica se vai ser realizado um alerta sonoro ou não em caso de falha na devolução
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
itemIdentifier AB Código do registro fornecido pelo BNWeb
permanentLocation AQ Sigla da unidade na qual o registro pertence
titleIdentifier AJ Código do acervo fornecido pelo BNWeb
sortBin CL Não suportado
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb na qual foi realizado a devolução
mediaType CK Tipo de material de acordo com SIP2
itemProperties CH Não suportado
screenMessage AF Mensagem descritiva para indicar o status da execução do serviço
printLine AG Não suportado
Serviço Campo ID Descrição
Informação do Item (17)
1720190409 105900AOBC|AB6
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
itemIdentifier AB Código do registro fornecido pelo BNWeb
terminalPassword AC Não suportado
Resposta da Informação do Item (18)
1803000420190411 020849AB6|AJ4|BGBC|BHBRD|CK001|AQBC|APBC|AFRegistro Disponível
circulationStatus 01 – Indica se o registro não está disponível por outros motivos
03 – Indica se o registro está disponível
04 – Indica se o registro está emprestado
securityMarker 00 – Outros
feeType 04 – (Multa por atraso)
transactionDate Data atual da transação
holdQueueLength CF Não suportado
dueDate AH Não suportado
recallDate CJ Não suportado
holdPickupDate CM Não suportado
itemIdentifier AB Código do registro fornecido pelo BNWeb
titleIdentifier AJ Código do acervo fornecido pelo BNWeb
owner BG Sigla da unidade na qual o registro pertence
currencyType BH BRD – (Tipo de moeda brasileira)
feeAmount BV Não suportado
mediaType CK Tipo de material de acordo com SIP2
permanentLocation AQ Sigla da unidade na qual o registro pertence
currentLocation AP Sigla da unidade na qual o registro encontra-se no momento
itemProperties CH Não suportado
screenMessage AF Mensagem descritiva para indicar o status da execução do serviço
printLine AG Não suportado
Serviço Campo ID Descrição
Status do Usuário (23)
2300020100930 093848AOBC|AActy|ADCty123
language Não suportado
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
terminalPassword AC Não suportado
patronPassword AD Senha da matrícula do usuário fornecida pelo BNWeb
Resposta do Status do Usuário (24)
24 00020190411 021110AOBC|AActy|AEUsuário Contempory|BLY|CQY|BHBRD|BV0,49|AFMatrícula [cty] localizada.
patronStatus Posições suportadas:
0 – Empréstimo (N se o usuário estiver com status diferente de normal)
1 – Renovação (N se o usuário estiver com status diferente de normal)
2 – Solicitar a mensagem anterior
3 – Reserva (N se o usuário estiver com status diferente de normal)
10,11 – Multas
language Não suportado
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
personalName AE Nome do usuário fornecido pelo BNWeb
validPatron BL Y/N – Indica se é um usuário válido
validPatronPassword CQ Y/N – Indica se a senha é válida
currencyType BH BRD – (Tipo de moeda brasileira)
feeAmount BV Total de multas do usuário
screenMessage AF Mensagem descritiva para indicar o status da execução do serviço
printLine AG Não suportado
Serviço Campo ID Descrição
Renovação (29)
29YN20110217 07542120110224 075421AOBC|AActy|AB6|ADCty123
thirdPartyAllowed Não suportado
noBlock Não suportado
transactionDate Data atual da transação
nbDueDate Não suportado
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
patronPassword AD Senha da matrícula do usuário fornecida pelo BNWeb
itemIdentifier AB Código do registro fornecido pelo BNWeb
titleIdentifier AJ Não suportado
terminalPassword AC Não suportado
itemProperties CH Não suportado
feeAcknowledged BO Não suportado
Resposta da Renovação (30)
301YUY20190411 021404AOBC|AActy|AB6|AJ4|AH20190418 000000|BT04|CIY|BHBRD|BV0,49|CK001|BK2032|AFRenovação realizada com sucesso!
Ok 0/1 – Indica se a renovação foi realizada com sucesso
renewalOk Y/N – Indica se a renovação já foi realizada
magenticMedia U – (Media magnética não identificada)
desensitize Y/N – indica se o item pode ser removido da biblioteca
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
itemIdentifier AB Código do registro fornecido pelo BNWeb
titleIdentifier AJ Código do acervo fornecido pelo BNWeb
dueDate AH Data de previsão da devolução
feeType BT 04 – (Multa por atraso)
securityInhibit CI Y – (Herança segura)
currencyType BH BRD – (Tipo de moeda brasileira)
feeAmount BV Total de multas do usuário
mediaType CK Tipo de material de acordo com SIP2
itemProperties CH Não suportado
transactionId BK Código da operação de renovação
screenMessage AF Mensagem descritiva para indicar o status da execução do serviço
printLine AG Não suportado
Serviço Campo ID Descrição
Informação do Usuário (63)
6300020101004 093848 Y AOBC|AActy|ADCty123
language Não suportado
transactionDate Data atual da transação
summary Somente uma das posições suportadas são permitidas por vez:
0 – Reservados
1 – Empréstimos em atraso
2 – Empréstimos em aberto
3 – Empréstimos com multas em aberto
4 – Empréstimos renovados em aberto
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
terminalPassword AC Não suportado
patronPassword AD Senha da matrícula do usuário fornecida pelo BNWeb
startItem BP Não suportado
endItem BQ Não suportado
Resposta da Informação do Usuário (64)
64 00020190411 021741 0001 AOBC|AActy|AEUsuário Contempory|BLY|CQY|BHBRD|BV0,49|AU6|BDRua Brasil, 123.|BEcty@cty.com
patronStatus Posições suportadas:
0 – Empréstimo (N se o usuário estiver com status diferente de normal)
1 – Renovação (N se o usuário estiver com status diferente de normal)
2 – Solicitar a mensagem anterior
3 – Reserva (N se o usuário estiver com status diferente de normal)
10,11 – Multas
language Não suportado
transactionDate Data atual da transação
holdItemsCount Total de reservados do usuário
overdueItemsCount Total de empréstimos atrasados do usuário
chargedItemsCount Total de empréstimos em aberto do usuário
fineItemsCount Total de empréstimos com multas em aberto do usuário
recallItemsCount Total de empréstimos renovados em aberto do usuário
unavailableHoldsCount Não suportado
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
personalName AE Nome do usuário fornecido pelo BNWeb
holdItemsLimit AE Não suportado
overdueItemsLimit CA Não suportado
chargedItemsLimit CB Não suportado
validPatron BL Y/N – Indica se é um usuário válido
validPatronPassword CQ Y/N – Indica se a senha é válida
currencyType BH BRD – (Tipo de moeda brasileira)
feeAmount BV Total de multas do usuário
feeLimit CC Não suportado
holdItems AS Lista dos registros/obras das reservas do usuário. Note que as reservas por título terão um prefixo ‘t’.
overdueItems AT Lista dos registros dos empréstimos em atraso do usuário
chargedItems AU Lista dos registros dos empréstimos em aberto do usuário
fineItems AV Lista dos registros dos empréstimos com multas em aberto do usuário
recallItems BU Lista dos registros dos empréstimos renovados em aberto do usuário
unavilableHoldItems CD Não suportado
homeAddress BD Endereço residencial do usuário
eMailAddress BE E-mail do usuário
homePhoneNumber BF Telefone residencial do usuário
screenMessage AF Mensagem descritiva para indicar o status da execução do serviço
printLine AG Não suportado
Serviço Campo ID Descrição
Renovação de Todos (65)
6520110217 075421AOBC|AActy|ADCty123
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
patronPassword AD Senha da matrícula do usuário fornecida pelo BNWeb
terminalPassword AC Não suportado
feeAcknowledged BO Não suportado
Resposta da Renovação de Todos (66)
6610001000020190411 022042AOBC|BM6|AFTodos os registros foram renovados.
Ok 0/1 – Indica se um ou mais renovações foram realizadas com sucesso
renewedCount Total de renovações realizadas
unrenewedCount Total de renovação não realizadas
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
screenMessage AF Mensagem descritiva para indicar o status da execução do serviço
printLine AG Não suportado
Serviço Campo ID Descrição
Login (93)
93 CNcty|COCty123
UIDAlgorithm Não suportado
PWDAlgorithmh Não suportado
loginUserId CN Matrícula do usuário fornecida pelo BNWeb
loginPassword CO Senha da matrícula do usuário fornecida pelo BNWeb
locationCode CP Sigla da unidade da instituição
Ex.: BC
Resposta do Login (94)
941
ok 0/1 – Indica se o login foi realizado com sucesso
screenMessage AF Mensagem descritiva para indicar o status da execução do serviço
printLine AG Não suportado
Serviço Campo ID Descrição
Status do SC (99)
9909992.00
StatusCode 0 – SC está OK
1 – SC está sem papel
2 – SC está desligando
maxPrintWidth Máximo de caracteres que o SC pode imprimir em uma única linha
protocolVersion 2.00 – (Versão do protocolo SIP)
Status do ACS (98)
98YYYYYN10000320190411 0224062.00AOMAIN|BXYYYYYYYYYNYNYYYY|AFBNWeb - Auto-Emprestimo
onLineStatus Y – Status Online
checkInOk Y – Devolução OK
checkOutOk Y – Empréstimo OK
renewalPolicy Y – Renovação OK
statusUpdateOk Y – Alteração do status do usuário OK
offlineOk N – Não suportado
timeoutPeriod 100
retriesAllowed 003
dateTimeSync Data e hora do servidor
protocolVersion 2.00
institutionId AO Sigla da unidade da instituição
Ex.: BC
libraryName AM O nome da biblioteca será retornado em branco pois cada máquina da 3M (SC) diferenciarão de qual unidade está localizado
supportedMessages BX Posições suportadas:
0 – Status do usuário
1 – Empréstimo
2 – Devolução
3 – Bloqueio de usuário
4 – Status do ACS
5 – Reenvio de mensagens
6 – Login
7 – Informação do usuário
8 – Terminar sessão do usuário
10 – Informação do registro
12 – Desbloqueio de usuário
13 – Reserva por registro/título
14 – Renovação
15 – Revovação de todos
terminalLocation AN Não suportado
screenMessage AF Mensagem descritiva para indicar o status da execução do serviço
printLine AG Não suportado
Serviço Campo ID Descrição
Bloqueio de Usuário (01)
01N20190409 105900AOBC|ALFui roubado|AActy
cardRetained Y/N – Indica se a carteirinha já foi retida na instituição
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
blockedCardMsg AL Motivo do bloqueio do usuário
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
terminalPassword AC Não suportado
Resposta de Bloqueio de Usuário (24)
24YY Y 01020190411 022525AOBC|AActy|AEUsuário Contempory|BLY|CQY|BHBRD|BV0,49|AFSua carteirinha foi bloqueada com sucesso.
patronStatus Posições suportadas:
0 – Empréstimo (N se o usuário estiver com status diferente de normal)
1 – Renovação (N se o usuário estiver com status diferente de normal)
2 – Solicitar a mensagem anterior
3 – Reserva (N se o usuário estiver com status diferente de normal)
10,11 – Multas
language Não suportado
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
personalName AE Nome do usuário fornecida pelo BNWeb
validPatron BL Y/N – Indica se é um usuário válido
validPatronPassword CQ Y/N – Indica se a senha é válida
currencyType BH BRD – (Tipo de moeda brasileira)
feeAmount BV Total de multas do usuário
screenMessage AF Mensagem descritiva para indicar o status da execução do serviço
printLine AG Não suportado
Serviço Campo ID Descrição
Desbloqueio de Usuário (25)
2520190409 105900AOBC|AActy|ADCty123
cardRetained Y/N – Indica se a carteirinha já foi retida na instituição
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
terminalPassword AC Não suportado
patronPassword AD Senha da matrícula do usuário fornecida pelo BNWeb
Resposta de Desbloqueio de Usuário (26)
26 01020190411 022658AOBC|AActy|AEUsuário Contempory|BLY|CQY|AFSua carteirinha foi desbloqueada com sucesso.
patronStatus Posições suportadas:
0 – Empréstimo (N se o usuário estiver com status diferente de normal)
1 – Renovação (N se o usuário estiver com status diferente de normal)
2 – Solicitar a mensagem anterior
3 – Reserva (N se o usuário estiver com status diferente de normal)
10,11 – Multas
language Não suportado
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
personalName AE Nome do usuário fornecida pelo BNWeb
validPatron BL Y/N – Indica se é um usuário válido
validPatronPassword CQ Y/N – Indica se a senha é válida
screenMessage AF Mensagem descritiva para indicar o status da execução do serviço
printLine AG Não suportado
Serviço Campo ID Descrição
Termina Sessão do Usuário (35)
3520190409 105900AOBC|AActy|ADCty123
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
terminalPassword AC Não suportado
patronPassword AD Senha da matrícula do usuário fornecida pelo BNWeb
Resposta de Termina Sessão do Usuário (36)
36Y20190411 022835AOBC|AActy|AFSua sessão foi encerrada com sucesso.
endSession Y/N – Indica se a sessão foi finalizada com sucesso
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
screenMessage AF Mensagem descritiva para indicar o status da execução do serviço
printLine AG Não suportado
Serviço Campo ID Descrição
Reserva (15)
15+20190409 105900AB6|AActy|ADCty123
holdMode ‘+’ – Registra reserva
‘-‘ – Cancela reserva
‘*’ – Operação não suportada
transactionDate Data atual da transação
expirationDate BW Não suportado
pickupLocation BS Sigla da unidade na qual o registro pertence
holdType BY Não suportado
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
patronPassword AD Senha da matrícula do usuário fornecida pelo BNWeb
itemIdentifier AB Código do registro fornecido pelo BNWeb
titleIdentifier AJ Código do acervo fornecido pelo BNWeb
terminalPassword AC Não suportado
feeAcknowledged BO Não suportado
Resposta de Reserva (16)
161N20190411 023110BR1|BSBC|AActy|AB6|AFReserva efetuada com sucesso!
ok 1/0 – Indica se a reserva ou o cancelamento do mesmo foi realizado com sucesso
available Y/N – Indica se o registro encontra-se disponível para empréstimo
transactionDate Data atual da transação
expirationDate BW Não suportado
queuePosition BR Posição em que o usuário encontra-se na fila da reserva
pickupLocation BS Sigla da unidade na qual o registro pertence
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
itemIdentifier AB Código do registro fornecido pelo BNWeb
titleIdentifier AJ Código do acervo fornecido pelo BNWeb
screenMessage AF Mensagem descritiva para indicar o status da execução do serviço
printLine AG Não suportado
Serviço Campo ID Descrição
Reenvia Última Mensagem (97)
97
Resposta Retorna a Última Mensagem (XX)
160N20190411 023334AActy|AB6|AFMatrícula \"cty\" já possui reserva da obra \"Desenvolvendo com AngularJS\".
Serviço Campo ID Descrição
Pagamento de Multa (37)
3720190409 1059000100BRDAOBC|AActy|ADCty123
transactionDate Data atual da transação
paymentType 00 – Dinheiro
01 – Visa
02 – Cartão de crétido
feeType Não suportado. Será considerado 04 (Multa por atraso)
currencyType Não suportado. Será considerad BRD (Tipo de moeda brasileira)
feeAmount BV Total de multa para ser pago
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
terminalPassword AC Não suportado
patronPassword AD Senha da matrícula do usuário fornecida pelo BNWeb
feeIdentifier EK Código da operação de empréstimo para pagar uma multa em específico
transactionId BZ Código da operação de empréstimo para pagar uma multa em específico
Resposta do Pagamento de Multa (38)
38N20190411 023435AOBC|AActy|AFPara pagamentos, fale com um dos nossos atendentes.
paymentAccepted N – Pagamento não realizado. Os pagamentos devem ser realizados no balcão de atendimento
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
patronIdentifier AA Matrícula do usuário fornecida pelo BNWeb
screenMessage AF Mensagem descritiva para indicar o status da execução do serviço
printLine AG Não suportado
Serviço Campo ID Descrição
Alteração do Status do Item (19)
1920190409 105900AOBC|AB6
transactionDate Data atual da transação
institutionId AO Sigla da unidade da instituição
Ex.: BC
itemIdentifier AB Código do registro fornecido pelo BNWeb
terminalPassword AC Não suportado
itemProperties CH Não suportado
Resposta da Alteração do Status do Item (20)
20020190411 023745AB6|AFAlterações de registros não são permitidos por este meio.
itemPropertiesOk 0 – Alteração não realizada. As alterações de status do registro devem ser realizados no balcão de atendimento
transactionDate Data atual da transação
itemIdentifier AB Código do registro fornecido pelo BNWeb
titleIdentifier AJ Código do acervo fornecido pelo BNWeb
itemProperties CH Não suportado
screenMessage AF Mensagem descritiva para indicar o status da execução do serviço
printLine AG Não suportado