| DELETE | /references/{companyid}/{ownerid}/{referencetype} | Delete a reference with the reference type | Delete a reference |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | path | Guid | Yes | The company id |
| OwnerId | path | Guid | No | Internal Id of the reference. Example could be the Booking Id |
| ReferenceType | path | string | No | Reference type of the reference |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | No | The company id |
| Id | form | Guid | No | Id of the reference |
| OwnerId | form | Guid | No | Internal Id of the reference. Example could be the Booking Id |
| ReferenceType | form | string | No | The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system |
| ExternalData | form | string | No | The external data. Could be a Id or a JSON object or anything |
| Updated | form | datetime | No | Will show when the reference was updated. |
| Created | form | datetime | No | Will show when the reference was created. |
| CreatedBy | form | datetime | No | Will show who created the reference. |
| UpdatedBy | form | datetime | No | Will show who update the reference. |
| ResponseStatus | form | ResponseStatus | No |
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.
DELETE /references/{companyid}/{ownerid}/{referencetype} HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}