API iDApports

Headers

 

The authentication headers are :

Header name

Description

Format

Example

UserId 

User token obtained through authentication mechanism (signin service)

string

ApiKey 

Api key (fixed configured keys)

string

Either UserId or ApiKey should be used (if both are used, UserId is used in priority)

 

Lists of headers that can control returned informations

Header name

Description

Format

Example

x-ids-select-fields 

Filter fields of the JSON response, other fields are not serialized. fields are separated by ',' or ';'
Wildcards are not supported yet

string

field1, field2

x-ids-type-identite 

Select the "code" information to use. Allowed values are :

  • IDA (default if header is omitted) : internal iDApports code is used
  • GRT : iDGRT code is used, GRT link must be enabled
  • GFA : GFA code is used, GFA link must be enabled
  • EXT : external code is used, this information exists when entities are created from another source

string

IDA

x-ids-timezone-handling 

Handles timezone in datetime data.

  • if false (default) : datetime values are serialized/deserialized as is, timezone information is ignored
  • if true :
    • Input : treat as local time. If the DateTime object represents a Coordinated Universal Time (UTC), it is converted to the local time
    • Output : includes timezone information

boolean

true

false (default)

x-ids-tenant-name 

Specifies tenant to connect to. This is optional and default tenant will be used if this header is omited.

This header will be only used during connection (so only the connection API will consider this header). Once a tenant is associated to a token, this can't be changed. To use another tenant, it is mandatory to use another signin.

string

MyTenant

AnotherTenant