BokaMera.API.Host

<back to all web services

AddReference

The following routes are available for this service:
POST/referencesAdd referenceAdd reference
import Foundation
import ServiceStack

public class AddReference : ICompany, Codable
{
    /**
    * 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.")
    public var companyId:String?

    /**
    * Internal Id of the reference. Example could be the Booking Id
    */
    // @ApiMember(Description="Internal Id of the reference. Example could be the Booking Id")
    public var ownerId:String

    /**
    * 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")
    public var referenceType:String

    /**
    * External reference type id - can we fetched from /externalreferencestypes endpoint
    */
    // @ApiMember(Description="External reference type id - can we fetched from /externalreferencestypes endpoint")
    public var referenceTypeId:Int?

    /**
    * 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")
    public var externalData:String

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

    required public init(){}
}

public class ReferenceQueryResponse : Codable
{
    public var companyId:String
    public var id:String
    public var ownerId:String
    public var referenceType:String
    public var referenceTypeId:Int
    public var externalData:String
    public var updated:Date
    public var created:Date
    public var createdBy:String
    public var updatedBy:String
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift AddReference DTOs

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

HTTP + OTHER

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

POST /references HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","ReferenceType":"String","ReferenceTypeId":0,"ExternalData":"String","CreatedBy":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ReferenceType":"String","ReferenceTypeId":0,"ExternalData":"String","CreatedBy":"String","UpdatedBy":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}