Bealink Knowledge Base

oData API - Appendix

6 Minutes to read

Print
Share
Dark
Light
PDF

oData API - Appendix

6 Minutes to read

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Expected Data Format

Enumeration Type

The values of the enumeration attributes must be passed with their numeric value formatted as a string:

In a Json payload:

With the $filter option:

$filter eq '2'

Type Date & Time

All Date and Time properties must be passed in UTC.

The expected format is as follows: YYYY-MM-DDTHH:mm:ss.

Example value:

2024-06-26T07:46:49Z

It is possible to skip only the date without the time.

Example value:

2024-06-26
Time Zone Type (TimeZoneId)

Time zone	Value to use for oData (TimeZoneId) calls
(UTC-12:00) International Date Line West	Dateline Standard Time
(UTC-11:00) Coordinated Universal Time-11	UTC-11
(UTC-10:00) Aleutian Islands	Aleutian Standard Time
(UTC-10:00) Hawaii	Hawaiian Standard Time
(UTC-09:30) Marquesas Islands	Marquesas Standard Time
(UTC-09:00) Alaska	Alaskan Standard Time
(UTC-09:00) Coordinated Universal Time-09	UTC-09
(UTC-08:00) Baja California	Pacific Standard Time (Mexico City)
(UTC-08:00) Coordinated Universal Time-08	UTC-08
(UTC-08:00) Pacific Time (US & Canada)	Pacific Standard Time
(UTC-07:00) Arizona	US Mountain Standard Time
(UTC-07:00) Chihuahua, La Paz, Mazatlan	Mountain Standard Time (Mexico City)
(UTC-07:00) Mountain Time (US & Canada)	Mountain Standard Time
(UTC-06:00) Central America	Central America Standard Time
(UTC-06:00) Central Time (US & Canada)	Central Standard Time
(UTC-06:00) Easter Island	Easter Island Standard Time
(UTC-06:00) Guadalajara, Mexico City, Monterrey	Central Standard Time (Mexico City)
(UTC-06:00) Saskatchewan	Canada Central Standard Time
(UTC-05:00) Bogota, Lima, Quito, Rio Branco	SA Pacific Standard Time
(UTC-05:00) Chetumal	Eastern Standard Time (Mexico City)
(UTC-05:00) Eastern Time (US & Canada)	Eastern Standard Time
(UTC-05:00) Haiti	Haiti Standard Time
(UTC-05:00) Havana	Cuba Standard Time
(UTC-05:00) Indiana (East)	US Eastern Standard Time
(UTC-05:00) Turks and Caicos	Turks And Caicos Standard Time
(UTC-04:00) Asuncion	Paraguay Standard Time
(UTC-04:00) Atlantic Time (Canada)	Atlantic Standard Time
(UTC-04:00) Caracas	Venezuela Standard Time
(UTC-04:00) Cuiaba	Central Brazilian Standard Time
(UTC-04:00) Georgetown, La Paz, Manaus, San Juan	SA Western Standard Time
(UTC-04:00) Santiago	Pacific SA Standard Time
(UTC-03:30) Newfoundland	Newfoundland Standard Time
(UTC-03:00) Araguaina	Tocantins Standard Time
(UTC-03:00) Brasilia	E. South America Standard Time
(UTC-03:00) Cayenne, Fortaleza	SA Eastern Standard Time
(UTC-03:00) City of Buenos Aires	Argentina Standard Time
(UTC-03:00) Greenland	Greenland Standard Time
(UTC-03:00) Montevideo	Montevideo Standard Time
(UTC-03:00) Punta Arenas	Magallanes Standard Time
(UTC-03:00) Saint Pierre and Miquelon	Saint Pierre Standard Time
(UTC-03:00) El Salvador	Bahia Standard Time
(UTC-02:00) Coordinated Universal Time-02	UTC-02
(UTC-01:00) Azores	Azores Standard Time
(UTC-01:00) Cabo Verde Is.	Cape Verde Standard Time
(UTC) Coordinated Universal Time	UTC
(UTC+00:00) Dublin, Edinburgh, Lisbon, London	GMT Standard Time
(UTC+00:00) Monrovia, Reykjavik	Greenwich Standard Time
(UTC+00:00) Sao Tome	Sao Tome Standard Time
(UTC+01:00) Casablanca	Morocco Standard Time
(UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna	W. Europe Standard Time
(UTC+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague	Central Europe Standard Time
(UTC+01:00) Brussels, Copenhagen, Madrid, Paris	Romance Standard Time
(UTC+01:00) Sarajevo, Skopje, Warsaw, Zagreb	Central European Standard Time
(UTC+01:00) West Central Africa	W. Central Africa Standard Time
(UTC+02:00) Amman	Jordan Standard Time
(UTC+02:00) Athens, Bucharest	BMS Standard Time
(UTC+02:00) Beirut	Middle East Standard Time
(UTC+02:00) Cairo	Egypt Standard Time
(UTC+02:00) Chisinau	E. Europe Standard Time
(UTC+02:00) Damascus	Syria Standard Time
(UTC+02:00) Gaza, Hebron	West Bank Standard Time
(UTC+02:00) Harare, Pretoria	South Africa Standard Time
(UTC+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius	FLE Standard Time
(UTC+02:00) Jerusalem	Israel Standard Time
(UTC+02:00) Kaliningrad	Kaliningrad Standard Time
(UTC+02:00) Khartoum	Sudan Standard Time
(UTC+02:00) Tripoli	Libya Standard Time
(UTC+02:00) Windhoek	Namibia Standard Time
(UTC+03:00) Baghdad	Arabic Standard Time
(UTC+03:00) Istanbul	Turkey Standard Time
(UTC+03:00) Kuwait, Riyadh	Arab Standard Time
(UTC+03:00) Minsk	Belarus Standard Time
(UTC+03:00) Moscow, St. Petersburg	Russian Standard Time
(UTC+03:00) Nairobi	E. Africa Standard Time
(UTC+03:30) Tehran	Iran Standard Time
(UTC+04:00) Abu Dhabi, Muscat	Arabian Standard Time
(UTC+04:00) Astrakhan, Ulyanovsk	Astrakhan Standard Time
(UTC+04:00) Baku	Azerbaijan Standard Time
(UTC+04:00) Izhevsk, Samara	Russia Time Zone 3
(UTC+04:00) Port Louis	Mauritius Standard Time
(UTC+04:00) Saratov	Saratov Standard Time
(UTC+04:00) Tbilisi	Georgian Standard Time
(UTC+04:00) Volgograd	Volgograd Standard Time
(UTC+04:00) Yerevan	Caucasus Standard Time
(UTC+04:30) Kabul	Afghanistan Standard Time
(UTC+05:00) Ashgabat, Tashkent	West Asia Standard Time
(UTC+05:00) Ekaterinburg	Ekaterinburg Standard Time
(UTC+05:00) Islamabad, Karachi	Pakistan Standard Time
(UTC+05:00) Qyzylorda	Qyzylorda Standard Time
(UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi	India Standard Time
(UTC+05:30) Sri Jayawardenepura	Sri Lanka Standard Time
(UTC+05:45) Kathmandu	Nepal Standard Time
(UTC+06:00) Astana	Central Asia Standard Time
(UTC+06:00) Dhaka	Bangladesh Standard Time
(UTC+06:00) Omsk	Omsk Standard Time
(UTC+06:30) Yangon (Rangoon)	Myanmar Standard Time
(UTC+07:00) Bangkok, Hanoi, Jakarta	SE Asia Standard Time
(UTC+07:00) Barnaul, Gorno-Altaysk	Altai Standard Time
(UTC+07:00) Hovd	W. Mongolia Standard Time
(UTC+07:00) Krasnoyarsk	North Asia Standard Time
(UTC+07:00) Novosibirsk	N. Central Asia Standard Time
(UTC+07:00) Tomsk	Tomsk Standard Time
(UTC+08:00) Beijing, Chongqing, Hong Kong, Urumqi	China Standard Time
(UTC+08:00) Irkutsk	North Asia East Standard Time
(UTC+08:00) Kuala Lumpur, Singapore	Singapore Standard Time
(UTC+08:00) Perth	W. Australia Standard Time
(UTC+08:00) Taipei	Taipei Standard Time
(UTC+08:00) Ulaanbaatar	Ulaanbaatar Standard Time
(UTC+08:45) Eucla	Aus Central W. Standard Time
(UTC+09:00) Chita	Transbaikal Standard Time
(UTC+09:00) Osaka, Sapporo, Tokyo	Tokyo Standard Time
(UTC+09:00) Pyongyang	North Korea Standard Time
(UTC+09:00) Seoul	Korea Standard Time
(UTC+09:00) Yakutsk	Yakutsk Standard Time
(UTC+09:30) Adelaide	Cen. Australia Standard Time
(UTC+09:30) Darwin	AUS Central Standard Time
(UTC+10:00) Brisbane	E. Australia Standard Time
(UTC+10:00) Canberra, Melbourne, Sydney	AUS Eastern Standard Time
(UTC+10:00) Guam, Port Moresby	West Pacific Standard Time
(UTC+10:00) Hobart	Tasmania Standard Time
(UTC+10:00) Vladivostok	Vladivostok Standard Time
(UTC+10:30) Lord Howe Island	Lord Howe Standard Time
(UTC+11:00) Bougainville Island	Bougainville Standard Time
(UTC+11:00) Chokurdakh	Russia Time Zone 10
(UTC+11:00) Magadan	Magadan Standard Time
(UTC+11:00) Norfolk Island	Norfolk Standard Time
(UTC+11:00) Sakhalin	Sakhalin Standard Time
(UTC+11:00) Solomon Is., New Caledonia	Central Pacific Standard Time
(UTC+12:00) Anadyr, Petropavlovsk-Kamchatsky	Russia Time Zone 11
(UTC+12:00) Auckland, Wellington	New Zealand Standard Time
(UTC+12:00) Coordinated Universal Time+12	UTC+12
(UTC+12:00) Fiji	Fiji Standard Time
(UTC+12:45) Chatham Islands	Chatham Islands Standard Time
(UTC+13:00) Coordinated Universal Time+13	UTC+13
(UTC+13:00) Nuku'alofa	Tonga Standard Time
(UTC+13:00) Samoa	Samoa Standard Time
(UTC+14:00) Kiritimati Island	Line Islands Standard Time

Complex Types - Duration

Property

Type

Description

Length

Digital

Time Length

Scale

Enumeration

Time Length Indicator

Possible value:

Milliseconds=1
Seconds=2
Minute=3
Hours=4
Days=5
Weeks=6
Months=7
Years=8

The syntax is :

"MyProperty": { "Length":1.00, "Scale":"Days"}
http return codes
Success

Code	Text	Description
200	OK	Task Completed
201	Created	Successful creation
204	No Content	The server has received the request but there is no information to send back

Error

Code	Text	Description
400	Bad Request	The request is invalid. An accompanying message is often present to explain the reason.
401	Invalid username or password	Authentication failed because the pair [login, password] is not recognised
401	Unauthorised	The request is understood but it has been denied or the rights are insufficient or the " Basic " authentication mode is not enabled on the IIS server
404	Not Found	The requested URL is invalid or the requested resource does not exist
500	Internal Server	Check the case of the entity in the URL.

For errors with the 400 code, check the syntax of the JSON file:

Values for properties of type " Enumeration " must be enclosed in quotation marks. Example : " Gender " : " 1 "
Values for properties of type " Numeric " must not be enclosed in quotation marks. Example : " Id " : 1000

Object binding operation

Add an entity to a "feature collection" navigation property

A navigation property is a relationship between 2 entities.

A POST request asks an existing entity to complete its navigation property with a new reference

For example, user 327680 is assigned a new management domain with the ID 163849

Possible types of answers:

204 No Content: OK
400 Bad Request: Technical or functional error
401 xxxxxxxxx: Security error (see chapter Security and authentication)
404 NotFound: No record (for primary or secondary entity)
500 Internal Server: Check Entity Case in URL

Remove an entity from a "feature collection" navigation property

A DELETE request asks an existing entity to remove an item from its entity collection navigation property

User 327680 is removed from the management domain with the ID 163849

Possible types of answers:

204 No Content: OK
400 Bad Request: Technical or functional error.
404 NotFound: No record (for primary or secondary entity).
500 Internal Server: Check Entity Case in URL.

Assign or replace an entity in an entity navigation property. A PUT or POST request asks an existing entity to change the reference of its navigation property to " entity "

For example, the 123 course is assigned a pedagogical manager who is none other than the user with the identifier 1234

Possible types of answers:

204 No Content: OK
400 Bad Request: Technical or functional error.
401 xxxxxxxxx: Security error (see chapter Security and authentication).
404 NotFound: No record (for primary or secondary entity).
500 Internal Server: Check Entity Case in URL.

Remove an entity from an entity navigation property

A DELETE request asks an existing entity to remove the reference from its "entity" navigation property. For example, the following query breaks the link between course 123 and the course manager with id 1234. At the end of the processing, the course is without an assignment of a pedagogical manager.

Possible types of answers:

204 No Content: OK
400 Bad Request: Technical or functional error.
401 xxxxxxxxx: Security error (see section Security and authentication).
404 NotFound: No record (for primary or secondary entity).
500 Internal Server: Check Entity Case in URL.

Management domain specification

Specify the entity's management domain when creating. By enabling the configuration parameter: "OData: Ability to specify the management domain of an entity."

You have the option of specifying via a POST request the PrimaryDomain of the created entity in relation to its Id or ExternalId:

Une image contenant texte, capture d’écran, Police, nombre Description générée automatiquement

When the request is processed, the management domain is, if found, registered on the training course for example. It will also be possible (from version 6.6) to specify the management domain when creating a training or evaluation session (by specifying in the body of the request the PrimaryDomain as in the screenshot above).

Note: The UserApi used can specify a domain only if it has access to that domain (its domain or one of its subdomains).

Was this article helpful?

What's Next

Dashboards - user guide

oData API - Appendix

In this article:

Expected Data Format

Enumeration Type

Type Date & Time

Complex Types - Duration

Error

Object binding operation

Add an entity to a "feature collection" navigation property

Remove an entity from a "feature collection" navigation property

Remove an entity from an entity navigation property

Management domain specification

What's Next