BokaMera.API.Host

<back to all web services

CreateApiKeySuperAdminUser

The following routes are available for this service:
POST/superadmin/apikeyCreates an api key for the customer.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ApiResponse(Description:="", StatusCode:=400)>
        <ApiResponse(Description:="Returned if the current user is not allowed to perform the action", StatusCode:=401)>
        Public Partial Class CreateApiKeySuperAdminUser
            Implements ICompany
            Public Sub New()
                RedirectUrls = New List(Of String)
                WebOrigins = New List(Of String)
                DefaultClientScopes = New List(Of String)
                OptionalClientScopes = New List(Of String)
            End Sub

            '''<Summary>
            '''Enter the companyId for the customer
            '''</Summary>
            <ApiMember(Description:="Enter the companyId for the customer", IsRequired:=true, ParameterType:="query")>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            <ApiMember(IsRequired:=true)>
            Public Overridable Property FirstName As String

            <ApiMember(IsRequired:=true)>
            Public Overridable Property LastName As String

            <ApiMember(IsRequired:=true)>
            Public Overridable Property ClientId As String

            <ApiMember(IsRequired:=true)>
            Public Overridable Property RedirectUrls As List(Of String)

            <ApiMember(IsRequired:=true)>
            Public Overridable Property ContactEmail As String

            <ApiMember(IsRequired:=true)>
            Public Overridable Property ContactPhone As String

            <ApiMember>
            Public Overridable Property Notes As String

            <ApiMember>
            Public Overridable Property WebOrigins As List(Of String)

            <ApiMember>
            Public Overridable Property DefaultClientScopes As List(Of String)

            <ApiMember>
            Public Overridable Property OptionalClientScopes As List(Of String)
        End Class
    End Namespace
End Namespace

VB.NET CreateApiKeySuperAdminUser DTOs

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 /superadmin/apikey HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateApiKeySuperAdminUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ClientId>String</ClientId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <ContactEmail>String</ContactEmail>
  <ContactPhone>String</ContactPhone>
  <DefaultClientScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DefaultClientScopes>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <Notes>String</Notes>
  <OptionalClientScopes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OptionalClientScopes>
  <RedirectUrls xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RedirectUrls>
  <WebOrigins xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </WebOrigins>
</CreateApiKeySuperAdminUser>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />