Svarskoder och systemloggar för WS-kontrakt i Loggtjänsten

Owned by Peter Leader
nov. 13, 2023

 Dokumenthistorik

DatumVersionNamnFörändring


1.0
Dokumenterat svarskoder i och med omskrivning av Loggtjänsten.








Innehåll

Gemensamt för alla kontrakt

Systemloggar

När något går fel i anropet INFO-loggas felmeddelandet med tillhörande correlation-ID enligt följande [correlationId]: <felmeddelande>. 

Resultatobjekt i WS-svar

Vid normalt systemflöde returneras resultatkoder som indikerar om förfrågan gick bra eller om det fanns saker att anmärka på.

De resultatkoder som finns definierade/används vid fel är som följer:

OK - Transaktionen har utförts enligt uppdraget.

ERROR - Transaktionen har INTE kunnat utföras p.g.a ett logiskt fel.

VALIDATION_ERROR - En eller flera inparametrar innehåller felaktiga värden. Angiven tjänst utfördes ej.

ACCESSDENIED - Behörighet saknas för att utföra begärd tjänst. Angiven tjänst utfördes ej.

REPORT_ON_QUEUE - Angiven rapport är ej klar. Rapporten ligger på kö för att genereras. Ytterligere anrop kan göras för att kontrollera om jobbet är klart.

REPORT_IN_PROCESS - Angiven rapport är ej klar. Rapporten är under uppbyggnad. Ytterligere anrop kan göras för att kontrollera om jobbet är klart.

REPORT_NOT_FOUND - Felaktig id angivet. Angiven tjänst ej kan hitta rapport med angivet id som är skapad eller rapport som ligger på kö för att skapas.

MAX_QUERY_RESULT_EXCEEDED - Max antal loggposter som tjänsten kan returnera har överstigits. Ändra sökparametrar för att begränsa rapportuttaget.


Ett beskrivande felmeddelande skickas även med om frågan inte gick igenom.


<ns2:result>
	<ns2:resultCode>OK</ns2:resultCode>
</ns2:result>

<ns2:result>
	<ns2:resultCode>ERROR</ns2:resultCode>
	<ns2:resultText>Beskrivande felmeddelande</ns2:resultText>
</ns2:result>

<ns2:result>
	<ns2:resultCode>VALIDATION_ERROR</ns2:resultCode>
	<ns2:resultText>Beskrivande felmeddelande</ns2:resultText>
</ns2:result>

<ns2:result>
    <resultCode>ACCESSDENIED</resultCode>
    <resultText>Behörighet saknas för att utföra begärd tjänst. Angiven tjänst utfördes ej.</resultText>
</ns2:result>

<ns2:result>
    <resultCode>REPORT_ON_QUEUE</resultCode>
    <resultText>Kö-ID att skicka med i efterföljande anrop för att hämta rapporten när den är klar</resultText>
</ns2:result>

<ns2:result>
    <resultCode>REPORT_IN_PROCESS</resultCode>
    <resultText>Angiven rapport är ej klar. Rapporten är under uppbyggnad. Ytterligare anrop kan göras för att kontrollera om jobbet är klart.</resultText>
</ns2:result>

<ns2:result>
    <resultCode>REPORT_IN_PROGRESS</resultCode>
    <resultText>Angiven rapport är ej klar. Rapporten är under uppbyggnad. Ytterligare anrop kan göras för att kontrollera om jobbet är klart.</resultText>
</ns2:result>

<ns2:result>
    <resultCode>REPORT_NOT_FOUND</resultCode>
    <resultText>Tjänsten kan ej hitta rapport med angivet id: %s</resultText>
</ns2:result>

<ns2:result>
    <resultCode>MAX_QUERY_RESULT_EXCEEDED</resultCode>
    <resultText>Max antal loggposter som tjänsten kan returnera har överstigits. Ändra sökparametrar för att begränsa rapportuttaget.</resultText>
</ns2:result>


Loggtjänsten

KontraktFelorsakFelmeddelandeFelkod (resultCode)
StoreLog


