Data Formats

Data Formats

The Krios API primarily communicates using JSON for both request payloads and response data. This page provides an overview of the data formats used in the Krios API.

Request Payloads

When making API requests to the Krios API, you should format the request payloads according to the following specifications:

• Supported Content Types:
  • application/json
  • text/json
  • application/*+json
  • text/csv

application/json and text/json

For application/json and text/json content types, the request payload should adhere to the following JSON schema:

[
    {
        "UserPrincipalName": "[email protected]",
        "PtoBalance": 10.5,
        "EmployeeId": "EMP001",
        "Dob": "1990-05-15",
        "WorkAnniversary": "2020-07-01",
        "NextPayroll": "2023-06-15",
        "CustomData1": "Custom Value 1",
        "CustomData2": "Custom Value 2",
        "CustomData3": "Custom Value 3"
    },
    {
        "UserPrincipalName": "[email protected]",
        "PtoBalance": 7.8,
        "EmployeeId": "EMP002",
        "Dob": "1985-10-22",
        "WorkAnniversary": "2019-12-05",
        "NextPayroll": "2023-06-15",
        "CustomData1": "Custom Value 1",
        "CustomData2": "Custom Value 2",
        "CustomData3": "Custom Value 3"
    },
    // Add more users following the same structure
    // ...
]

The CustomData(X) Fields can be used to represent any custom data you wish to show on the card.

application/*+json

For the application/*+json content type, the request payload should follow the same JSON schema as mentioned above.

text/csv

For the text/csv content type, the request payload should be formatted as comma-separated values (CSV) with each line representing a separate record. The first line should contain the column headers, and subsequent lines should contain the corresponding values.

Response Data

The Krios API returns response data in the following formats:

Supported Content Types:

• text/plain
• application/json
• text/json

text/plain, application/json, and text/json

For text/plain, application/json, and text/json content types, the response data adheres to the following JSON schema:

[
    {
        "UserPrincipalName": "[email protected]",
        "PtoBalance": 10.5,
        "EmployeeId": "EMP001",
        "Dob": "1990-05-15",
        "WorkAnniversary": "2020-07-01",
        "NextPayroll": "2023-06-15",
        "CustomData1": "Custom Value 1",
        "CustomData2": "Custom Value 2",
        "CustomData3": "Custom Value 3"
    },
    {
        "UserPrincipalName": "[email protected]",
        "PtoBalance": 7.8,
        "EmployeeId": "EMP002",
        "Dob": "1985-10-22",
        "WorkAnniversary": "2019-12-05",
        "NextPayroll": "2023-06-15",
        "CustomData1": "Custom Value 1",
        "CustomData2": "Custom Value 2",
        "CustomData3": "Custom Value 3"
    },
    // Add more users following the same structure
    // ...
]

Replace "property1", "property2", and so on with the actual property names and their respective data types specific to your API responses.

Next Steps

Now that you have an understanding of the data formats used in the Krios API, you can proceed with implementing the necessary logic in your application to handle request payloads and process response data.

If you have any questions or need further assistance, please reach out to our support team through the links provided in the Support section.