| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, SuperAdminVisma |
| PUT | /references/{Id} | Update a reference | Update a reference |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
@ValidateRequest(Validator="IsAuthenticated")
open class UpdateReference : 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
/**
* Id of the reference
*/
@ApiMember(Description="Id of the reference", IsRequired=true, ParameterType="path")
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
}
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
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /references/{Id} HTTP/1.1
Host: api.bokamera.se
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","OwnerId":"00000000-0000-0000-0000-000000000000","ReferenceType":"String","ExternalData":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ReferenceType":"String","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"}}}