/
program_get ()

program_get ()

Owned by Former user (Deleted)
Last updated: Mar 31, 2025 by Pedro Jose Sanchez Luling
3 min read

Function prototype

program_get (session, program, [subscription])

API Version

All

Supported interfaces

SOAP, REST (Since API Version 2.7.32)

Description

Returns all the information about the program give it in the input parameter including a list of the program protocols.

Required permissions:

Depending on the access type of the PROGRAM:

  • “Public” or “Shared” access type: anyone can request information about it (PROFESSIONALS and CASES)

  • “Private” access type: then depending on the active USER:

    • If the active USER is a PROFESSIONAL, he must be member of the PROGRAM (directly or indirectly via a member TEAM)

    • If the active USER is a CASE, then he must have an ADMISSION created for that PROGRAM

    • If the active USER is an ASSOCIATE, then any of the people being cared by him must have an ADMISSION in that PROGRAM

  • Special case: Programs with only a “DRAFT” version. If a a PROGRAM has no version published and there exists only the DRAFT version, then only a PROFESSIONAL that is member of the PROGRAM OWNER with role “PROGRAM EDITOR” will be granted permission to retrieve the information about the PROGRAM

Input parameters:

  • session: a token obtained by calling session_init ()

  • program: the ID of the program. From API version 2.7.15 it is also allowed to provide a PROGRAM CODE

  • subscription: ID of target subscription for filtring response.

Output parameters:

  • program: a program object

    • ref: Program reference

    • code: Program Code. Introduced in API version 2.7.15

    • name: program name

    • description: program description in the active session language

    • image_info: Picture associated to the PROGRAM expressed as a LIBRARY RESOURCE INFO (JSON)

    • active: Y/N

    • trial: (true/false). Introduced in API version 2.7.8

    • events_disabled: (true/false). Introduced in API version 2.7.12

    • protocols: a list of protocols of the program

    • owner: TEAM owner of the PROGRAM. Introduced in API version 2.7.28

      • ref: TEAM owner reference

      • name: TEAM owner name

    • authors: List of authors of the PROGRAM. Each author is a combination of a USER and a TEAM. Introduced in API version 2.7.28

      • user: Basic information about the USER

        • ref: reference of the author

        • name_complete: Full name of the author

      • team: Basic information about the TEAM

        • ref: reference of the TEAM

        • name: Name of the TEAM

    • sponsors: List of sponsors of the PROGRAM. Each sponsor is a TEAM. Introduced in API version 2.7.28

      • team: Basic information about the TEAM

        • ref: reference of the TEAM

        • name: Name of the TEAM

    • diagnosis: List of diagnosis assigned to the PROGRAM. Diagnosis are represented by MDC DIAGNOSISCODES. Introduced in API version 2.7.28

    • categories: List of categories assigned to the PROGRAM. Categories are represented by PROGRAM CATEGORY CODES. Introduced in API version 2.7.28

    • reports: List of links to download REPORTS defined at PROGRAM level in the PROGRAM TEMPLATE. Introduced in API version 2.8.1

      • ref: Reference of the REPORT

      • name: Name (title) of the REPORT

      • url: url to generate the REPORT in PDF format. Only usable by the same session that generated this URL.

      • url_html: url to generate the REPORT in HTML format. Only usable by the same session that generated this URL.

  • ErrorMsg: any fault in the call, either in the validation of input parameters, errors in the connection to the database or any other error, this parameter returns the error message produced

Request example

program_get ( “LCAAAAAAAAAAAA”, 12, 129)

Response

The response format is XML when the function has been invoked via the SOAP API, and JSON when it has been invoked via the REST API

Return Error codes

ERROR CODE

 

ERROR CODE

 

INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The session user does not have the necessary privileges to request the PROGRAM information

PROGRAM.NOT_FOUND

The requested PROGRAM was not found

 

 

 

 

 

Related content