BokaMera.API.Host

AddReference

The following routes are available for this service:
POST	/references	Add reference	Add reference

import java.math.*
import java.util.*
import net.servicestack.client.*


open class AddReference : ICompany
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    var CompanyId:UUID? = null

    /**
    * Internal Id of the reference. Example could be the Booking Id
    */
    @ApiMember(Description="Internal Id of the reference. Example could be the Booking Id")
    var OwnerId:UUID? = null

    /**
    * The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system
    */
    @ApiMember(Description="The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system")
    var ReferenceType:String? = null

    /**
    * The external data. Could be a Id or a JSON object or anything
    */
    @ApiMember(Description="The external data. Could be a Id or a JSON object or anything")
    var ExternalData:String? = null

    /**
    * Will show who created the reference.
    */
    @ApiMember(DataType="datetime", Description="Will show who created the reference.")
    var CreatedBy:String? = null
}

open class ReferenceQueryResponse
{
    /**
    * The company id
    */
    @ApiMember(Description="The company id")
    var CompanyId:UUID? = null

    /**
    * Id of the reference
    */
    @ApiMember(Description="Id of the reference")
    var Id:UUID? = null

    /**
    * Internal Id of the reference. Example could be the Booking Id
    */
    @ApiMember(Description="Internal Id of the reference. Example could be the Booking Id")
    var OwnerId:UUID? = null

    /**
    * The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system
    */
    @ApiMember(Description="The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system")
    var ReferenceType:String? = null

    /**
    * The external data. Could be a Id or a JSON object or anything
    */
    @ApiMember(Description="The external data. Could be a Id or a JSON object or anything")
    var ExternalData:String? = null

    /**
    * Will show when the reference was updated.
    */
    @ApiMember(DataType="datetime", Description="Will show when the reference was updated.")
    var Updated:Date? = null

    /**
    * Will show when the reference was created.
    */
    @ApiMember(DataType="datetime", Description="Will show when the reference was created.")
    var Created:Date? = null

    /**
    * Will show who created the reference.
    */
    @ApiMember(DataType="datetime", Description="Will show who created the reference.")
    var CreatedBy:String? = null

    /**
    * Will show who update the reference.
    */
    @ApiMember(DataType="datetime", Description="Will show who update the reference.")
    var UpdatedBy:String? = null

    var ResponseStatus:ResponseStatus? = null
}

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

<AddReference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CreatedBy>String</CreatedBy>
  <ExternalData>String</ExternalData>
  <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
  <ReferenceType>String</ReferenceType>
</AddReference>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReferenceQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <CreatedBy>String</CreatedBy>
  <ExternalData>String</ExternalData>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
  <ReferenceType>String</ReferenceType>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Updated>0001-01-01T00:00:00</Updated>
  <UpdatedBy>String</UpdatedBy>
</ReferenceQueryResponse>