POST api/UserAccess?username={username}&accessType={accessType}

Returns a response indicating whether a user has access to a specified object at the specified access level

Request Information

URI Parameters

Name	Description	Type	Additional information
username	The username	string	Required
accessType	The access type	AccessType	Required

Body Parameters

The object information

ObjectInfo

Name	Description	Type	Additional information
ID	GUID for the Object.	globally unique identifier	None.
IntID	Integer ID for the Object.	integer	None.
Type	Type of the Object.	OwnerType	None.
Valid	Returns whether or not this object's information is filled sufficiently, i.e. includes ID, IntID, and Type. Currently this is coded primarily for use with Schedule Types. If this is to be used with any other Types, it will need to have the usage coded in.	boolean	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "ID": "0e0784f8-5ce6-4757-b3c2-5772577ba90f",
  "IntID": 2,
  "Type": 10,
  "Valid": true
}

application/xml, text/xml

Sample:

<ObjectInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
  <ID>0e0784f8-5ce6-4757-b3c2-5772577ba90f</ID>
  <IntID>2</IntID>
  <Type>Device</Type>
</ObjectInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A response indicating whether the user has access (True) or not (False).

GetBooleanResponse

Name	Description	Type	Additional information
Bool	The boolean result	boolean	None.
Messages	Array of messages	Collection of Message	None.
ServerInformation	Relevant information regarding the Server	ServerInformation	None.
VersionInformation	Relevant information regarding the API's version	VersionInformation	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "Bool": true,
  "Messages": [
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    },
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    }
  ],
  "ServerInformation": {
    "CurrentTimeUTC": "2025-11-09T21:28:38.1430656+10:00",
    "BuildDateUTC": "2025-11-09T21:28:38.1430656+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 3,
    "Hotfix": 7,
    "Beta": false,
    "Version": "1.3.7"
  }
}

application/xml, text/xml

Sample:

<GetBooleanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models.Responses">
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services">
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
  </Messages>
  <ServerInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata">
    <d2p1:BuildDateUTC>2025-11-09T21:28:38.1430656+10:00</d2p1:BuildDateUTC>
    <d2p1:CurrentTimeUTC>2025-11-09T21:28:38.1430656+10:00</d2p1:CurrentTimeUTC>
  </ServerInformation>
  <VersionInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata" />
  <Bool>true</Bool>
</GetBooleanResponse>