BokaMera.API.Host

<back to all web services

AddReference

The following routes are available for this service:
POST/referencesAdd referenceAdd reference
AddReference Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
OwnerIdbodyGuidNoInternal Id of the reference. Example could be the Booking Id
ReferenceTypebodystringNoThe type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system
ExternalDatabodystringNoThe external data. Could be a Id or a JSON object or anything
CreatedBybodydatetimeNoWill show who created the reference.
ReferenceQueryResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company id
IdformGuidNoId of the reference
OwnerIdformGuidNoInternal Id of the reference. Example could be the Booking Id
ReferenceTypeformstringNoThe type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system
ExternalDataformstringNoThe external data. Could be a Id or a JSON object or anything
UpdatedformdatetimeNoWill show when the reference was updated.
CreatedformdatetimeNoWill show when the reference was created.
CreatedByformdatetimeNoWill show who created the reference.
UpdatedByformdatetimeNoWill show who update the reference.
ResponseStatusformResponseStatusNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","ReferenceType":"String","ExternalData":"String","CreatedBy":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}