Data models
The fields of each model used in request and response bodies.
Address
| Field | Type | Description |
|---|
street | string (nullable) | Street and house number. |
city | string (nullable) | City. |
state | string (nullable) | State, province or region (may be empty). |
zip | string (nullable) | Postal code. |
country | string (nullable) | Country name. |
geo | GeoLocation | |
Album
| Field | Type | Description |
|---|
id | integer (int32) | Unique ID, assigned by the server. |
userId | integer (int32) | Owner user ID (positive; 101-110 in the seed data). |
title | string (nullable) | Album title (required). |
ApiRequestData
| Field | Type | Description |
|---|
endpointUrl | string (nullable) | |
methodName | string (nullable) | |
requestBody | string (nullable) | |
Book
| Field | Type | Description |
|---|
id | integer (int32) | Unique ID, assigned by the server. |
title | string (nullable) | Title (required). |
author | string (nullable) | Author (required). |
isbn | string (nullable) | ISBN-13 without hyphens. |
genre | string (nullable) | Genre, e.g. fantasy. |
publishedYear | integer (int32) | Year first published. |
pages | integer (int32) | Page count; zero or greater. |
language | string (nullable) | Original language. |
price | number (double) | Price in USD; zero or greater. |
rating | number (double) | Average rating from 0 to 5. |
available | boolean | Whether the book is in stock. |
tags | array<string> (nullable) | Free-form tags. |
CachingControllerDocumentUpdate
| Field | Type | Description |
|---|
title | string (nullable) | New title, or null to keep the current one. |
content | string (nullable) | New content, or null to keep the current one. |
Cart
| Field | Type | Description |
|---|
id | integer (int32) | |
userId | integer (int32) | |
items | array<CartItem> (nullable) | |
total | number (double) | |
updatedAt | string (nullable) | |
CartItem
| Field | Type | Description |
|---|
productId | integer (int32) | |
quantity | integer (int32) | |
price | number (double) | |
Company
| Field | Type | Description |
|---|
id | integer (int32) | Unique ID, assigned by the server. |
name | string (nullable) | Company name (required). |
industry | string (nullable) | Industry (required). |
founded | integer (int32) | Year founded (1800 to the current year, or 0 if unknown). |
website | string (nullable) | Website URL. |
headquarters | CompanyHeadquarters | |
revenue | number (double) | Annual revenue in USD; zero or greater. |
employeeCount | integer (int32) | Headcount; zero or greater. |
CompanyHeadquarters
| Field | Type | Description |
|---|
city | string (nullable) | City. |
country | string (nullable) | Country. |
CookiesControllerLoginBody
| Field | Type | Description |
|---|
username | string (nullable) | Account name: test or admin (case-insensitive). |
password | string (nullable) | Account password: test123 or admin123 (case-sensitive). |
Country
| Field | Type | Description |
|---|
id | integer (int32) | Unique ID, assigned by the server. |
name | string (nullable) | Common name (required). |
code | string (nullable) | ISO 3166-1 alpha-2 code (required, 2 letters). |
code3 | string (nullable) | ISO 3166-1 alpha-3 code (3 letters). |
capital | string (nullable) | Capital city. |
region | string (nullable) | Region: Africa, Americas, Asia, Europe or Oceania. |
population | integer (int64) | Approximate population; zero or greater. |
area | number (double) | Area in square kilometres; zero or greater. |
currency | CountryCurrency | |
languages | array<string> (nullable) | Official or main languages. |
callingCode | string (nullable) | International dialling code, e.g. +81. |
flag | string (nullable) | Flag emoji. |
timezones | array<string> (nullable) | UTC offsets used. |
CountryCurrency
| Field | Type | Description |
|---|
code | string (nullable) | ISO 4217 code, e.g. JPY. |
name | string (nullable) | Currency name. |
symbol | string (nullable) | Currency symbol. |
Employee
| Field | Type | Description |
|---|
id | integer (int32) | Unique ID, assigned by the server. |
firstName | string (nullable) | Given name (required). |
lastName | string (nullable) | Family name (required). |
email | string (nullable) | Work email (required, must contain @). |
phone | string (nullable) | Phone number. |
department | string (nullable) | Department name (required). |
title | string (nullable) | Job title. |
salary | number (double) | Annual salary; zero or greater. |
hireDate | string (nullable) | Hire date (yyyy-MM-dd). |
managerId | integer (int32) (nullable) | ID of the employee's manager, or null at the top of the org chart. |
companyId | integer (int32) | ID of the employing company. |
skills | array<string> (nullable) | Skill tags. |
address | Address | |
active | boolean | Whether the employee currently works there. |
Event
| Field | Type | Description |
|---|
id | integer (int32) | Unique ID, assigned by the server. |
name | string (nullable) | Event name (required). |
category | string (nullable) | Category, e.g. conference. |
venue | string (nullable) | Venue name. |
city | string (nullable) | City. |
startsAt | string (nullable) | Start time, ISO 8601 UTC (required). |
endsAt | string (nullable) | End time, ISO 8601 UTC; must not be before StartsAt. |
price | number (double) | Ticket price in USD; 0 means free. |
capacity | integer (int32) | Maximum attendees. |
ticketsSold | integer (int32) | Tickets sold; cannot exceed Capacity. |
organizer | string (nullable) | Organizer name. |
tags | array<string> (nullable) | Free-form tags. |
GeoLocation
| Field | Type | Description |
|---|
lat | number (double) | Latitude in decimal degrees. |
lng | number (double) | Longitude in decimal degrees. |
JobsControllerJobRequest
| Field | Type | Description |
|---|
type | string (nullable) | Job type: report, export, import or fail (fails at 60%). Default report. |
durationSeconds | integer (int32) (nullable) | How long the job runs after leaving the queue, in seconds (1-60, default 10). |
JwtAuthControllerLoginRequest
| Field | Type | Description |
|---|
username | string (nullable) | Username (case-insensitive): admin or user. |
password | string (nullable) | Password (case-sensitive): admin123 or user123. |
JwtAuthControllerRefreshRequest
| Field | Type | Description |
|---|
refreshToken | string (nullable) | The refreshToken from login or a previous refresh. |
Movie
| Field | Type | Description |
|---|
id | integer (int32) | Unique ID, assigned by the server. |
title | string (nullable) | Title (required). |
director | string (nullable) | Director (required). |
year | integer (int32) | Release year (1888 to five years from now, or 0 if unknown). |
genres | array<string> (nullable) | Genres, e.g. Sci-Fi. |
runtimeMinutes | integer (int32) | Runtime in minutes; zero or greater. |
rating | number (double) | Rating from 0 to 10. |
cast | array<string> (nullable) | Leading cast members. |
boxOffice | integer (int64) | Worldwide box office in USD. |
poster | string (nullable) | Poster image URL. |
Order
| Field | Type | Description |
|---|
id | integer (int32) | |
userId | integer (int32) | |
items | array<OrderItem> (nullable) | |
total | number (double) | |
status | string (nullable) | |
shippingAddress | ShippingAddress | |
orderedAt | string (nullable) | |
deliveredAt | string (nullable) | |
OrderItem
| Field | Type | Description |
|---|
productId | integer (int32) | |
title | string (nullable) | |
quantity | integer (int32) | |
price | number (double) | |
Person
| Field | Type | Description |
|---|
id | integer (int32) | Unique ID, assigned by the server. |
firstName | string (nullable) | Given name (required). |
lastName | string (nullable) | Family name (required). |
username | string (nullable) | Username (required). |
email | string (nullable) | Email address (required, must contain @). |
gender | string (nullable) | Gender. |
dateOfBirth | string (nullable) | Date of birth (yyyy-MM-dd). |
phone | string (nullable) | Phone number. |
avatar | string (nullable) | Avatar image URL. |
address | Address | |
company | PersonCompany | |
PersonCompany
| Field | Type | Description |
|---|
name | string (nullable) | Company name. |
title | string (nullable) | Job title. |
Photo
| Field | Type | Description |
|---|
id | integer (int32) | Unique ID, assigned by the server. |
albumId | integer (int32) | ID of the album it belongs to (positive). |
title | string (nullable) | Caption (required). |
url | string (nullable) | Full-size image URL (absolute). |
thumbnailUrl | string (nullable) | Thumbnail image URL. |
Post
| Field | Type | Description |
|---|
id | integer (int32) | |
userId | integer (int32) | |
title | string (nullable) | |
body | string (nullable) | |
tags | array<string> (nullable) | |
publishedAt | string (nullable) | |
likes | integer (int32) | |
Product
| Field | Type | Description |
|---|
id | integer (int32) | |
title | string (nullable) | |
price | number (double) | |
description | string (nullable) | |
category | string (nullable) | |
image | string (nullable) | |
rating | Rating | |
inStock | boolean | |
createdAt | string (nullable) | |
Rating
| Field | Type | Description |
|---|
rate | number (double) | |
count | integer (int32) | |
ShippingAddress
| Field | Type | Description |
|---|
street | string (nullable) | |
city | string (nullable) | |
state | string (nullable) | |
zip | string (nullable) | |
country | string (nullable) | |
Todo
| Field | Type | Description |
|---|
id | integer (int32) | |
userId | integer (int32) | |
title | string (nullable) | |
completed | boolean | |
priority | string (nullable) | |
dueDate | string (nullable) | |
User
| Field | Type | Description |
|---|
userId | integer (int32) | |
name | string (nullable) | |
email | string (nullable) | |
job | string (nullable) | |
city | string (nullable) | |
UserLogin
| Field | Type | Description |
|---|
username | string (nullable) | |
password | string (nullable) | |
UserXmlRequest
| Field | Type | Description |
|---|
name | string (nullable) | |
job | string (nullable) | |
city | string (nullable) | |
ValidationControllerAnnotatedSignup
| Field | Type | Description |
|---|
usernamerequired | string | Required, 3-20 characters. |
emailrequired | string (email) | Required, must be a valid email address. |
age | integer (int32) | Age, 18-120. |
countryCoderequired | string | Required, 2-letter uppercase ISO country code, e.g. US. |
website | string (uri) (nullable) | Optional absolute http(s) or ftp URL. |
phone | string (tel) (nullable) | Optional phone number. |
tags | array<string> (nullable) | Optional list of 1-5 tags. |
WebhooksControllerCreateBinRequest
| Field | Type | Description |
|---|
name | string (nullable) | Optional display name (up to 100 characters). Defaults to bin-xxxxxx. |