logId är odefinierad, tom eller ogiltigValideringsfel : är inte ett giltigt UUID för element

VALIDATION_ERROR









Någon av följande fält är odefinerade eller ogiltiga:

  • system : Taggen saknas
  • activity : Taggen saknas
  • user  : Taggen saknas
  • resources : Taggen saknas
Valideringsfel : värde för parameter element saknas

Under system

  • systemId är ogiltig eller saknas
Valideringsfel : värde för parameter element saknas/

Valideringsfel : Värdet för parameter element får inte överstiga X tecken

Under activity

  • activityType är ogiltig eller saknas
  • startDate är ogiltig eller saknas
  • purpose är ogiltig eller saknas
Valideringsfel : värde för parameter element saknas/

Valideringsfel : Värdet för parameter element får inte överstiga X tecken

valideringsfel : Värdet date är ett ogiltigt datum eller tid för parameter StartDate.

Under user

  • userId är ogiltig eller saknas
  • careProvider är ogiltig eller saknas
  • careUnit är ogiltig eller saknas
Valideringsfel : värde för parameter element saknas/

Valideringsfel : Värdet för parameter element får inte överstiga X tecken

Under resources

  • resource är ogiltig eller saknas

Valideringsfel : Resource måste anges

Under user/personId

  • Root är ogiltig eller saknas
  • extension är ogiltig eller saknas 

Valideringsfel : Värde för parameter PersontId.Root saknas.

Valideringsfel : Värde för parameter PersonId.Extension saknas.

Valideringsfel : ..är ett felaktigt värde för PersonId.Extension! Ogiltigt format på personidentitet

Valideringsfel : ..är ett felaktigt värde för PersonId.Root! Giltiga värden är: [1.2.752.74.9.1, 1.2.752.129.2.1.3.1, 1.2.752.129.2.1.3.3]

Under user/careprovider

  • careProviderId är ogiltig eller saknas
Valideringsfel : värde för parameter element saknas/

Valideringsfel : Värdet för parameter element får inte överstiga X tecken

Under user/careUnit

  • careUnitId är ogiltig eller saknas
Valideringsfel : värde för parameter element saknas/

Valideringsfel : Värdet för parameter element får inte överstiga X tecken

Under resources/resource

  • resourceType är ogiltig eller saknas
  • careProvider är ogiltig eller saknas
Valideringsfel : värde för parameter element saknas/

Valideringsfel : Värdet för parameter element får inte överstiga X tecken

Under resources/resource/patient/patientId

  • Root är ogiltig eller saknas
  • extension är ogiltig eller saknas 

Valideringsfel : Värde för parameter PatientId.Root saknas.

Valideringsfel : Värde för parameter PatientId.Extension saknas.

Valideringsfel : ..är ett felaktigt värde för PatientIdId.Extension! Ogiltigt format på personidentitet

Valideringsfel : ..är ett felaktigt värde för PatientId.Root! Giltiga värden är: [1.2.752.74.9.1, 1.2.752.129.2.1.3.1, 1.2.752.129.2.1.3.3]

Under resources/resource/careProvider

  • careProviderId är ogiltig eller saknas
Valideringsfel : värde för parameter element saknas/

Valideringsfel : Värdet för parameter element får inte överstiga X tecken

Under resources/resource/careUnit

  • careUnitId är ogiltig eller saknas

Valideringsfel : värde för parameter element saknas /

Valideringsfel : Värdet för parameter element får inte överstiga X tecken

GetLogs

  • careProviderId är ogiltig eller saknas
  • fromDate saknas eller är felaktigt
  • toDate saknas eller är felaktigt
  • patientId och userId är angivna i samma rapport
Valideringsfel : värde för parameter element saknas/

Valideringsfel : Värdet för parameter element får inte överstiga X tecken

Valideringsfel : Värdet date är ett ogiltigt datum eller tid för parameter fromDate/toDate.

Valideringsfel :  Felaktig kombination av parametrar, patientId och userId kan ej kombineras i samma rapport

VALIDATION_ERROR




