Auth.Api

<back to all web services

UserTokensRegisterWebsocketPostDto

The following routes are available for this service:
POST/admin/v1/user_tokens/register_websocketGenerate a one time token for registering websocket.
UserTokensRegisterWebsocketPostDto Parameters:
NameParameterData TypeRequiredDescription
ApplicationsIdbodyint?No
UserTokensResponse Parameters:
NameParameterData TypeRequiredDescription
UserTokensformList<UserTokens>No
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
StatusformApiResponseStatusNo
CodeformintNo
apiVersionformstringNo
appVersionformstringNo
ApiResponseStatus Enum:
OK
FAIL
Default
UserTokens Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ApplicationsIdformintNo
UsersIdformintNo
UserTokenActionsIdformintNo
TokenformstringNo
UsedAtformDateTime?No
ActiveTillformDateTimeNo
RecordStatusIdformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /admin/v1/user_tokens/register_websocket HTTP/1.1 
Host: auth.mepis.si 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UserTokensRegisterWebsocketPostDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.DTO.API">
  <ApplicationsId>0</ApplicationsId>
</UserTokensRegisterWebsocketPostDto>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserTokensResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.DTO.API">
  <Code xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel">0</Code>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel">OK</Status>
  <apiVersion xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel">String</apiVersion>
  <appVersion xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel">String</appVersion>
  <UserTokens xmlns:d2p1="http://schemas.datacontract.org/2004/07/Metronik.Core.Auth.Api.ServiceModel.Models">
    <d2p1:UserTokens>
      <d2p1:ActiveTill>0001-01-01T00:00:00</d2p1:ActiveTill>
      <d2p1:ApplicationsId>0</d2p1:ApplicationsId>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:RecordStatusId>0</d2p1:RecordStatusId>
      <d2p1:Token>String</d2p1:Token>
      <d2p1:UsedAt>0001-01-01T00:00:00</d2p1:UsedAt>
      <d2p1:UserTokenActionsId>0</d2p1:UserTokenActionsId>
      <d2p1:UsersId>0</d2p1:UsersId>
    </d2p1:UserTokens>
  </UserTokens>
</UserTokensResponse>