Jump to

• Request
• Response

Get mapping details of supervisor accounts mapped to a supervisor role in a LearnCenter

get

/learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts/{supervisorAccountId}

Request

Path Parameters

• learnCenterId: number
  Unique identifier of a LearnCenter.
• supervisorAccountId: string
  Unique identifier of a supervisor account.
• supervisorRoleId: number
  Unique identifier of a supervisor role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Supervisor accounts collection fetched.

Body ()

Root Schema : SupervisorAccountSupervisorRoleResponse

Type: object

Response object comprising the parameters for the supervisor role and account.

Show Source

• createDateUtc(optional): string(datetime)
  Date the supervisor role is created.

  Example: 2018-12-18T22:10:00
• links(optional): array links
  Links to the supervisor account.
• statusFlag(optional): boolean
  Status of the supervisor role.

  Example: true
• supervisorAccount(optional): object supervisorAccount
  Object comprising supervisor account links.
• supervisorAccountId(optional): string(guid)
  Unique identifier for a supervisor account.

  Example: 31D132DB-33E2-4EE3-870C-06ED25F6CE00
• supervisorRole(optional): object supervisorRole
  Object comprising links to the Supervisor Roles.
• supervisorRoleId(optional): number
  Unique identifier for a supervisor role.

  Example: 1914

{
    "type":"object",
    "description":"Response object comprising the parameters for the supervisor role and account.",
    "properties":{
        "supervisorAccountId":{
            "type":"string",
            "format":"guid",
            "example":"31D132DB-33E2-4EE3-870C-06ED25F6CE00",
            "description":"Unique identifier for a supervisor account."
        },
        "supervisorRoleId":{
            "type":"number",
            "example":1914,
            "description":"Unique identifier for a supervisor role."
        },
        "supervisorAccount":{
            "type":"object",
            "description":"Object comprising supervisor account links.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SupervisorAccountLink"
                    }
                }
            }
        },
        "supervisorRole":{
            "type":"object",
            "description":"Object comprising links to the Supervisor Roles.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SupervisorRoleLink"
                    }
                }
            }
        },
        "createDateUtc":{
            "type":"string",
            "format":"datetime",
            "example":"2018-12-18T22:10:00",
            "description":"Date the supervisor role is created."
        },
        "statusFlag":{
            "type":"boolean",
            "example":true,
            "description":"Status of the supervisor role."
        },
        "links":{
            "type":"array",
            "description":"Links to the supervisor account.",
            "items":{
                "$ref":"#/definitions/SupervisorRoleAccountLink"
            }
        }
    },
    "example":{
        "supervisorAccountId":"5E1E861F-311F-43B8-915A-0E4716C43EF1",
        "supervisorRoleId":474,
        "supervisorAccount":{
            "links":[
                {
                    "rel":"canonical",
                    "href":"{url}/learn.rest/v1/learnCenters/179177/supervisorAccounts/5E1E861F-311F-43B8-915A-0E4716C43EF1"
                }
            ]
        },
        "supervisorRole":{
            "links":[
                {
                    "ref":"canonical",
                    "href":"{url}/learn.rest/v1/learnCenters/179177/supervisorRoles/474"
                }
            ]
        },
        "createDateUtc":"2016-06-13T08:26:00",
        "statusFlag":true,
        "links":[
            {
                "ref":"canonical",
                "href":"{url}/learn.rest/v1/learnCenters/179177/supervisorRoles/474/supervisorAccounts/5E1E861F-311F-43B8-915A-0E4716C43EF1"
            }
        ]
    }
}

Example:

{
    "supervisorAccountId":"5E1E861F-311F-43B8-915A-0E4716C43EF1",
    "supervisorRoleId":474,
    "supervisorAccount":{
        "links":[
            {
                "rel":"canonical",
                "href":"{url}/learn.rest/v1/learnCenters/179177/supervisorAccounts/5E1E861F-311F-43B8-915A-0E4716C43EF1"
            }
        ]
    },
    "supervisorRole":{
        "links":[
            {
                "ref":"canonical",
                "href":"{url}/learn.rest/v1/learnCenters/179177/supervisorRoles/474"
            }
        ]
    },
    "createDateUtc":"2016-06-13T08:26:00",
    "statusFlag":true,
    "links":[
        {
            "ref":"canonical",
            "href":"{url}/learn.rest/v1/learnCenters/179177/supervisorRoles/474/supervisorAccounts/5E1E861F-311F-43B8-915A-0E4716C43EF1"
        }
    ]
}

Nested Schema : links

Type: array

Links to the supervisor account.

Show Source

• Array of: object SupervisorRoleAccountLink

{
    "type":"array",
    "description":"Links to the supervisor account.",
    "items":{
        "$ref":"#/definitions/SupervisorRoleAccountLink"
    }
}

Nested Schema : supervisorAccount

Type: object

Object comprising supervisor account links.

Show Source

• links(optional): array links

{
    "type":"object",
    "description":"Object comprising supervisor account links.",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SupervisorAccountLink"
            }
        }
    }
}

Nested Schema : supervisorRole

Type: object

Object comprising links to the Supervisor Roles.

Show Source

• links(optional): array links

{
    "type":"object",
    "description":"Object comprising links to the Supervisor Roles.",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SupervisorRoleLink"
            }
        }
    }
}

Nested Schema : SupervisorRoleAccountLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts/{supervisorAccountId}
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts/{supervisorAccountId}          "
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SupervisorAccountLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SupervisorAccountLink"
    }
}

Nested Schema : SupervisorAccountLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SupervisorRoleLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SupervisorRoleLink"
    }
}

Nested Schema : SupervisorRoleLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenters/178409/supervisorRoles/123
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/178409/supervisorRoles/123"
        }
    }
}

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

500 Response

Internal server error.

Back to Top