Under user/patientId

  • Root är ogiltig eller saknas
  • extension är ogiltig eller saknas 

Valideringsfel : Värde för parameter PatientId.Root saknas.

Valideringsfel : Värde för parameter PatientId.Extension saknas.

Valideringsfel : ..är ett felaktigt värde för PatientId.Extension! Ogiltigt format på personidentitet

Valideringsfel : ..är ett felaktigt värde för PatientId.Root! Giltiga värden är: [1.2.752.74.9.1, 1.2.752.129.2.1.3.1, 1.2.752.129.2.1.3.3]

  • queuedReportId felaktigt

REPORT_NOT_FOUND : Tjänsten kan ej hitta rapport med angivet id

GetAccessLogsForPatient

  • patientId saknas
  • fromDate saknas eller är felaktigt
  • toDate saknas eller är felaktigt


Valideringsfel : värde för parameter element saknas/

Valideringsfel : Värdet date är ett ogiltigt datum eller tid för parameter fromDate/toDate.

VALIDATION_ERROR










Under user/patientId

  • Root är ogiltig eller saknas
  • extension är ogiltig eller saknas 

Valideringsfel : Värde för parameter PatientId.Root saknas.

Valideringsfel : Värde för parameter PatientId.Extension saknas.

Valideringsfel : ..är ett felaktigt värde för PatientId.Extension! Ogiltigt format på personidentitet

Valideringsfel : ..är ett felaktigt värde för PatientId.Root! Giltiga värden är: [1.2.752.74.9.1, 1.2.752.129.2.1.3.1, 1.2.752.129.2.1.3.3]

  • queuedReportId felaktigt

REPORT_NOT_FOUND : Tjänsten kan ej hitta rapport med angivet id

GetInfoLogs

  • careProviderId är ogiltig eller saknas
  • fromDate saknas eller är felaktigt
  • toDate saknas eller är felaktig
Valideringsfel : värde för parameter element saknas/

Valideringsfel : Värdet för parameter element får inte överstiga X tecken

Valideringsfel : Värdet date är ett ogiltigt datum eller tid för parameter fromDate/toDate.

VALIDATION_ERROR


Under patientId

  • Root är ogiltig eller saknas
  • extension är ogiltig eller saknas 

Valideringsfel : Värde för parameter PatientId.Root saknas.

Valideringsfel : Värde för parameter PatientId.Extension saknas.

Valideringsfel : ..är ett felaktigt värde för PatientId.Extension! Ogiltigt format på personidentitet

Valideringsfel : ..är ett felaktigt värde för PatientId.Root! Giltiga värden är: [1.2.752.74.9.1, 1.2.752.129.2.1.3.1, 1.2.752.129.2.1.3.3]

  • queuedReportId felaktigt

REPORT_NOT_FOUND : Tjänsten kan ej hitta rapport med angivet id

GetLogsByOrder
  • careProviderId är ogiltig eller saknas
  • fromDate saknas eller är felaktigt
  • toDate saknas eller är felaktigt
Valideringsfel : värde för parameter element saknas/

Valideringsfel : Värdet för parameter element får inte överstiga X tecken

Valideringsfel : Värdet date är ett ogiltigt datum eller tid för parameter fromDate/toDate.

VALIDATION_ERROR

Under patientId

  • Root är ogiltig eller saknas
  • extension är ogiltig eller saknas 

Valideringsfel : Värde för parameter PatientId.Root saknas.

Valideringsfel : Värde för parameter PatientId.Extension saknas.

Valideringsfel : ..är ett felaktigt värde för PatientId.Extension! Ogiltigt format på personidentitet

Valideringsfel : ..är ett felaktigt värde för PatientId.Root! Giltiga värden är: [1.2.752.74.9.1, 1.2.752.129.2.1.3.1, 1.2.752.129.2.1.3.3]

GetFilesForOrderId
  • orderId är ogiltig eller saknas

Valideringsfel : Värde för parameter OrderId saknas.

REPORT_NOT_FOUND : Tjänsten kan ej hitta rapport med angivet id

VALIDATION_ERROR