Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Current »

Overview

Update request for a user's Assigned space availability.

This request will allow users to add, edit or remove dates that their assigned space will be available to other users.

Details

Type

POST

Endpoint

{{url}}/api/User/SetAssignedSpaceAvailability

Request

The ResId, UserId or EmailAddress can be used to identify which resource needs to be updated.
Users can add, edit or remove availability events, this is defined by the Action field.

  • Add - This requires start and end values.

  • Edit - This requires the event ID as well as the updated start and end values.

  • Remove - This requires the event ID value.

Example

{
  "ResId": int,
  "UserId": int,
  "EmailAddress": "string (email address)",
  "AvailabilityEvent": Object{
    "Action": "Add",
    "Id": null,
    "StartDate": "dd/MM/yyyy",
    "EndDate": "dd/MM/yyyy",
  }
}

Response

The response will return the requested information with a successful validation.

Example

{
  "ResId": int,
  "UserId": int,
  "EmailAddress": "string (email address)",
  "AvailabilityEvent": Object{
    "Action": "Add",
    "Id": null,
    "StartDate": "dd/MM/yyyy",
    "EndDate": "dd/MM/yyyy",
    "Success": boolean
  }
}
  • No labels