1. Ad Astra Support Center
  2. Knowledge Base
  3. Integrations
  4. APIs
  5. Astra Schedule APIs
  6. Astra Schedule API Library

Astra Schedule Starter API Collection Expected Responses - Entity Calls

Avatar
Nicholas Shipley

Below are the expected Status: 200 responses for the entity based API calls. Should you get a block of HTML in response, please ensure that your session is authenticated and try again.

All values returned have been defined as string, integer, boolean, GUID string, or describe the date format in use for a given value.

GUID Strings will be adhere to the following alphanumeric format when the value given is not null.  ########-####-####-####-############

 

{{url}}/logon.ashx?nosso=
true
or
false
{{url}}/~api/entity/building
{
"totalRecords": integer,
"data": [
{
"CampusName": "string",
"PrimaryContactUsername": "string",
"BuildingStatusName": "string",
"Description": "string",
"BuildingCode": "string",
"KeyNumber": "string",
"BuildingStatusId": "GUID string",
"AddressId": "GUID string",
"CampusId": "GUID string",
"PrimaryContactId": "GUID string",
"NoSchedule": boolean,
"ArrangedSection": boolean,
"DoNotOptimize": boolean,
"IsActive": boolean,
"CreatedDate": "YYYY-MM-DDTHH:MM:SS.000",
"CreatedBy": "GUID string",
"ModifiedDate": "YYYY-MM-DDTHH:MM:SS.000",
"SisKey": "string",
"LastSisUpdateDate": "YYYY-MM-DDTHH:MM:SS.000",
"LastImportedDate": "YYYY-MM-DDTHH:MM:SS.000",
"RequiresAttention": boolean,
"RequiresAttentionReason": "string",
"Id": "GUID string",
"Name": "string",
"ModifiedBy": "GUID string",
"RowVersion": integer
}
]
}
{{url}}/~api/entity/campus 
{
    "totalRecords": integer,
    "data": [
        {
            "FullName": "string",
            "CampusTypeName": "string",
            "CampusGroupName": "string",
            "Description": "string",
            "IsDefault": boolean,
            "IsOnLine": boolean,
            "CampusTypeId": "GUID string",
            "CampusGroupId": "GUID string",
            "InstitutionId": "GUID string",
            "IsActive": boolean,
            "CreatedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "CreatedBy": "GUID string",
            "ModifiedDate": "YYYY-MM-DDTHH:MM:SS.000d",
            "SisKey": "string",
            "LastSisUpdateDate": "YYYY-MM-DDTHH:MM:SS.000",
            "LastImportedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "RequiresAttention": boolean,
            "RequiresAttentionReason": "string",
            "Id": "GUID string",
            "Name": "string",
            "ModifiedBy": "GUID string",
            "RowVersion": integer
        }
    ]
}
{{url}}/~api/entity/course
{
    "totalRecords": integer,
    "data": [
        {
            "PreRequisiteDisplay": "string",
            "CoRequisiteDisplay": "string",
            "CourseShortName": "string",
            "SubjectCode": "string",
            "DependentName": "string",
            "CrosslistName": "string",
            "LastTermId": "GUID string",
            "Description": "string",
            "CourseNumber": "string",
            "SubjectId": "GUID string",
            "CourseTitle": "string",
            "ArrangedCourse": boolean,
            "DoNotOptimize": boolean,
            "CourseCrosslistId": "GUID string",
            "IsInCatalog": boolean,
            "EffectiveStartDate": "YYYY-MM-DDTHH:MM:SS.000",
            "EffectiveEndDate": "YYYY-MM-DDTHH:MM:SS.000",
            "EffectiveParentId": "GUID string",
            "CreditHours": integer,
            "LowCreditHours": "string",
            "HighCreditHours": "string",
            "CreditHoursIndicator": "string",
            "HasComplexPreReq": boolean,
            "HasSimplePrereq": boolean,
            "HasCoReq": boolean,
            "HasEquivalent": boolean,
            "EquivalentDisplay": "string",
            "SequentialPreReqs": boolean,
            "CatalogVersionId": "GUID string",
            "CourseExpirationDate": "YYYY-MM-DDTHH:MM:SS.000",
            "IsActive": boolean,
            "InstitutionId": "GUID string",
            "CourseDependentId": "GUID string",
            "CrseLvlRange": "string",
            "CrseGradUnderGradStatus": "string",
            "CourseClusterId": "GUID string",
            "ArePreReqsDisabled": boolean,
            "CreatedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "CreatedBy": "GUID string",
            "ModifiedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "SisKey": "string",
            "LastSisUpdateDate": "YYYY-MM-DDTHH:MM:SS.000",
            "LastImportedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "RequiresAttention": boolean,
            "RequiresAttentionReason": "string",
            "Id": "GUID string",
            "Name": "string",
            "ModifiedBy": "GUID string",
            "RowVersion": integer
        }
    ]
}
{{url}}/~api/entity/customer
{
    "totalRecords": integer,
    "data": [
        {
            "PriceLevelName": "string",
            "PriceLevelRowId": "GUID string",
            "InstitutionId": "GUID string",
            "Website": "string",
            "Notes": "string",
            "AddressId": "GUID string",
            "BillingAddressId": "string",
            "ContactInformationId": "GUID string",
            "IsActive": boolean,
            "AccountingKey": "string",
            "AccountNumber": "string",
            "CreatedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "CreatedBy": "GUID string",
            "ModifiedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "SisKey": "string",
            "LastSisUpdateDate": "YYYY-MM-DDTHH:MM:SS.000",
            "LastImportedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "RequiresAttention": boolean,
            "RequiresAttentionReason": "string",
            "Id": "GUID string",
            "Name": "string",
            "ModifiedBy": "GUID string",
            "RowVersion": integer
        }
    ]
}
{{url}}/~api/entity/instructor
{
    "totalRecords": integer,
    "data": [
        {
            "Name": "string",
            "FullName": "string",
            "FirstName": "string",
            "LastName": "string",
            "PeopleId": "GUID string",
            "EducationLevelName": "string",
            "InstructorTypeName": "string",
            "PrimaryCampusName": "string",
            "AvailabilityTemplateName": "string",
            "Phone": "string",
            "Email": "string",
            "PersonId": "GUID string",
            "InstitutionId": "GUID string",
            "InstructorTypeId": "GUID string",
            "InstructorId": "GUID string",
            "AddressId": "GUID string",
            "ContactInformationId": "GUID string",
            "AvailabilityTemplateId": "GUID string",
            "PrimaryCampusId": "GUID string",
            "SalaryMultiplier": "string",
            "DoNotOptimize": boolean,
            "DoNotBackToBackOptimize": boolean,
            "ProcessBackToBack": boolean,
            "IsActive": boolean,
            "InstrEducationLevelId": "GUID string",
            "CreatedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "CreatedBy": "GUID string",
            "ModifiedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "SisKey": "string",
            "LastSisUpdateDate": "YYYY-MM-DDTHH:MM:SS.000",
            "LastImportedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "RequiresAttention": boolean,
            "RequiresAttentionReason": "string",
            "Id": "GUID string",
            "ModifiedBy": "GUID string",
            "RowVersion": integer
        }
    ]
}
{{url}}/~api/entity/people
{
    "totalRecords": integer,
    "data": [
        {
            "Name": "string",
            "FullName": "string",
            "PrimaryResponsibilityName": "string",
            "Email": "string",
            "Pre": "string",
            "FirstName": "string",
            "MiddleName": "string",
            "LastName": "string",
            "Suffix": "string",
            "Employer": "string",
            "EmployeeId": "GUID string",
            "Title": "string",
            "PrimaryResponsibilityId": "GUID string",
            "InstitutionId": "GUID string",
            "AddressId": "GUID string",
            "ContactInformationId": "GUID string",
            "SisId": "GUID string",
            "IsActive": boolean,
            "CreatedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "CreatedBy": "GUID string",
            "ModifiedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "SisKey": "string",
            "LastSisUpdateDate": "YYYY-MM-DDTHH:MM:SS.000",
            "LastImportedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "RequiresAttention": boolean,
            "RequiresAttentionReason": "string",
            "Id": "GUID string",
            "ModifiedBy": "GUID string",
            "RowVersion": integer
        }
    ]
}
{{url}}/~api/entity/resource
{
    "totalRecords": integer,
    "data": [
        {
            "UnitName": "string",
            "UnitRowID": "GUID string",
            "UnitPrice": integer,
            "DiscountPriceMethod": "string",
            "CategoryId": "GUID string",
            "Description": "string",
            "ResourceTypeId": "GUID string",
            "AssociatedResourceId": "GUID string",
            "IsPrivate": boolean,
            "RequiresConfirmation": boolean,
            "Notes": "string",
            "ExpirationDate": "YYYY-MM-DDTHH:MM:SS.000",
            "BlocksRoomBetwnSetupTeardown": boolean,
            "Qty": integer,
            "TrackIndividualItems": boolean,
            "UploadedPictureId": "GUID string",
            "IsActive": boolean,
            "InstitutionId": "GUID string",
            "AccountingKey": "string",
            "WorkflowDefinitionId": "GUID string",
            "CreatedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "CreatedBy": "GUID string",
            "ModifiedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "SisKey": "string",
            "LastSisUpdateDate": "YYYY-MM-DDTHH:MM:SS.000",
            "LastImportedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "RequiresAttention": boolean,
            "RequiresAttentionReason": "string",
            "Id": "GUID string",
            "Name": "string",
            "ModifiedBy": "GUID string",
            "RowVersion": integer
        }
    ]
}
{{url}}/~api/entity/room
{
    "totalRecords": integer,
    "data": [
        {
            "BuildingRoomNumber": "string",
            "BuildingRoomNumberName": "string",
            "BuildingName": "string",
            "CampusId": "GUID string",
            "CampusName": "string",
            "ParentRoomNumberName": "string",
            "RoomTypeName": "string",
            "Description": "string",
            "RoomNumber": "string",
            "KeyNumber": "string",
            "PhoneAreaCode": "string",
            "PhoneNumber": "string",
            "PhoneExtension": "string",
            "Width": "string",
            "Length": "string",
            "SquareFootage": "string",
            "MaxOccupancy": "string",
            "IsShareable": boolean,
            "MaxSharedActivities": integer,
            "PriorityId": "GUID string",
            "RoomTypeId": "GUID string",
            "BuildingId": "GUID string",
            "HvacZoneId": "GUID string",
            "NoSchedule": boolean,
            "ArrangedSection": boolean,
            "DoNotOptimize": boolean,
            "EffectiveStartDate": "YYYY-MM-DDTHH:MM:SS.000",
            "EffectiveEndDate": "YYYY-MM-DDTHH:MM:SS.000",
            "EffectiveParentId": "GUID string",
            "IsActive": boolean,
            "WorkflowDefinitionId": "GUID string",
            "ReportingRegion": "string",
            "CreatedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "CreatedBy": "GUID string",
            "ModifiedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "SisKey": "string",
            "LastSisUpdateDate": "YYYY-MM-DDTHH:MM:SS.000",
            "LastImportedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "RequiresAttention": boolean,
            "RequiresAttentionReason": "string",
            "Id": "GUID string",
            "Name": "string",
            "ModifiedBy": "GUID string",
            "RowVersion": integer
        }
    ]
}
{{url}}/~api/entity/roomconfiguration
{
    "totalRecords": integer,
    "data": [
        {
            "FacilityLayoutName": "string",
            "UnitName": "string",
            "UnitRowID": "GUID string",
            "UnitPrice": integer,
            "DiscountPriceMethod": "string",
            "RoomId": "GUID string",
            "FacilityLayoutId": "GUID string",
            "OptimizerPriority": "string",
            "Priority": "string",
            "MeetingCapacity": integer,
            "IsDefault": boolean,
            "SetupMinutes": integer,
            "TeardownMinutes": integer,
            "RequiresAuthorization": boolean,
            "Description": "string",
            "IsActive": boolean,
            "AccountingKey": "string",
            "UploadedPictureId": "GUID string",
            "CreatedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "CreatedBy": "GUID string",
            "ModifiedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "SisKey": "string",
            "LastSisUpdateDate": "YYYY-MM-DDTHH:MM:SS.000",
            "LastImportedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "RequiresAttention": boolean,
            "RequiresAttentionReason": "string",
            "Id": "GUID string",
            "Name": "string",
            "ModifiedBy": "GUID string",
            "RowVersion": integer
        }
    ]
}
{{url}}/~api/entity/term
{
    "totalRecords": integer,
    "data": [
        {
            "TermGroupName": "string",
            "TermTypeName": "string",
            "RoomPreferenceSetName": "string",
            "TimePreferenceSetName": "string",
            "TermName": "string",
            "DefaultPartOfTermName": "string",
            "Description": "string",
            "Label": "string",
            "StartDate": "YYYY-MM-DDTHH:MM:SS.000",
            "EndDate": "YYYY-MM-DDTHH:MM:SS.000",
            "TermTypeId": "GUID string",
            "TermGroupId": "GUID string",
            "RoomPreferenceSetId": "GUID string",
            "TimePreferenceSetId": "GUID string",
            "AnalysisTermSettingsId": "GUID string",
            "TermAdjustedDatesId": "GUID string",
            "IsTermGroup": boolean,
            "IsActive": boolean,
            "DefaultPartOfTermId": "GUID string",
            "InstitutionId": "GUID string",
            "DeleteInProgress": boolean,
            "CreatedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "CreatedBy": "GUID string",
            "ModifiedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "SisKey": "string",
            "LastSisUpdateDate": "YYYY-MM-DDTHH:MM:SS.000",
            "LastImportedDate": "YYYY-MM-DDTHH:MM:SS.000",
            "RequiresAttention": boolean,
            "RequiresAttentionReason": "string",
            "Id": "GUID string",
            "Name": "string",
            "ModifiedBy": "GUID string",
            "RowVersion": integer
        }
    ]
}
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.

Articles in this section