• F = Full permissions
• H = Hidden field
• O = Read only field
• R = Required field

1. The call must be GET or HEAD

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='somepassword', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study schema
    study = studies[0]
    r = requests.get(base_url + '/host/{0}/api/v3/storage/study/{1}/{2}/schema?sid={3}&phi_namespace={4}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid, study['phi_namespace']))
    if r.status_code == 200:
        print r.json()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()
                    

1. The call must be DELETE
2. If the optional parameter keep_attachments is set to 1, then:
   all DICOM images will be deleted.
   reports and attachments related to the study will be kept.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Delete study
    study = studies[2]
    r = requests.delete(base_url + '/host/{0}/api/v3/storage/study/{1}/{2}?sid={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid))
    if r.status_code == 202:
        print "Study deleted"
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()

                    

1. The HTTP method must be DELETE
2. This method sends a STUDY_DELETE notification to Services after the image is deleted
3. This method is synchronous - it doesn't return until the image is deleted and Services notification is sent

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study schema information
    study = studies[0]
    r = requests.get(base_url + '/host/{0}/api/v3/storage/study/{1}/{2}/schema?sid={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid))
    if r.status_code == 200:
        # Delete study image
        study_schema = r.json()
        r2 = requests.delete(base_url + '/host/{0}/api/v3/storage/study/{1}/{2}/image/{3}?sid={4}'.format(study['engine_fqdn'], study_schema['namespace'], study_schema['study_uid'], study_schema['series'][0]['images'][0]['id'], sid))
        if r2.status_code == 202:
            print "Study image {0}/{1}/{2} deleted".format(study_schema['namespace'], study_schema['study_uid'], study_schema['series'][0]['images'][0]['id'])
        else:
            r2.raise_for_status()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()
                    

1. The HTTP method must be DELETE
2. This method sends one STUDY_DELETE notification to Services after the images are deleted
3. This method is synchronous - it doesn't return until all images are deleted and Services notification is sent

1. The call must be GET or HEAD.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study count
    study = studies[0]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/count?sid={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid))
    if r.status_code == 200:
        print r.json()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()

                    

1. The call must be GET or HEAD.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study tags
    study = studies[0]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/tag?sid={4}&phi_namespace={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], study['phi_namespace'], sid))
    if r.status_code == 200:
        print r.json()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()

                    

1. The call must be GET or HEAD.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Ge study schema
    study = studies[0]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/schema?sid={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid))
    if r.status_code == 200:
        study_schema = r.json()
        # Get image attributes
        r2 = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/image/{3}/version/{4}/attribute?sid={6}&phi_namespace={5}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], study_schema['series'][0]['images'][0]['id'], study_schema['series'][0]['images'][0]['version'], study['phi_namespace'], sid))
        if r2.status_code == 200:
            print r2.json()
        else:
            r2.raise_for_status()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()
                    

1. The call must be GET or HEAD.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study schema
    study = studies[0]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/schema?sid={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid))
    if r.status_code == 200:
        study_schema = r.json()
        # Get image phi information
        r2 = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/image/{3}/version/{4}/phi?sid={6}&phi_namespace={5}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], study_schema['series'][0]['images'][0]['id'], study_schema['series'][0]['images'][0]['version'], study['phi_namespace'], sid))
        if r2.status_code == 200:
            print r2.json()
        else:
            r2.raise_for_status()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()
                    

1. The call must be GET or HEAD.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study phi
    study = studies[0]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/phi?sid={3}&phi_namespace={4}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid, study['phi_namespace']))
    if r.status_code == 200:
        print r.json()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()
                    

1. The call must be GET or HEAD.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study schema
    study = studies[0]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/schema?sid={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid))
    if r.status_code == 200:
        # Get thumbnail
        study_schema = r.json()
        r2 = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/image/{3}/version/{4}/frame/0/thumbnail?sid={6}&phi_namespace={5}&depth=8'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], study_schema['series'][0]['images'][0]['id'], study_schema['series'][0]['images'][0]['version'], study['phi_namespace'], sid))
        if r2.status_code == 200:
            thumbnail = open('thumbnail.png', 'wb')
            thumbnail.write(r2.content)
            thumbnail.close()
        else:
            r2.raise_for_status()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()

                    

1. The call must be GET or HEAD.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study schema
    study = studies[0]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/schema?sid={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid))
    if r.status_code == 200:
        study_schema = r.json()
        # Get diagnostic image
        r2 = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/image/{3}/version/{4}/frame/0/diagnostic?sid={6}&phi_namespace={5}&depth=16'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], study_schema['series'][0]['images'][0]['id'], study_schema['series'][0]['images'][0]['version'], study['phi_namespace'], sid))
        if r2.status_code == 200:
            image = open('diagnostic', 'wb')
            image.write(r2.content)
            image.close()
        else:
            r2.raise_for_status()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()
                    

