welkin.models.formation

Module Contents

Classes

FormationBase
FormationResource	dict() -> new empty dictionary
FormationCollection	Built-in mutable sequence.
Assessment	dict() -> new empty dictionary
Assessments	Built-in mutable sequence.
CDT	dict() -> new empty dictionary
CDTs	Built-in mutable sequence.
DocumentType	dict() -> new empty dictionary
DocumentTypes	Built-in mutable sequence.
EncounterDisposition	dict() -> new empty dictionary
Encounter	dict() -> new empty dictionary
Encounters	Built-in mutable sequence.
Goal	dict() -> new empty dictionary
Goals	Built-in mutable sequence.
Program	dict() -> new empty dictionary
Programs	Built-in mutable sequence.
Formation

class welkin.models.formation.FormationBase

endpoint: str

class welkin.models.formation.FormationResource

Bases: FormationBase, welkin.models.base.Resource

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

get(*args, **kwargs)

Return the value for key if key is in the dictionary, else default.

class welkin.models.formation.FormationCollection

Bases: FormationBase, welkin.models.base.Collection

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

resource

iterator

get(*args, **kwargs)

class welkin.models.formation.Assessment

Bases: FormationResource

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

endpoint = 'assessments'

class welkin.models.formation.Assessments

Bases: FormationCollection

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

resource

endpoint = 'assessments'

class welkin.models.formation.CDT

Bases: FormationResource

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

endpoint = 'cdts'

class welkin.models.formation.CDTs

Bases: FormationCollection

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

resource

endpoint = 'cdts'

class welkin.models.formation.DocumentType

Bases: FormationResource

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

endpoint = 'document-types'

class welkin.models.formation.DocumentTypes

Bases: FormationCollection

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

resource

endpoint = 'document-types'

class welkin.models.formation.EncounterDisposition

Bases: FormationResource

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

endpoint = 'encounter-disposition'

class welkin.models.formation.Encounter

Bases: FormationResource

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

endpoint = 'encounters'

class welkin.models.formation.Encounters

Bases: FormationCollection

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

resource

endpoint = 'encounters'

class welkin.models.formation.Goal

Bases: FormationResource

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

endpoint = 'goal-templates'

class welkin.models.formation.Goals

Bases: FormationCollection

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

resource

endpoint = 'goal-templates'

class welkin.models.formation.Program

Bases: FormationResource

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:

d = {} for k, v in iterable:

d[k] = v

dict(**kwargs) -> new dictionary initialized with the name=value pairs

in the keyword argument list. For example: dict(one=1, two=2)

endpoint = 'programs'

class welkin.models.formation.Programs

Bases: FormationCollection

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

resource

endpoint = 'programs'

class welkin.models.formation.Formation(version: int | str = 'current')

Bases: welkin.util.Target

Assessment

Assessments

CDT

CDTs

DocumentType

DocumentTypes

Encounter

EncounterDisposition

Encounters

Goal

Goals

Program

Programs