Show / Hide Table of Contents

Class CourseAlias

Alternative identifier for a course.

An alias uniquely identifies a course. It must be unique within one of the following scopes:

  • domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom.

  • project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return ALREADY_EXISTS if a previous one has succeeded.

Inheritance
System.Object
CourseAlias
Implements
IDirectResponseSchema
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Classroom.v1.Data
Assembly: Google.Apis.Classroom.v1.dll
Syntax
public class CourseAlias : IDirectResponseSchema

Properties

Alias

Alias string. The format of the string indicates the desired alias scoping.

  • d: indicates a domain-scoped alias. Example: d:math_101 * p: indicates a project-scoped alias. Example: p:abc123

This field has a maximum length of 256 characters.

Declaration
[JsonProperty("alias")]
public virtual string Alias { get; set; }
Property Value
Type Description
System.String

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
System.String

Implements

IDirectResponseSchema
Back to top