ApiLog

Single item in logs array used in some responses.
code(int)0-Success, otherwise it may have a specific result code.
level(int)0-OK, 1-WARNING, 2-ERROR.
itemType(int)Related Item Type ID. See details below.
itemId(string)Related Item ID.
message(string)Result text message.
Notes:
  • Logs with level="0" may be omitted.
  • level will have maixum value from logs.
  • To simplify amount of serialized data, SageBridgeAPI client will omitt all fieds with values of NULL.
  • Examples below are from PostEducationalDocument response
  • Logs with itemTypeId=5 are about patient with patientId="TS01831451".
  • Logs with itemTypeId=3 are about posted documents with specific documentId values.

XML Example:

JSON Example:

{
    "code": 0,
    "message": "All Done",
    "level": 1,

    "logs": [
        { "itemTypeId": 5, "itemId": "TS01831451", "code": 0, "message": "Patient located", "level": 0 },
        { "itemTypeId": 3, "itemId": "66744316-FD01-4637-918C-0B0033A81A4C", "code": 0, "message": "Document saved", "level": 0 },
        { "itemTypeId": 3, "itemId": "B7F7BF7B-C09E-4911-BBB1-0589DF32A955", "code": 0, "message": "Articles not supported for this type", "level": 1 },
        { "itemTypeId": 3, "itemId": "0639009A-BBF6-4193-B51E-B6AC27173A9D", "code": 0, "message": "Articles not supported for this type", "level": 1 },
        { "itemTypeId": 3, "itemId": "B7F7BF7B-C09E-4911-BBB1-0589DF32A955", "code": 0, "message": "Document saved", "level": 0 },
        { "itemTypeId": 3, "itemId": "0639009A-BBF6-4193-B51E-B6AC27173A9D", "code": 0, "message": "Document saved", "level": 0 }
    ]
}

Log Item Types:

  • PatientChart = 1
  • ClinicalSummary = 2
  • EducationalDocument = 3
  • SecureMessage = 4
  • Patient = 5
  • AuthorizedUser = 6
  • Practice = 100
  • Provider = 101
  • Appointment = 102
  • VisitType = 103
  • Location = 104

See also:

API Data, APIResponse data , PostPatientLoginInfo function , PostPatientTokenInfo function