1. The call must be GET or HEAD.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study schema
    study = studies[0]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/schema?sid={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid))
    if r.status_code == 200:
        study_schema = r.json()
        # Get image frame
        r2 = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/image/{3}/version/{4}/frame/0?sid={6}&phi_namespace={5}&depth=16'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], study_schema['series'][0]['images'][0]['id'], study_schema['series'][0]['images'][0]['version'], study['phi_namespace'], sid))
        if r2.status_code == 200:
            frame = open('frame', 'wb')
            frame.write(r2.content)
            frame.close()
        else:
            r2.raise_for_status()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()
                    

1. The call must be GET or HEAD.

1. The call must be GET or HEAD.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study schema
    study = studies[0]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/schema?sid={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid))
    if r.status_code == 200:
        image_info = r.json()['series'][0]['images'][0]
        # Get encapsulated pdf
        r2 = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/image/{3}/version/{4}/pdf?sid={6}&phi_namespace={5}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], image_info['id'], image_info['version'], study['phi_namespace'], sid))
        if r2.status_code == 200:
            pdf = open('encapsulatedPdf', 'wb')
            pdf.write(r2.content)
            pdf.close()
        else:
            r2.raise_for_status()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()

                    

1. The call must be GET or HEAD.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study schema
    study = studies[0]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/schema?sid={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid))
    if r.status_code == 200:
        image_info = r.json()['series'][0]['images'][0]
        # Get image attributes
        r2 = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/image/{3}/version/{4}/json?sid={6}&phi_namespace={5}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], image_info['id'], image_info['version'], study['phi_namespace'], sid))
        if r2.status_code == 200:
            print r.json()
        else:
            r2.raise_for_status()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()
                    

1. The call must be GET or HEAD.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study schema
    study = studies[0]
    # Get study attributes
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/json?sid={4}&phi_namespace={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], study['phi_namespace'], sid))
    if r.status_code == 200:
        print r.json()
    else:
        r.raise_for_status()


# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()

                    

1. The call must be GET or HEAD.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study schema
    study = studies[1]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/schema?sid={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid))
    if r.status_code == 200:
        attachment_info = r.json()['attachments'][0]
        # Get attachment
        r2 = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/attachment/{3}/version/{4}?sid={6}&phi_namespace={5}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], attachment_info['id'], attachment_info['version'], study['phi_namespace'], sid))
        if r2.status_code == 200:
            attachment = open('attachment', 'wb')
            attachment.write(r2.content)
            attachment.close()
        else:
            r2.raise_for_status()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()

                    

1. The call must be GET or HEAD.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study schema
    study = studies[1]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/attachment/latest?sid={4}&phi_namespace={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], study['phi_namespace'], sid))
    if r.status_code == 200:
        # Save latest attachment
        attachment = open('attachment', 'wb')
        attachment.write(r.content)
        attachment.close()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()

                    

1. The call must be POST.
2. If the optional parameter wrap_images or synchronous_wrap is set to 1, or the uploading account has the setting auto_wrap_images set to 1, then:
• attachments of type image/jpeg or image/bmp are, asynchronously (unless synchronous_wrap=1) to the Store Attachment request, posted to the Wrap Attachment service, to be stored as a single DICOM image in a new series within the specified study.
• attachments of type application/pdf are, asynchronously (unless synchronous_wrap=1) to the Store Attachment request, rendered to DICOM images at a resolution of 200 ppi, one image per page of the original PDF. The resulting are stored in a new series within the specified study. UIDs assigned to the series and images will be random unless static_ids=1

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    sid = getSID(password='some_password', login='some_email')
    namespace = getNamespace(sid=sid)
    studies = getStudyList(sid, namespace[0]['uuid'])
    study = studies[1]
    fin = open(, 'rb')
    payload = {'data':fin}
    try :
        url = base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/attachment?sid={3}&phi_namespace={4}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid, study['phi_namespace'])
        r = requests.post(url, files=payload)
        if r.status_code == 202:
            print r.json()
        else:
            r.raise_for_status()
    finally:
        fin.close()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()


                    

1. The call must be POST

