| POST | /references | Add reference | Add reference |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
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.")
override 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")
open 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")
open var ReferenceType:String? = null
/**
* External reference type id - can we fetched from /externalreferencestypes endpoint
*/
@ApiMember(Description="External reference type id - can we fetched from /externalreferencestypes endpoint")
open var ReferenceTypeId:Int? = 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")
open var ExternalData:String? = null
/**
* Will show who created the reference.
*/
@ApiMember(DataType="datetime", Description="Will show who created the reference.")
open var CreatedBy:String? = null
}
open class ReferenceQueryResponse
{
open var CompanyId:UUID? = null
open var Id:UUID? = null
open var OwnerId:UUID? = null
open var ReferenceType:String? = null
open var ReferenceTypeId:Int? = null
open var ExternalData:String? = null
open var Updated:Date? = null
open var Created:Date? = null
open var CreatedBy:String? = null
open var UpdatedBy:String? = null
open var ResponseStatus:ResponseStatus? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
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/jsv
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
}
}
}