| GET | /references | Get all valid references | Get all valid references. |
|---|
import Foundation
import ServiceStack
public class ReferenceQuery : QueryDb2<ExternalReference, ReferenceQueryResponse>, 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.")
public var companyId:String?
/**
* Id of the reference
*/
// @ApiMember(Description="Id of the reference")
public var id: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
/**
* 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
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case companyId
case id
case ownerId
case referenceType
case externalData
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
id = try container.decodeIfPresent(String.self, forKey: .id)
ownerId = try container.decodeIfPresent(String.self, forKey: .ownerId)
referenceType = try container.decodeIfPresent(String.self, forKey: .referenceType)
externalData = try container.decodeIfPresent(String.self, forKey: .externalData)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if companyId != nil { try container.encode(companyId, forKey: .companyId) }
if id != nil { try container.encode(id, forKey: .id) }
if ownerId != nil { try container.encode(ownerId, forKey: .ownerId) }
if referenceType != nil { try container.encode(referenceType, forKey: .referenceType) }
if externalData != nil { try container.encode(externalData, forKey: .externalData) }
}
}
public class ExternalReference : BaseModel, IBaseModelCreated, IBaseModelUpdated
{
// @Required()
public var companyId:String?
// @Required()
public var id:String?
// @Required()
public var ownerId:String?
// @Required()
public var referenceType:String?
// @Required()
public var referenceTypeId:Int?
public var externalData:String
public var internalData:String
public var createdBy:String
// @Required()
public var updatedDate:Date?
// @Required()
public var createdDate:Date?
public var modifiedDate:Date?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case companyId
case id
case ownerId
case referenceType
case referenceTypeId
case externalData
case internalData
case createdBy
case updatedDate
case createdDate
case modifiedDate
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
id = try container.decodeIfPresent(String.self, forKey: .id)
ownerId = try container.decodeIfPresent(String.self, forKey: .ownerId)
referenceType = try container.decodeIfPresent(String.self, forKey: .referenceType)
referenceTypeId = try container.decodeIfPresent(Int.self, forKey: .referenceTypeId)
externalData = try container.decodeIfPresent(String.self, forKey: .externalData)
internalData = try container.decodeIfPresent(String.self, forKey: .internalData)
createdBy = try container.decodeIfPresent(String.self, forKey: .createdBy)
updatedDate = try container.decodeIfPresent(Date.self, forKey: .updatedDate)
createdDate = try container.decodeIfPresent(Date.self, forKey: .createdDate)
modifiedDate = try container.decodeIfPresent(Date.self, forKey: .modifiedDate)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if companyId != nil { try container.encode(companyId, forKey: .companyId) }
if id != nil { try container.encode(id, forKey: .id) }
if ownerId != nil { try container.encode(ownerId, forKey: .ownerId) }
if referenceType != nil { try container.encode(referenceType, forKey: .referenceType) }
if referenceTypeId != nil { try container.encode(referenceTypeId, forKey: .referenceTypeId) }
if externalData != nil { try container.encode(externalData, forKey: .externalData) }
if internalData != nil { try container.encode(internalData, forKey: .internalData) }
if createdBy != nil { try container.encode(createdBy, forKey: .createdBy) }
if updatedDate != nil { try container.encode(updatedDate, forKey: .updatedDate) }
if createdDate != nil { try container.encode(createdDate, forKey: .createdDate) }
if modifiedDate != nil { try container.encode(modifiedDate, forKey: .modifiedDate) }
}
}
public class BaseModel : Codable
{
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(){}
}
public class AccessKeyTypeResponse : Codable
{
public var id:Int
public var keyType:String
public var Description:String
required public init(){}
}
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.
GET /references HTTP/1.1 Host: api.bookmore.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
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
}
}
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}