1. The call must be GET or POST. POST is necessary if URL exceeds maximum supported length (~2,000 chars)
2. If the optional parameter bundle is set then:
• dicom - Include DICOM files and reports only.
• image - Include transcoded images and videos.
• iso - Include DICOM files, reports, transcoded SD and Diagnostic quality images, the MacOS and the Windows viewer bundle.
• osx - Include transcoded SD and Diagnostic quality images, and the MacOS viewer bundle.
• win - Include transcoded SD and Diagnostic quality images, and the Windows viewer bundle.
3. Errors are reported in ERROR.txt file in the ZIP download.

import requests
import shutil

base_url = 'https://uat.dicomgrid.com/'

def main():
    sid = getSID(password='some_password', login='some_email')
    namespace = getNamespace(sid=sid)
    studies = getStudyList(sid, namespace[0]['uuid'])
    study = studies[1]
    url = base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/download?sid={3}&phi_namespace={4}&bundle=dicom'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid, study['phi_namespace'])
    r = requests.get(url, stream=True)
    print 'Downloading study {}/{}'.format(study['storage_namespace'], study['study_uid'])
    if r.status_code == 200:
        with open('studyDownload.zip', 'wb') as f:
            shutil.copyfileobj(r.raw, f)
    else:
        print r.raise_for_status()


# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()

                    

1. The call must be DELETE.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study schema
    study = studies[1]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/schema?sid={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid))
    if r.status_code == 200:
        attachment_info = r.json()['attachments'][0]
        # Delete attachment
        r2 = requests.delete(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/attachment/{3}/version/{4}?sid={6}&phi_namespace={5}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], attachment_info['id'], attachment_info['version'], study['phi_namespace'], sid))
        if r2.status_code == 202:
            print 'Attachment {0}/{1}/{2}/{3} deleted'.format(study['storage_namespace'], study['study_uid'], attachment_info['id'], attachment_info['version'])
        else:
            r2.raise_for_status()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()

                    

1. The call must be GET or HEAD.
2. reencode_video - when set the original video will be reencoded to a mp4 format.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Get study schema
    study = studies[0]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/schema?sid={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid))
    if r.status_code == 200:
        image_info = r.json()['series'][0]['images'][0]
        # Get encapsulated pdf
        r2 = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/image/{3}/version/{4}/video?sid={5}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], image_info['id'], image_info['version'], sid))
        if r2.status_code == 200:
            video = open('encapsulatedVideo', 'wb')
            video.write(r2.content)
            video.close()
        else:
            r2.raise_for_status()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()

                    

