Login
      Contents x
      Activities
      • 05 Jun 2024
      • Print
      • PDF
      Contents

      Activities

      • Updated on 05 Jun 2024
      • Print
      • PDF
      Article summary

      Description 

      Activities consist of appointments, tasks, issues, and milestones belonging to the logged-in Aspire user.  Click activities for more information. 

      Resource Overview  

      Overview of available endpoints. 

      Endpoint Definition 
      GET /ActivitiesRetrieve activity data. 

      Attributes

      Attribute
      Description
      Data Type
      Notes 
      ActivityIDunique identifier for an activity

      integer(int32)


      ActivityNumber
      		an identifying number assigned to an activity used to search for a saved activity in Aspireinteger(int32)

      ActivityType
      		an email, task, issue, or milestone in the Aspire systemstring Max Length:15 
      CompleteDate 
      		date of activity closure
      		DateTime

      CompletedByUserID
      		unique identifier of the user who closed out the activity integer(int32)


      CompletedByUserName
      		name of the user who completed the activitystring Max Length: 101

      CreatedByUserID
      		unique identifier of the user who created the activity.integer(int32)



      CreatedByUserName 
      		name of user who created the activitystring Max Length:101
      CreatedDate
      		activity creation dateDateTime
      DueDate
      		date detailing when an action specified in an email, task, issue, or milestone is due.DateTime

      EndDate
      		date detailing when an action specified in an email, task, issue, or milestone is scheduled to close.
      		DateTime


      IncludeClient
      		specify whether the primary contact for a client is to receive notification regarding the activity. boolean 
      IncludeCrew
      		specify whether the crew leader(s) associated with an activity will receive a notification once created. boolean 
      InvoiceID 
      		unique identifier for invoice integer(int32)
      IsMileStone
      		target dates related to an opportunity or work orderboolean 
      Location
      		physical address related to an activity string Max Length: 100 
      ModifiedDate
      		date capturing when activity information is updated
      		DateTime

      Notes
      		additional details added to an activity.stringMax Length: 2147483647
      OpportunityID 
      		unique identifier for an opportunity integer(int32)
      PaymentID
      		unique identifier for a payment entryinteger(int32)
      Priorityassigned order of importance classified as "High," "Normal," or "Low"stringMax Length:15 
      Private
      		prevent users not assigned to the activity from having visibility into an activityboolean
      PropertyID
      		unique identifier for a propertyinteger(int32) 
      SentDate
      		date user activity type to the recipient DateTime
      StartDate
      		created start dateDateTime
      Status
      		current state of activity: "Open" or "Completed"string Max Length: 15 
      Subject
      		title heading of activitystringMax Length: 200
      WorkTicketID 
      		unique identifier for work ticket integer(int32)


      Was this article helpful?
      What's Next
      Change password!
      Changing your password will log you out immediately. Use the new password to log back in.
      Change profile
      Success!
      First name must have atleast 2 characters. Numbers and special characters are not allowed.
      Last name must have atleast 1 characters. Numbers and special characters are not allowed.
      Enter a valid email
      Enter a valid password
      Your profile has been successfully updated.
      Logout