Public API
import { ORGANIZATION } from â@agnesuserguide/configâ;
āđāļāļĢāļāļāļēāļĢ: Heimdall āļŠāļāļāļāļē
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļāļāļļāļāļēāļāļāļēāļĢāđāļāđāļēāļāļķāļāđāļāļāļŠāļāļāļāļēāļāđāļĨāļ°āļŠāđāļāļāļ·āļāđāļāđāļāđāļ JWT āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļāļāļļāļāļēāļāļāļēāļĢāđāļāđāļēāļāļķāļāđāļāļāļŠāļāļāļāļēāļāđāļĨāļ°āļŠāđāļāļāļ·āļāđāļāđāļāđāļ JWT āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļāļāļļāļāļēāļāļāļēāļĢāđāļāđāļēāļāļķāļāđāļāļāļŠāļāļāļāļēāļāđāļĨāļ°āļŠāđāļāļāļ·āļāđāļāđāļāđāļ JWT āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļāļāļļāļāļēāļāļāļēāļĢāđāļāđāļēāļāļķāļāđāļāļāļŠāļāļāļāļēāļāđāļĨāļ°āļŠāđāļāļāļ·āļāđāļāđāļāđāļ JWT āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļāļāļļāļāļēāļāļāļēāļĢāđāļāđāļēāļāļķāļāđāļāļāļŠāļāļāļāļēāļāđāļĨāļ°āļŠāđāļāļāļ·āļāđāļāđāļāđāļ JWT āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļāļāļļāļāļēāļāļāļēāļĢāđāļāđāļēāļāļķāļāđāļāļāļŠāļāļāļāļēāļāđāļĨāļ°āļŠāđāļāļāļ·āļāđāļāđāļāđāļ JWT āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāđāļŦāđāļŠāļīāļāļāļīāđāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ āđāļāđāļāđāļāļāļģāđāļāđāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāļāļāļļāļāļēāļāđāļāļāļģāļāļ API āļāļ·āđāļāđ āļāļąāđāļāļŦāļĄāļ
ð āļāļļāļāļŠāļ°āļŠāļĄ: āļāļđāđāđāļāđ
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āļĢāļąāļāļāļđāđāđāļāđ
āļāļģāļāļāļīāļāļēāļĒ:
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļĢāļąāļāļāļēāļĢāđāđāļĢāļĒāđāļāļāļāļ§āļąāļāļāļļāļāļĩāđāļĄāļĩāļāđāļāļĄāļđāļĨāļāļđāđāđāļāđāļāļāļāļāļāļāđāļāļĢ
āļāļļāļāļŠāļĄāļāļąāļāļīāļāļāļāļ§āļąāļāļāļļ:
āļĢāļŦāļąāļŠāļāļĢāļąāļāļĒāđāļŠāļīāļ | āļĄāļđāļĨāļāđāļēāļāļĢāļąāļāļĒāđāļŠāļīāļ | āļāļģāļāļāļīāļāļēāļĒ |
---|---|---|
āļāļāļāđāļāļĢ | āļŠāļāļĢāļīāļ UUID | āļĢāļŦāļąāļŠāļāļāļāđāļāļĢāļŦāļĨāļąāļāļāļāļāļāļđāđāđāļāđ |
āļĒāđāļāļĒ | āļŠāļāļĢāļīāļ UUID | āļŦāļĄāļēāļĒāđāļĨāļāļŠāļĄāļēāļāļīāļāļāļāļāļāļđāđāđāļāđ āļŦāļĄāļēāļĒāđāļĨāļāļŠāļĄāļēāļāļīāļāļāļāļāļāļđāđāđāļāđ āļŦāļĄāļēāļĒāđāļĨāļāļŠāļĄāļēāļāļīāļāļāļāļāļāļđāđāđāļāđ āđāļāđāļŠāļģāļŦāļĢāļąāļāđāļāđāļāļāļąāļ§āļĢāļ°āļāļļāđāļāļāļēāļ°āļŠāļģāļŦāļĢāļąāļāļāļđāđāđāļāđ āļŦāļĄāļēāļĒāđāļĨāļāļŠāļĄāļēāļāļīāļāļāļāļāļāļđāđāđāļāđ āļŦāļĄāļēāļĒāđāļĨāļāļŠāļĄāļēāļāļīāļāļāļāļāļāļđāđāđāļāđ āđāļāđāļŠāļģāļŦāļĢāļąāļāđāļāđāļāļāļąāļ§āļĢāļ°āļāļļāđāļāļāļēāļ°āļŠāļģāļŦāļĢāļąāļāļāļđāđāđāļāđ |
āļāļ·āđāļāļāļĢāļīāļ | āļŠāļāļĢāļīāļ | āļāļ·āđāļāļāļĢāļīāļāļāļāļāļāļđāđāđāļāđ |
āļāļēāļĄāļŠāļāļļāļĨ | āļŠāļāļĢāļīāļ | āļāļēāļĄāļŠāļāļļāļĨāļāļāļāļāļđāđāđāļāđ |
āļāļāļāļēāļ | āļŠāļāļĢāļīāļ | āļāļāļāļēāļāļāļāļāļāļđāđāđāļāđāļ āļēāļĒāđāļāļĢāļ°āļāļ āļāļāļāļēāļāļāļāļāļāļđāđāđāļāđāđāļāļĢāļ°āļāļ âāļāļđāđāđāļāđâ, âāļāļđāđāļāļđāđāļĨāļĢāļ°āļāļâ, âāļĢāļ°āļāļâ āļāļāļāļēāļāļāļāļāļāļđāđāđāļāđāđāļāļĢāļ°āļāļ âāļāļđāđāđāļāđâ, âāļāļđāđāļāļđāđāļĨāļĢāļ°āļāļâ, âāļĢāļ°āļāļâ āļāļāļāļēāļāļāļāļāļāļđāđāđāļāđāđāļāļĢāļ°āļāļ âāļāļđāđāđāļāđâ, âāļāļđāđāļāļđāđāļĨāļĢāļ°āļāļâ, âāļĢāļ°āļāļâ āļāļāļāļēāļāļāļāļāļāļđāđāđāļāđāđāļāļĢāļ°āļāļ âāļāļđāđāđāļāđâ, âāļāļđāđāļāļđāđāļĨāļĢāļ°āļāļâ, âāļĢāļ°āļāļâ āļāļāļāļēāļāļāļāļāļāļđāđāđāļāđāđāļāļĢāļ°āļāļ âāļāļđāđāđāļāđâ, âāļāļđāđāļāļđāđāļĨāļĢāļ°āļāļâ, âāļĢāļ°āļāļâ āļāļāļāļēāļāļāļāļāļāļđāđāđāļāđāđāļāļĢāļ°āļāļ âāļāļđāđāđāļāđâ, âāļāļđāđāļāļđāđāļĨāļĢāļ°āļāļâ, âāļĢāļ°āļāļâ āļāļāļāļēāļāļāļāļāļāļđāđāđāļāđāđāļāļĢāļ°āļāļ âāļāļđāđāđāļāđâ, âāļāļđāđāļāļđāđāļĨāļĢāļ°āļāļâ, âāļĢāļ°āļāļâ āļāļāļāļēāļāļāļāļāļāļđāđāđāļāđāđāļāļĢāļ°āļāļ âāļāļđāđāđāļāđâ, âāļāļđāđāļāļđāđāļĨāļĢāļ°āļāļâ, âāļĢāļ°āļāļâ āļāļāļāļēāļāļāļāļāļāļđāđāđāļāđāđāļāļĢāļ°āļāļ âāļāļđāđāđāļāđâ, âāļāļđāđāļāļđāđāļĨāļĢāļ°āļāļâ, âāļĢāļ°āļāļâ āļāļāļāļēāļāļāļāļāļāļđāđāđāļāđāđāļāļĢāļ°āļāļ âāļāļđāđāđāļāđâ, âāļāļđāđāļāļđāđāļĨāļĢāļ°āļāļâ, âāļĢāļ°āļāļâ āļāļāļāļēāļāļāļāļāļāļđāđāđāļāđāđāļāļĢāļ°āļāļ âāļāļđāđāđāļāđâ, âāļāļđāđāļāļđāđāļĨāļĢāļ°āļāļâ, âāļĢāļ°āļāļâ |
npi | āļāļąāļ§āđāļĨāļāļŠāļīāļāļŦāļĨāļąāļāđāļāđāļāļŠāļāļĢāļīāļ | āļāļąāļ§āļĢāļ°āļāļļāļāļđāđāđāļŦāđāļāļĢāļīāļāļēāļĢāđāļŦāđāļāļāļēāļāļī āļāļ·āļāļŦāļĄāļēāļĒāđāļĨāļāļāļĢāļ°āļāļģāļāļąāļ§ 10 āļŦāļĨāļąāļāļāļĩāđāļāļāļāđāļŦāđāļāļąāļāļāļđāđāđāļŦāđāļāļĢāļīāļāļēāļĢāļāđāļēāļāļŠāļļāļāļ āļēāļāđāļāļŠāļŦāļĢāļąāļāļāđāļĄāļĢāļīāļāļēāđāļāļĒ Centers for Medicare āđāļĨāļ° Medicaid Services |
āļāļąāļ§āļāļĒāđāļēāļāļ§āļąāļāļāļļāļŠāđāļāļāļ·āļ JSON:
[
{
"org": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"sub": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"username": "frodobaggins@email.com",
"firstname": "Frodo",
"lastname": "Baggins",
"role": "user",
"npi": null
},
{
"org": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"sub": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"username": "bilbobaggins@email.com",
"firstname": "Bilbo",
"lastname": "Baggins",
"role": "administrator",
"npi": null
}
]
āļ§āļīāļāļĩāļāļēāļĢ: GET
{{baseUrl}}/api/v1/org/{{orgId}}/users
āđāļāļāļŠāļāļāļāļēāļĄ Params
āļāļēāļĢāļē | āļāđāļē |
---|---|
āļĒāđāļāļĒ | {{$guid}} |
āļāļĨāļļāđāļĄ | {{$guid}} |
ð āļāļļāļāļŠāļ°āļŠāļĄ: āļāļāļĢāđāļāļąāļĨ
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āļĢāļąāļāļāļāļĢāđāļāļąāļĨ
āļāļģāļāļāļīāļāļēāļĒ:
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļĢāļąāļāļāļēāļĢāđāđāļĢāļĒāđāļāļāļāļāđāļāļāđāļāđāļāļāđāļāļĩāđāļĄāļĩāļāđāļāļĄāļđāļĨāļāļāļĢāđāļāļąāļĨāļāļāļāļāļāļāđāļāļĢ
āļāļāļĢāđāļāļąāļĨāđāļāđāļāļāļąāļ§āđāļāļāđāļŠāļĄāļ·āļāļāļāļāļāļāļāļĄāļāļīāļ§āđāļāļāļĢāđāļāļđāđāđāļāđāļāļĩāđāļĨāļāļāļ°āđāļāļĩāļĒāļāđāļāļĢāļ°āļāļ
āļāļļāļāļŠāļĄāļāļąāļāļīāļāļāļāļ§āļąāļāļāļļ:
āļĢāļŦāļąāļŠāļāļĢāļąāļāļĒāđāļŠāļīāļ | āļĄāļđāļĨāļāđāļēāļāļĢāļąāļāļĒāđāļŠāļīāļ | āļāļģāļāļāļīāļāļēāļĒ |
---|---|---|
āļāđāļāļĄāļđāļĨ | āļŠāļāļĢāļīāļ UUID | āļāđāļāļĄāļđāļĨ |
āļāļąāļ§āļāļĒāđāļēāļāļ§āļąāļāļāļļāļŠāđāļāļāļ·āļ JSON:
[
{
"data": "data"
},
{
"data": "data"
}
]
āļ§āļīāļāļĩāļāļēāļĢ: GET
{{baseUrl}}/api/v1/org/{{orgId}}/portals
ð āļāļāļĨāđāļĨāļāļāļąāļ: āļāļĨāļļāđāļĄ
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āļĢāļąāļāļāļĨāļļāđāļĄ
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļĢāļąāļāļāļēāļĢāđāđāļĢāļĒāđāļāļāļāļ§āļąāļāļāļļāļāļĩāđāļĄāļĩāļāđāļāļĄāļđāļĨāļāļĨāļļāđāļĄāļāļēāļĢāļāļąāļāļĢāļ°āđāļāļĩāļĒāļ
āļ§āļīāļāļĩāļāļēāļĢ: GET
{{baseUrl}}/api/v1/org/{{orgId}}/groups
āļāļāļāļāļĨāļąāļ: 200
[
{
"id": "3s5*****-****-****-****-************",
"org": "7ag*****-****-****-****-************",
"name": "Administrators",
"meta": {},
"members": []
},
{
"id": "9sd*****-****-****-****-************",
"org": "53f*****-****-****-****-************",
"name": "Test",
"meta": {},
"members": ["9ba*****-****-****-****-************"]
}
]
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āļŠāļĢāđāļēāļāļāļĨāļļāđāļĄ
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļŠāļĢāđāļēāļāļāļĨāļļāđāļĄāđāļŦāļĄāđāđāļāļāļāļāđāļāļĢ
āļ§āļīāļāļĩāļāļēāļĢ: POST
{{baseUrl}}/api/v1/org/{{orgId}}/groups
āļĢāđāļēāļāļāļēāļĒ (āļāļīāļ)
{
"name": "{{$randomAdjective}} {{$randomNoun}}",
"meta": {},
"members": []
}
āļāļāļāļāļĨāļąāļ: 200
{
"id": "04a*****-****-****-****-************",
"org": "040*****-****-****-****-************",
"name": "back-end hard drive",
"meta": {
"meta": {}
},
"members": []
}
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āļĢāļąāļāļāļĨāļļāđāļĄāļāļēāļĄ ID
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļĢāļąāļāļ§āļąāļāļāļļāļāļĩāđāļĄāļĩāļāđāļāļĄāļđāļĨāļŠāļģāļŦāļĢāļąāļāļāļĨāļļāđāļĄāļāļĩāđāļĢāļ°āļāļļāđāļāļāļāļāđāļāļĢ
āļ§āļīāļāļĩāļāļēāļĢ: GET
{{baseUrl}}/api/v1/org/{{orgId}}/groups?id={{temporaryGroupId}}
āđāļāļāļŠāļāļāļāļēāļĄ Params
āļāļēāļĢāļē | āļāđāļē |
---|---|
āļĢāļŦāļąāļŠ | {{temporaryGroupId}} |
āļĢāļŦāļąāļŠ | 717e4c96-847b-4b87-b22e-8488a7802d9a |
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āđāļāđāđāļāļāļĨāļļāđāļĄ
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāđāļāđāđāļāļāđāļāļĄāļđāļĨāļŠāļģāļŦāļĢāļąāļāļāļĨāļļāđāļĄāļāļĩāđāļĢāļ°āļāļļāđāļāļāļāļāđāļāļĢ
āļ§āļīāļāļĩāļāļēāļĢ: PATCH
{{baseUrl}}/api/v1/org/{{orgId}}/groups/{{temporaryGroupId}}
āļĢāđāļēāļāļāļēāļĒ (āļāļīāļ)
{
"name": "{{$randomAdjective}} {{$randomNoun}}",
"meta": {},
"members": ["{{userId}}"]
}
āļāļāļāļāļĨāļąāļ: 204
null
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āļĨāļ Group
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļĨāļāļāļĨāļļāđāļĄāļāļĩāđāļĢāļ°āļāļļāđāļāļāļāļāđāļāļĢ
āļ§āļīāļāļĩāļāļēāļĢ: DELETE
{{baseUrl}}/api/v1/org/{{orgId}}/groups/{{temporaryGroupId}}
ð āļāļāļĨāđāļĨāļāļāļąāļ: āļāļģāļŦāļāļāļāļēāļĢ
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āļĢāļąāļāļāļģāļŦāļāļāļāļēāļĢ
āļāļģāļāļāļīāļāļēāļĒ:
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļĢāļąāļāļāļēāļĢāđāđāļĢāļĒāđāļāļāļāļāļāļāđāļāđāļāļāđāļāļĩāđāļĄāļĩāļāđāļāļĄāļđāļĨāļāļēāļĢāļāļąāļāļŦāļĄāļēāļĒāļāļēāļĄāļāļģāļŦāļāļāļāļēāļĢāļāļāļāļāļāļāđāļāļĢ
āļŠāđāļāļāļ·āļāļāļļāļāļŠāļĄāļāļąāļāļīāļāļāļāļ§āļąāļāļāļļ:
āļĢāļŦāļąāļŠāļāļĢāļąāļāļĒāđāļŠāļīāļ | āļĄāļđāļĨāļāđāļēāļāļĢāļąāļāļĒāđāļŠāļīāļ | āļāļģāļāļāļīāļāļēāļĒ |
---|---|---|
āļāļđāđāđāļŦāđāļāļĢāļīāļāļēāļĢ | āļŠāļāļĢāļīāļ UUID | āļĢāļŦāļąāļŠāđāļāļāļĒāđāļāļĩāđāđāļāđāļāđāļāđāļēāļ āļēāļāđāļāļŠāļāļąāđāļ āļāļķāļāļāđāļāļĄāļđāļĨāļāļēāļāļāļļāļāļŠāļĄāļāļąāļāļī āļĒāđāļāļĒ āļāļāļāļāļđāđāđāļāđ |
āļāļāļāļ | āļ§āļąāļāļāļļ | āļ§āļąāļāļāļļāļāļĩāđāļĄāļĩāļāļļāļāļŠāļĄāļāļąāļāļīāļāļĩāđāļāļāļīāļāļēāļĒāļāļđāđāļāđāļ§āļĒ |
āļāļāđāļāđ.patientID | āļŠāļāļĢāļīāļ | āļāļąāļ§āļĢāļ°āļāļļāđāļāļāļēāļ°āļŠāļģāļŦāļĢāļąāļāļāļđāđāļāđāļ§āļĒ |
āļāļēāļĄāļŠāļāļļāļĨāļāļāļāļāļđāđāļāđāļ§āļĒ | āļŠāļāļĢāļīāļ | āļāļ·āđāļāļāļđāđāļāđāļ§āļĒ. |
āļāļāđāļāđ.āļāļēāļĄāļŠāļāļļāļĨ | āļŠāļāļĢāļīāļ | āļāļāđāļāđ.āļāļ·āđāļāļāļĢāļīāļ |
āļāļāđāļāđ.āļ§āļąāļāđāļāļīāļ | āļ§āļąāļāļāļĩāđāđāļāļĢāļđāļāđāļāļāļāļĩāđāļāļ·āļāļāļ§āļąāļāļāļĩāđ : YYYY-MM-DD | āļ§āļąāļāđāļāļ·āļāļāļāļĩāđāļāļīāļāļāļāļāļāļđāđāļāđāļ§āļĒ |
āļāļāđāļāđ.āđāļāđāļāļŠāđ | āļŠāļāļĢāļīāļ | āļāļąāļ§āļĢāļ°āļāļļāļāļēāļāļāļĩāļ§āļ āļēāļāļŠāļģāļŦāļĢāļąāļāļāļđāđāļāđāļ§āļĒ āļāļąāļ§āļāđāļāļāļĩāđāļāļēāļāļāļĩāļ§āļ āļēāļāļŠāļģāļŦāļĢāļąāļāļāļđāđāļāđāļ§āļĒ âMâ āļŦāļĢāļ·āļ âFâ |
āļĢāļŦāļąāļŠāđāļāļŠāļāļąāļ | āļŠāļāļĢāļīāļ UUID | āļĢāļŦāļąāļŠāđāļāļāļēāļ°āļāļĩāđāđāļāļ·āđāļāļĄāļāđāļāļāļēāļĢāļāļąāļāļŦāļĄāļēāļĒāļāļēāļĄāļāļģāļŦāļāļāđāļ§āļĨāļēāļāļąāļāļāđāļāļĄāļđāļĨāļāļđāđāļāđāļ§āļĒ āļāļēāļĢāļĢāļ°āļāļļāļĢāļŦāļąāļŠāđāļāļŠāļāļąāļāđāļĄāļ·āđāļāđāļāđāļēāļĢāđāļ§āļĄāļāļāļĢāđāļāļąāļĨāļāļ°āļāļķāļāļāđāļāļĄāļđāļĨāļāļđāđāļāđāļ§āļĒāļāļĩāđāđāļāļĩāđāļĒāļ§āļāđāļāļāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāļāļąāļāļŦāļĄāļēāļĒāļāļēāļĄāļāļģāļŦāļāļāđāļ§āļĨāļē āļŦāļēāļāđāļĄāđāđāļāđāđāļŦāđāļāđāļāļĄāļđāļĨāļāļđāđāļāđāļ§āļĒāđāļĄāļ·āđāļāļŠāļĢāđāļēāļāļāļēāļĢāļāļąāļāļŦāļĄāļēāļĒāļāļēāļĄāļāļģāļŦāļāļāļāļēāļĢ āļāļ°āđāļĄāđāļĄāļĩāļāļēāļĢāļāļķāļāļāđāļāļĄāļđāļĨāđāļāđāļēāļĄāļē |
āļĢāļŦāļąāļŠāļāļāļĢāđāļāļąāļĨ | āļāļąāļ§āđāļĨāļ 64 āļŦāļĨāļąāļ | ID āļāļāļĢāđāļāļąāļĨāļāļĩāđāļĄāļĩāļāļģāļŦāļāļāļāļēāļĢāļāļąāļāļŦāļĄāļēāļĒ |
āđāļ§āļĨāļēāđāļĢāļīāđāļĄāļāđāļ | āļ§āļąāļāļāļĩāđāļāļąāļāļĢāļđāļāđāļāļ ISO | āđāļ§āļĨāļēāđāļĢāļīāđāļĄāļāđāļāļāļāļāđāļ§āļĨāļēāļāļąāļāļŦāļĄāļēāļĒāļāļĩāđāļāļģāļŦāļāļ |
āļŦāļĒāļļāļāđāļ§āļĨāļē | āļ§āļąāļāļāļĩāđāļāļąāļāļĢāļđāļāđāļāļ ISO | āđāļ§āļĨāļēāļŠāļīāđāļāļŠāļļāļāļāļāļāļāļēāļĢāļāļąāļāļŦāļĄāļēāļĒāļāļēāļĄāļāļģāļŦāļāļāļāļēāļĢ |
āļāļąāļ§āļāļĒāđāļēāļāļ§āļąāļāļāļļāļŠāđāļāļāļ·āļ JSON:
[
{
"providerId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"patient": {
"patientId": "c",
"firstName": "Larry",
"lastName": "Friesen",
"birthDate": "2001-12-02",
"sex": "M"
},
"sessionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"portalId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
"startTime": "2021-12-02T06:07:49.000Z",
"stopTime": "2021-12-02T08:00:24.000Z"
}
]
āļ§āļīāļāļĩāļāļēāļĢ: GET
{{baseUrl}}/api/v1/org/{{orgId}}/schedule?startDate=2021-01-01&perPage=10&page=0
āđāļāļāļŠāļāļāļāļēāļĄ Params
āļāļēāļĢāļē | āļāđāļē |
---|---|
āļ§āļąāļāļāļĩāđāđāļĢāļīāđāļĄāļāđāļ | 2021-01-01 |
āļŦāļĒāļļāļāļ§āļąāļāļāļĩāđ | 2021-12-03 |
āļāđāļāļŦāļāđāļē | 10 |
āļŦāļāđāļēāļŦāļāļąāļāļŠāļ·āļ | 0 |
āļāļāļĢāđāļāļąāļĨ.name | āđāļāļāļāļāļāļēāđāļāđāļĨāļāļĨāļīāļāļīāļ |
āļāļāļāļāļĨāļąāļ: 200
[]
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āļŠāļĢāđāļēāļāļĢāļēāļĒāļāļēāļĢāļāļģāļŦāļāļāļāļēāļĢ
āļāļģāļāļāļīāļāļēāļĒ:
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļŠāļĢāđāļēāļāļāļēāļĢāļāļąāļāļŦāļĄāļēāļĒāļāļēāļĄāļāļģāļŦāļāļāļāļēāļĢāđāļŦāļĄāđāļŠāļģāļŦāļĢāļąāļāļāļāļāđāļāļĢ
āļŠāđāļāļāļ·āļāļāļļāļāļŠāļĄāļāļąāļāļīāļāļāļāļ§āļąāļāļāļļ:
āļāļĢāļīāļ āļāđāļēāļŠāļĢāđāļēāļāļāļēāļĢāļāļąāļāļŦāļĄāļēāļĒāļāļēāļĄāļāļģāļŦāļāļāđāļ§āļĨāļēāļŠāļģāđāļĢāđāļ
āđāļāđāļ āļāđāļēāļŠāļĢāđāļēāļāļāļēāļĢāļāļąāļāļŦāļĄāļēāļĒāļāļēāļĄāļāļģāļŦāļāļāđāļ§āļĨāļēāļŠāļģāđāļĢāđāļ
āļāļąāļ§āļāļĒāđāļēāļāļ§āļąāļāļāļļāļŠāđāļāļāļ·āļ JSON:
true
āļ§āļīāļāļĩāļāļēāļĢ: PUT
{{baseUrl}}/api/v1/org/{{orgId}}/schedule
āļĢāđāļēāļāļāļēāļĒ (āļāļīāļ)
{
"providerId": "{{userId}}",
"patient": {
"patientId": "{{$randomAlphaNumeric}}",
"firstName": "{{$randomFirstName}}",
"lastName": "{{$randomLastName}}",
"birthDate": "{{randomDatePast}}",
"sex": "M"
},
"sessionId": "{{$randomUUID}}",
"portalId": "{{portalId}}",
"startTime": "{{$randomDateRecent}}",
"stopTime": "{{$randomDateRecent}}"
}
āļāļāļāļāļĨāļąāļ: 200
true
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āļĢāļąāļāļĢāļēāļĒāļāļēāļĢāļāļģāļŦāļāļāļāļēāļĢāļāļēāļĄ ID
āļāļģāļāļāļīāļāļēāļĒ:
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļĢāļąāļāļāļāļāđāļāđāļāļāđāļāļĩāđāļĄāļĩāļāđāļāļĄāļđāļĨāļŠāļģāļŦāļĢāļąāļāļāļēāļĢāļāļąāļāļŦāļĄāļēāļĒāļāļēāļĄāļāļģāļŦāļāļāđāļ§āļĨāļēāļāļĩāđāļĢāļ°āļāļļāļāļāļāļāļāļāđāļāļĢ
āļŠāđāļāļāļ·āļāļāļļāļāļŠāļĄāļāļąāļāļīāļāļāļāļ§āļąāļāļāļļ:
āļĢāļŦāļąāļŠāļāļĢāļąāļāļĒāđāļŠāļīāļ | āļĄāļđāļĨāļāđāļēāļāļĢāļąāļāļĒāđāļŠāļīāļ | āļāļģāļāļāļīāļāļēāļĒ |
---|---|---|
āļāđāļāļĄāļđāļĨ | āļāđāļāļĄāļđāļĨ | āļāđāļāļĄāļđāļĨ |
āļāļąāļ§āļāļĒāđāļēāļāļ§āļąāļāļāļļāļŠāđāļāļāļ·āļ JSON:
{
// TODO
}
āļ§āļīāļāļĩāļāļēāļĢ: GET
{{baseUrl}}/api/v1/org/{{orgId}}/schedule/{{temporaryScheduleId}}
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āļĨāļāļĢāļēāļĒāļāļēāļĢāļāļģāļŦāļāļāļāļēāļĢ
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļĨāļāļāļēāļĢāļāļąāļāļŦāļĄāļēāļĒāļāļēāļĄāļāļģāļŦāļāļāļāļēāļĢāļāļĩāđāļĢāļ°āļāļļāđāļāļāļāļāđāļāļĢ
āļ§āļīāļāļĩāļāļēāļĢ: DELETE
{{baseUrl}}/api/v1/org/{{orgId}}/schedule/{{temporaryScheduleId}}
āļāļāļāļāļĨāļąāļ: 200
{
"sessionId": "1560f626-117f-4263-a068-46963357f30a",
"providerId": null,
"portalId": "8ad982843f36037b16450dd99c48663ecb6e031364241f146a906642efa9e101",
"startTime": "2021-12-02T06:07:49.000Z",
"stopTime": "2021-12-02T08:00:24.000Z",
"meta": "{\"providerId\":\"b2f8d193-4e72-4d76-9dbf-677c86786ecb\",\"patient\":{\"patientId\":\"c\",\"firstName\":\"Larry\",\"lastName\":\"Friesen\",\"birthDate\":\"{{randomDatePast}}\",\"sex\":\"M\"}}"
}
ð āļāļļāļāļŠāļ°āļŠāļĄ: āļāļāļāđāļāļĢ
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āļĢāļąāļāļāļāļāđāļāļĢ
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļĢāļąāļāļāļāļāđāļāđāļāļāđāļāļĩāđāļĄāļĩāđāļāļāļāļĢāļīāļāļīāļ§āļāđāļāđāļāļĄāļđāļĨāļŠāļģāļŦāļĢāļąāļāļāļāļāđāļāļĢ
āļāļąāļ§āļāļĒāđāļēāļāļ§āļąāļāļāļļāļāļāļāļŠāļāļāļ:
[
{
"id": "2xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"parent": "0xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"children": ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
"name": "{ORGANIZATION.names.short} Demo Child",
"slug": "{ORGANIZATION.names.short}-demo-child",
"config": {
"emr_provider": "redox",
"datascan": {
"api": {
"token": ""
}
},
"ldap": {
"url": null,
"bindDN": null,
"bindCredentials": null,
"searchBase": "",
"adminGroupDN": "",
"users": {
"class": "inetOrgPerson",
"subAttribute": "",
"usernameAttribute": ""
},
"groups": {
"class": "groupOfUniqueNames",
"idAttribute": "dn",
"nameAttribute": "cn",
"memberAttribute": "uniqueMember"
}
},
"emr_provider_org": null,
"logo": null,
"pcc": {
"clientId": "",
"clientSecret": ""
},
"identity_provider": "amd",
"azuread": {
"client_id": "",
"client_secret": "",
"tenant": "",
"admin_group": "",
"npi_claim": "sub"
},
"agnes": {
"whitelabel": "",
"webPageTimeout": 15,
"maxUsers": 2,
"leftWindow": "medicalvideo",
"rightWindow": null,
"iframes": [],
"modules": {
"chat": {
"enabled": true
},
"notes": {
"enabled": true,
"templates": []
},
"sessiondocs": {
"coverLogoHeight": 0,
"headerLogoHeight": 0
},
"vc": {
"enabled": true,
"force": false,
"iceTransportPolicy": "all"
},
"vitals": {
"enabled": true,
"temperatureUnits": "fahrenheit",
"bloodpressureUnits": "mmhg",
"heightUnits": "inches",
"weightUnits": "pounds"
}
}
},
"identity_provider_org": null,
"redox": {
"destination_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"patient": {
"id_type": "EHRID"
}
}
},
"metadata": {
"emr_provider": "redox",
"emr_provider_org": null
}
},
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"parent": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"children": [],
"name": "I am a sibling organization",
"slug": "sibling",
"config": {},
"metadata": {
"emr_provider": null,
"emr_provider_org": null
}
},
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
"parent": null,
"children": ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
"name": "{ORGANIZATION.names.short} Demo",
"slug": "{ORGANIZATION.names.short}-demo",
"config": {
"agnes": {
"webPageTimeout": 1500,
"maxUsers": 99,
"modules": {
"notes": {
"templates": [
{
"template": "Telemedicine Patient Intake Form\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location: Chelmsford MA 01824\nLocal Provider: {{user.fname}} {{user.lname}} \n\nChief Complaint/Reason for visit: \n\nVital Signs \n-SpO2: {{vitals.spo2}} -Pulse: {{vitals.pulse}} \n-Blood Pressure: {{vitals.bloodpressure}} -Temperature: {{vitals.temperature}} -Height: {{vitals.height}} -Weight: {{vitals.weight}} \n-Blood Glucose (mg/dL): \n\nAdditional Encounter Notes:",
"name": "Patient Intake Form"
},
{
"template": "Telemedicine Provider Encounter Notes\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location: Chelmsford MA 01824\nObserving Provider: {{user.fname}} {{user.lname}} \n\nChief Complaint of patient:\n\nDiagnosis:\n\nTreatment Plan:\n\nAdditional Encounter Notes:",
"name": "Provider Encounter Notes"
}
]
},
"vitals": {
"temperatureUnits": "celsius"
}
},
"whitelabel": null,
"iframes": [],
"rightWindow": "videoconference",
"leftWindow": "documents"
},
"logo": "url",
"identity_provider": "amd",
"emr_provider_org": "'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'",
"identity_provider_org": "''",
"emr_provider": "redox"
},
"metadata": {
"emr_provider": "redox",
"emr_provider_org": "'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'"
}
}
]
āļ§āļīāļāļĩāļāļēāļĢ: GET
{{baseUrl}}/api/v1/org?page=0
āđāļāļāļŠāļāļāļāļēāļĄ Params
āļāļēāļĢāļē | āļāđāļē |
---|---|
āļŦāļāđāļēāļŦāļāļąāļāļŠāļ·āļ | 0 |
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āļŠāļĢāđāļēāļāļāļāļāđāļāļĢ
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļŠāļĢāđāļēāļāļāļāļāđāļāļĢāđāļŦāļĄāđ
āļ§āļīāļāļĩāļāļēāļĢ: PUT
{{baseUrl}}/api/v1/org
āļĢāđāļēāļāļāļēāļĒ (āļāļīāļ)
{
"id": "{{$randomUUID}}",
"name": "{{$randomAdjective}} {{$randomNoun}}",
"slug": "{{$randomCatchPhraseNoun}}",
"parent": "{{orgId}}",
"config": {
"agnes": {
"webPageTimeout": 1500,
"maxUsers": 99,
"modules": {
"notes": {
"templates": [
{
"template": "Telemedicine Patient Intake Form\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location: Chelmsford MA 01824\nLocal Provider: {{user.fname}} {{user.lname}} \n\nChief Complaint/Reason for visit: \n\nVital Signs \n-SpO2: {{vitals.spo2}} -Pulse: {{vitals.pulse}} \n-Blood Pressure: {{vitals.bloodpressure}} -Temperature: {{vitals.temperature}} -Height: {{vitals.height}} -Weight: {{vitals.weight}} \n-Blood Glucose (mg/dL): \n\nAdditional Encounter Notes:",
"name": "Patient Intake Form"
},
{
"template": "Telemedicine Provider Encounter Notes\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location: Chelmsford MA 01824\nObserving Provider: {{user.fname}} {{user.lname}} \n\nChief Complaint of patient:\n\nDiagnosis:\n\nTreatment Plan:\n\nAdditional Encounter Notes:",
"name": "Provider Encounter Notes"
}
]
},
"vitals": {
"temperatureUnits": "celsius"
}
},
"whitelabel": null,
"iframes": [],
"rightWindow": "videoconference",
"leftWindow": "documents"
},
"logo": "https://agnes-connect.s3.amazonaws.com/logos/04036433-63cf-4823-b222-af007005720b",
"identity_provider": "amd",
"emr_provider_org": "{{$randomUUID}}",
"identity_provider_org": "{{$randomUUID}}",
"emr_provider": "redox"
},
"metadata": {
"emr_provider": "redox",
"emr_provider_org": "{{$randomUUID}}"
}
}
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āļĢāļąāļāļāļāļāđāļāļĢāļāđāļ§āļĒ ID
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļĢāļąāļāļāļāļāđāļāđāļāļāđāļāļĩāđāļĄāļĩāļāđāļāļĄāļđāļĨāļŠāļģāļŦāļĢāļąāļāļāļāļāđāļāļĢāļāļĩāđāļĢāļ°āļāļļ
āļ§āļīāļāļĩāļāļēāļĢ: GET
{{baseUrl}}/api/v1/org/{{temporaryOrgId}}
āļāļāļāļāļĨāļąāļ: 200
{
"name": "1080p panel",
"id": "9038420b-c49c-4b76-b87d-94052ba4c4df",
"slug": "groupware",
"config": {
"logo": "https://agnes-connect.s3.amazonaws.com/logos/04036433-63cf-4823-b222-af007005720b"
}
}
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āđāļāđāđāļāļāļāļāđāļāļĢāļāđāļ§āļĒ ID
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāđāļāđāđāļāđāļāļāļāļĢāļīāļāļīāļ§āļāđāļāđāļāļĄāļđāļĨāļāļāļāļāļāļāđāļāļĢāļāļĩāđāļĢāļ°āļāļļ āļāļģāļāļāļāļ°āļāļģāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āđāļāđ API āļāļĩāđāđāļāļ·āđāļāđāļāđāđāļāđāļāļāļāļĢāļīāļāļīāļ§āļāđāļāđāļāļĄāļđāļĨāļāļāļāļāļāļāđāļāļĢāļāļĩāđāļĢāļ°āļāļļ āļāļģāļāļāļāļ°āļāļģāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āđāļāđ API āļāļĩāđāđāļāļ·āđāļāđāļāđāđāļāđāļāļāļāļĢāļīāļāļīāļ§āļāđāļāđāļāļĄāļđāļĨāļāļāļāļāļāļāđāļāļĢāļāļĩāđāļĢāļ°āļāļļ āļāļģāļāļāļāļ°āļāļģāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āđāļāđ API āļāļĩāđāđāļāļ·āđāļāđāļāđāđāļāđāļāļāļāļĢāļīāļāļīāļ§āļāđāļāđāļāļĄāļđāļĨāļāļāļāļāļāļāđāļāļĢāļāļĩāđāļĢāļ°āļāļļ āļāļģāļāļāļāļ°āļāļģāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āđāļāđ API āļāļĩāđāđāļāļ·āđāļāđāļāđāđāļāđāļāļāļāļĢāļīāļāļīāļ§āļāđāļāđāļāļĄāļđāļĨāļāļāļāļāļāļāđāļāļĢāļāļĩāđāļĢāļ°āļāļļ āļāļģāļāļāļāļ°āļāļģāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđ ID āļāļāļāļāļāļāđāļāļĢ
āļ§āļīāļāļĩāļāļēāļĢ: PATCH
{{baseUrl}}/api/v1/org/{{temporaryOrgId}}
āļĢāđāļēāļāļāļēāļĒ (āļāļīāļ)
{
"id": "{{temporaryOrgId}}",
"name": "{ORGANIZATION.names.short} Mod",
"slug": "{ORGANIZATION.names.short}-mod"
}
āļāļāļāļāļĨāļąāļ: 403
{
"type": "ForbiddenError",
"message": "Forbidden",
"stack": "ForbiddenError: Forbidden\n at assert (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/http-assert/index.js:8:9)\n at patchOrganizations (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/api/v1/actions/organization/patch.js:24:9)\n at runMicrotasks (<anonymous>)\n at processTicksAndRejections (internal/process/task_queues.js:93:5)\n at async nocacheMiddleware (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koajs-nocache/index.js:29:5)\n at async bodyParser (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-bodyparser/index.js:95:5)\n at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/api/v1/index.js:18:13\n at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:58:5\n at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/oidc-provider/lib/helpers/initialize_app.js:246:5\n at async errorHandler (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/oidc-provider/lib/shared/error_handler.js:23:7)\n at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:52:26\n at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:52:26\n at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:52:26\n at async serve (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-static/index.js:53:9)\n at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/index.js:72:17\n at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-compress/index.js:43:5\n at async logger (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-logger/index.js:67:7)\n at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/index.js:49:13"
}
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āļĨāļāļāļāļāđāļāļĢāļāđāļ§āļĒ ID
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļĨāļāļāļāļāđāļāļĢāļāļĩāđāļĢāļ°āļāļļāļāđāļ§āļĒ ID
āļ§āļīāļāļĩāļāļēāļĢ: DELETE
{{baseUrl}}/api/v1/org/{{temporaryOrgId}}
āļāļāļāļāļĨāļąāļ: 204
null
āļāļļāļāļŠāļīāđāļāļŠāļļāļ: āļĢāļąāļāļāļāļāđāļāļĢāđāļāļĒ Slug
āđāļāđ API āļāļĩāđāđāļāļ·āđāļāļĢāļąāļāļāļāļāđāļāđāļāļāđāļāļĩāđāļĄāļĩāđāļāļāļāļĢāļīāļāļīāļ§āļāđāļāđāļāļĄāļđāļĨāļāļāļāļāļāļāđāļāļĢāļāļĩāđāļĢāļ°āļāļļ āļāļģāļāļāļāļģāđāļāļĒāđāļāđāļāļĢāļ°āļŠāļļāļāļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđāļāļĢāļ°āļŠāļļāļāļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđāļāļĢāļ°āļŠāļļāļāļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđāļāļĢāļ°āļŠāļļāļāļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđāļāļĢāļ°āļŠāļļāļāļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđāļāļĢāļ°āļŠāļļāļāļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđāļāļĢāļ°āļŠāļļāļāļāļāļāļāļāļāđāļāļĢ āļāļģāļāļāļāļđāļāļŠāļĢāđāļēāļāļāļķāđāļāđāļāļĒāđāļāđāļāļēāļāļāļāļāļāļāļāđāļāļĢ
āļ§āļīāļāļĩāļāļēāļĢ: GET
{{baseUrl}}/api/v1/org/slug/{{orgSlug}}
āļāļąāļāđāļāļĨāļ·āđāļāļāđāļāļĒ: postman-to-markdown