1. The call must be POST.
2. The system will create a copy of the "old study" and assign a new Study UID.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Split study
    study = studies[2]
    r = requests.post(base_url + 'host/{0}/api/v3/storage/study/namespace/{1}/{2}/split?sid={3}&phi_namespace={4}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid, study['storage_namespace']))
    if r.status_code == 202:
        print 'New study info {}/{}'.format(study['storage_namespace'], r.text)
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()

                    

1. This endpoint is only intended for AmbraHealth account administrators.
2. The call must be GET.
3. The system will take the studyUid as the primary study and will merge the secondary_study_uid into the primary.
4. If the process is completed successfully the primary study will contain the images from the secondary study at the end of the process. If the optional parameter delete_secondary_study is set to 1, storage will delete the secondary study after the merge has been completed.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Merge study
    study_primary = studies[0]
    study_secondary = studies[1]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/merge?sid={4}&secondary_study_uid={3}'.format(study_primary['engine_fqdn'], study_primary['storage_namespace'], study_primary['study_uid'], study_secondary['study_uid'], sid))
    if r.status_code == 202:
        print 'Merge study request accepted.'
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()
                    

1. The call must be POST
2. The request entity is a JSON object specifying the regions to be obscured. Regions may be specified at study, series, or instance level; but only the highest matching level containing a regions field will be used. Example:
   { "series":{ "1.2.3.4.5":{"regions":[{"x":10,"y":10, "width":30, "height":40}]}, "1.3.5.7.9":{ "instances":{ "1.3.5.7.9.101":{"regions":[{"x":20,"y":20, "width":30, "height":20}] } } } }

1. The call must be POST
2. The request entity is a JSON object specifying the region to be cropped. Region may be specified at study, series, or instance level; but only the highest matching level containing a region field will be used. Example:
   { "series":{ "1.2.3.4.5":{"region":{"x":10,"y":10, "width":30, "height":40}}, "1.3.5.7.9":{ "instances":{ "1.3.5.7.9.101":{"region":{"x":20,"y":20, "width":30, "height":20} } } } }

1. The call must be DELETE.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
studies = getStudyList(sid, namespace[0]['uuid'])
    # Delete the cache for one study
    study = studies[0]
    requests.delete(base_url + 'host/{engine_fqdn}/api/v3/storage/study/{storage_namespace}/{study_uid}/cache?sid={sid}'.format(sid=sid, **study)

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()
                    

1. The call must be POST.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    sid = getSID(password='some_password', login='some_email')
    namespace = getNamespace(sid=sid)
    studies = getStudyList(sid, namespace[0]['uuid'])
    study = studies[1]
    fin = open(, 'rb')
    payload = {'data':fin}
    try :
        url = base_url + 'host/{0}/api/v3/storage/namespace/{1}/image?sid={2}'.format(study['engine_fqdn'], namespace[0]['uuid'], sid)
        r = requests.post(url, data=fin)
        if r.status_code == 202:
            print r.json()
        else:
            r.raise_for_status()
    finally:
        fin.close()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()

                    

1. The call must be POST.
2. render_wrapped_pdf - if optional parameter render_wrapped_pdf is set to 1, or if the account setting render_wrapped_pdf is set to 1 for the uploading account, PDF objects are rendered as DICOM images, one Explicit VR LE image per page.

import requests
import os

base_url = 'https://uat.dicomgrid.com/'

def main():
    sid = getSID(password='some_password', login='some_email')
    namespace = getNamespace(sid=sid)
    studies = getStudyList(sid, namespace[0]['uuid'])
    study = studies[1]
    fin = open(, 'rb')
    payload = {'file':fin}
    try :
        url = base_url + 'host/{0}/api/v3/storage/namespace/{1}/wrap?sid={2}'.format(study['engine_fqdn'], namespace[0]['uuid'], sid)
        file_size = os.path.getsize()
        r = requests.post(url, files=payload, headers={'X-File-Size': '{}'.format(file_size)})
        if r.status_code == 200:
            print r.json()
        else:
            r.raise_for_status()
    finally:
        fin.close()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()

                    

1. The call must be GET or HEAD.

import requests

base_url = 'https://uat.dicomgrid.com/'

def main():
    # Get SID for user
    sid = getSID(password='some_password', login='some_email')
    # Get a list containing the default account namespace
    namespace = getNamespace(sid=sid)
    # Get a list of studies
    studies = getStudyList(sid, namespace[0]['uuid'])
    # Ge study schema
    study = studies[0]
    r = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/schema?sid={3}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], sid))
    if r.status_code == 200:
        study_schema = r.json()
        # Get image attributes
        r2 = requests.get(base_url + 'host/{0}/api/v3/storage/study/{1}/{2}/image/{3}/version/{4}/cadsr?sid={5}'.format(study['engine_fqdn'], study['storage_namespace'], study['study_uid'], study_schema['series'][0]['images'][0]['id'], study_schema['series'][0]['images'][0]['version'], sid))
        if r2.status_code == 200:
            print r2.json()
        else:
            r2.raise_for_status()
    else:
        r.raise_for_status()

# Get SID from services
def getSID(password, login, *args, **kwargs):
    """ Returns an session ID for the provided username/password combination
    """
    payload = {'password': password, 'login': login}
    r = requests.post(base_url + 'api/v3/session/login', data=payload)
    if r.status_code == 200:
        print 'Session id for {0}: {1}'.format(login, r.json()['sid'])
        return r.json()['sid']
    else:
        r.raise_for_status()

def getNamespace(sid, *args, **kwargs):
    """ Returns a list with the default namespace of the account related to the sid
    """
    r = requests.get(base_url + 'api/v3/session/user?sid={0}&settings=[{1}]'.format(sid, "\"user_default_organization\""))
    if r.status_code == 200:
        account_id = r.json()['settings']['user_default_organization']
        if account_id:
            r = requests.get(base_url + '/api/v3/user/namespace/list?sid={0}&plus_phr=1&account_id={1}'.format(sid, account_id))
            return [namespaces for namespaces in r.json()['namespaces'] if namespaces['type'] =='account_id']
        else:
            raise "Error getting account id {0}".format(r.text())
    else:
        r.raise_for_status()

def getStudyList(sid, namespace, *args, **kwargs):
    """ Returns a list of studies based on the sid and namespace specified
    """
    r = requests.get(base_url + 'api/v3/study/list?sid={0}&filter.phi_namespace.equals={1}&filter.must_approve.equals=0'.format(sid, namespace))
    if r.status_code == 200:
        return r.json()['studies']
    else:
        r.raise_for_status()

if __name__ == '__main__':
    main()
                    

1. The call must be POST

1. The call must be POST

1. The call must be POST

1. The call must be GET

1. The call must be GET

1. The call must be GET