> For the complete documentation index, see [llms.txt](https://docs.shiftiq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shiftiq.com/developers/api-v1/api-reference/models.md).

# Models

## The FormsElement object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"FormsElement":{"type":"object","properties":{"name":{"type":"string"},"pk":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The OrderInfo object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"OrderInfo":{"type":"object","properties":{"Organization":{"format":"uuid","type":"string"},"Customer":{"format":"uuid","type":"string"},"Invoice":{"format":"uuid","type":"string"},"InvoiceNumber":{"format":"int32","type":"integer"},"CreatedDate":{"format":"date-time","type":"string"},"CheckoutInfo":{"$ref":"#/components/schemas/CheckoutInfo"},"OrderItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}}}},"CheckoutInfo":{"type":"object","properties":{"FirstName":{"type":"string"},"MiddleName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"Company":{"type":"string"},"Street1":{"type":"string"},"Street2":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"Country":{"type":"string"},"PostalCode":{"type":"string"},"Phone":{"type":"string"}}},"OrderItem":{"type":"object","properties":{"Id":{"format":"uuid","type":"string"},"Quantity":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Price":{"format":"double","type":"number"},"ProductId":{"format":"uuid","type":"string"},"Name":{"type":"string"},"ProductUrl":{"type":"string"}}}}}}
```

## The CheckoutInfo object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"CheckoutInfo":{"type":"object","properties":{"FirstName":{"type":"string"},"MiddleName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"Company":{"type":"string"},"Street1":{"type":"string"},"Street2":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"Country":{"type":"string"},"PostalCode":{"type":"string"},"Phone":{"type":"string"}}}}}}
```

## The OrderItem object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"OrderItem":{"type":"object","properties":{"Id":{"format":"uuid","type":"string"},"Quantity":{"format":"int32","type":"integer"},"Description":{"type":"string"},"Price":{"format":"double","type":"number"},"ProductId":{"format":"uuid","type":"string"},"Name":{"type":"string"},"ProductUrl":{"type":"string"}}}}}}
```

## The AddEvent object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"AddEvent":{"type":"object","properties":{"EventVenue":{"format":"uuid","type":"string"},"EventStart":{"format":"date-time","type":"string"},"EventExamType":{"type":"string"},"EventExamFormat":{"type":"string"},"EventBillingCode":{"type":"string"},"RegistrationLimit":{"format":"int32","type":"integer"}}}}}}
```

## The CancelEvent object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"CancelEvent":{"type":"object","properties":{"Reason":{"type":"string"}}}}}}
```

## The AttendanceCriteria object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"AttendanceCriteria":{"type":"object","properties":{"Name":{"type":"string"},"Email":{"type":"string"},"Code":{"type":"string"},"LastChangeTimeSince":{"format":"date-time","type":"string"},"LastChangeTimeBefore":{"format":"date-time","type":"string"}}}}}}
```

## The AddRegistrationLax object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"AddRegistrationLax":{"type":"object","properties":{"EventVenue":{"format":"uuid","type":"string"},"EventStart":{"format":"date-time","type":"string"},"EventExamType":{"type":"string"},"EventExamFormat":{"type":"string"},"EventBillingCode":{"type":"string"},"Learner":{"format":"uuid","type":"string"},"LearnerRegistrantType":{"type":"string"},"Assessment":{"type":"string"},"Accommodations":{"type":"array","items":{"$ref":"#/components/schemas/GrantRegistrationAccommodation"}}}},"GrantRegistrationAccommodation":{"type":"object","properties":{"Type":{"type":"string"},"Name":{"type":"string"},"TimeExtension":{"format":"int32","type":"integer"}}}}}}
```

## The GrantRegistrationAccommodation object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"GrantRegistrationAccommodation":{"type":"object","properties":{"Type":{"type":"string"},"Name":{"type":"string"},"TimeExtension":{"format":"int32","type":"integer"}}}}}}
```

## The TransferRegistrationLax object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"TransferRegistrationLax":{"type":"object","properties":{"EventVenue":{"format":"uuid","type":"string"},"EventStart":{"format":"date-time","type":"string"},"EventExamType":{"type":"string"},"Learner":{"format":"uuid","type":"string"},"Reason":{"type":"string"},"Accommodations":{"type":"array","items":{"$ref":"#/components/schemas/GrantRegistrationAccommodation"}}}},"GrantRegistrationAccommodation":{"type":"object","properties":{"Type":{"type":"string"},"Name":{"type":"string"},"TimeExtension":{"format":"int32","type":"integer"}}}}}}
```

## The CancelRegistration object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"CancelRegistration":{"type":"object","properties":{"Reason":{"type":"string"}}}}}}
```

## The ChangeAssessment object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"ChangeAssessment":{"type":"object","properties":{"Assessment":{"type":"string"}}}}}}
```

## The RevokeRegistrationAccommodation object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"RevokeRegistrationAccommodation":{"type":"object","properties":{"Type":{"type":"string"}}}}}}
```

## The TreeStateParams object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"TreeStateParams":{"type":"object","properties":{"Collapsed":{"type":"array","items":{"format":"uuid","type":"string"}},"Expanded":{"type":"array","items":{"format":"uuid","type":"string"}}}}}}}
```

## The KeyValuePair\[String,String] object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"KeyValuePair[String,String]":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}
```

## The Learner object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"Learner":{"type":"object","properties":{"Identifier":{"format":"uuid","type":"string"},"FirstName":{"type":"string"},"MiddleName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"Code":{"type":"string"},"Password":{"type":"string"},"IsAdministrator":{"type":"boolean"},"IsLearner":{"type":"boolean"},"AccessGranted":{"format":"date-time","type":"string"},"AccessRevoked":{"format":"date-time","type":"string"},"HomeAddress":{"$ref":"#/components/schemas/Address"}}},"Address":{"type":"object","properties":{"Street1":{"type":"string"},"Street2":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"Country":{"type":"string"},"PostalCode":{"type":"string"}}}}}}
```

## The Address object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"Address":{"type":"object","properties":{"Street1":{"type":"string"},"Street2":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"Country":{"type":"string"},"PostalCode":{"type":"string"}}}}}}
```

## The LearnerCriteria object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"LearnerCriteria":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"Code":{"type":"string"}}}}}}
```

## The UpdateProgram object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"UpdateProgram":{"type":"object","properties":{"ProgramName":{"type":"string"},"ProgramType":{"type":"string"},"AssessmentFormCode":{"type":"string"},"AssessmentFormName":{"type":"string"},"Created":{"format":"date-time","type":"string"},"Modified":{"format":"date-time","type":"string"}}}}}}
```

## The JwtRequest object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"JwtRequest":{"type":"object","properties":{"Debug":{"type":"boolean"},"Paging":{"type":"boolean"},"Secret":{"type":"string"},"Lifetime":{"format":"int32","type":"integer"},"Organization":{"format":"uuid","type":"string"},"Agent":{"format":"uuid","type":"string"},"Subject":{"format":"uuid","type":"string"}}}}}}
```

## The LoginModel object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"LoginModel":{"type":"object","properties":{"Email":{"type":"string"},"Password":{"type":"string"},"OrganizationIdentifier":{"format":"uuid","type":"string"}}}}}}
```

## The PagesContactUsModel object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"PagesContactUsModel":{"required":["Email","Message"],"type":"object","properties":{"Name":{"type":"string"},"Email":{"type":"string"},"Phone":{"type":"string"},"Subject":{"type":"string"},"Message":{"type":"string"},"RequestUrl":{"type":"string"}}}}}}
```

## The RenameRequest object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"RenameRequest":{"type":"object","properties":{"From":{"type":"string"},"To":{"type":"string"}}}}}}
```

## The PagesContactUsModel2 object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"PagesContactUsModel2":{"type":"object","properties":{"Name":{"type":"string"},"Email":{"type":"string"},"Phone":{"type":"string"},"Comment":{"type":"string"},"RequestUrl":{"type":"string"}}}}}}
```

## The CmdsBlogSubscriptionRequested object

```json
{"openapi":"3.1.1","info":{"title":"API Version 1","version":"v1"},"components":{"schemas":{"CmdsBlogSubscriptionRequested":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.shiftiq.com/developers/api-v1/api-reference/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.