### Get Single AddressType Request Example

Source: https://alliant.redoc.ly/8.1/tag/Miscellaneous-Endpoints

This shows how to request a single AddressType by its unique identifier (GUID). The 'guid' is a required path parameter.

```HTTP
GET /api/data/addressTypes/{guid}
```

--------------------------------

### Example API Request with Query Parameters

Source: https://alliant.redoc.ly/8.1/tag/Transaction-Characteristics

This example demonstrates how to construct an API request to the get/api/data/userX/{guid} endpoint, utilizing various query parameters to customize the response. It shows how to include attachments, set verbosity levels, specify properties to include or exclude, and apply context replacement.

```HTTP
GET /api/data/userX/{guid}?downloadAttachments=true&verbose=true&include=property1,childItem1&exclude=property2&contextReplace=displayName&getWarnings=true&autoLogOff=true HTTP/1.1
Host: api.alliant.com
```

--------------------------------

### In Use Tool Response Example (JSON)

Source: https://alliant.redoc.ly/8.1/tag/Contract-Groups

Shows the structure of a response when using the 'In Use Tool' on a contract group. It returns a list of items referencing the contract group, along with error and warning flags.

```json
{
  "result": [
    {
      "referencedIn": "string",
      "id": "string",
      "description": "string"
}
],
  "errors": [ ],
  "warnings": [ ],
  "hasErrors": false,
  "hasWarnings": false

}
```

--------------------------------

### Get Single IP Rights Template Parameter Request (Path Parameter)

Source: https://alliant.redoc.ly/8.1/tag/IP-Rights-Templates

Example of how to request a single IP Rights Template Parameter using its unique identifier (GUID) in the path. The 'guid' parameter is required.

```text
/api/data/ipRightsParmColumns/{guid}
```

--------------------------------

### Get Single Country Request Example

Source: https://alliant.redoc.ly/8.1/tag/Miscellaneous-Endpoints

This describes how to request data for a specific country using its unique identifier (GUID) in the path parameters. Authentication is typically handled via headers.

```text
GET /api/data/countries/{guid}
Header:
Token: <your_token>
```

--------------------------------

### Query Parameter Examples

Source: https://alliant.redoc.ly/8.1/tag/Miscellaneous-Endpoints

Examples demonstrating the usage of various query parameters to customize API responses. These include controlling verbosity, including specific fields, excluding others, and replacing context values.

```text
include=property1,childItem1,childItem2.childProperty2,udLookup_UDField1
exclude=property1,childItem1,childItem2.childProperty2,udLookup_UDField1
contextReplace=displayName,ud_UDField1
contextReplace=all
```

--------------------------------

### Submit Import Batch for Processing (PATCH Request Example)

Source: https://alliant.redoc.ly/8.1/tag/Transaction-Characteristic-Import

This example shows how to submit an Import UserX Batch for processing without sending additional UserX data. This is typically done after all pages have been submitted, by including the 'submit' query parameter in a PATCH request to the batch endpoint.

```http
PATCH /api/import/userXs/batch/{batchID}?submit=1
```

--------------------------------

### Get Single File System Location Request Example

Source: https://alliant.redoc.ly/8.1/tag/Miscellaneous-Endpoints

This shows how to request data for a single File System Location item using its unique 'guid' as a path parameter. This is a common pattern for retrieving specific resources.

```http
GET /api/data/fileSystemLocations/{guid} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_TOKEN
```

--------------------------------

### Submit Import Job for Processing (PATCH Request Example with Query Parameters)

Source: https://alliant.redoc.ly/8.1/tag/Contact-Import

This example demonstrates how to submit an Import Contact Batch for processing after all pages have been sent. It utilizes query parameters like 'submit', 'jobPriority', and 'jobClass' to control the import job's execution.

```json
PATCH /api/import/contacts/batch/{batchID}?submit=1&jobPriority=1&jobClass=Any Time of the Day
```

--------------------------------

### Get Single Transfer Type Request Example

Source: https://alliant.redoc.ly/8.1/tag/Miscellaneous-Endpoints

This describes how to request a single Transfer Type item using its unique identifier (GUID) in the path parameters. It's a fundamental operation for retrieving specific resource details.

```text
guid: string (required) - Transfer Type Unique Identity
```

--------------------------------

### UserX Batch Import Response Example

Source: https://alliant.redoc.ly/8.1/tag/Transaction-Characteristic-Import

This is a sample JSON response for a successful retrieval of UserX batch import data. It includes details about the import process, pagination, and a list of imported items, each with their associated properties and user-defined fields.

```json
{
  "result": {
    "importFileName": "userxs",
    "importFileSID": 140,
    "description": "UserX Import from Alliant API",
    "fileDownloadNumber": null,
    "pageSize": 2,
    "totalItems": 2,
    "batchId": 22,
    "pageNumber": 0,
    "receivedItems": 2,
    "createdDateTime": "2022-27-25",
    "items": [
      {
        "adminClassReference": {
          "id": "exampleID"
        },
        "comment": "Example Comment",
        "description": "Pebbles 2: Secret of the Ooze",
        "id": "004 Product",
        "ipRightsBearingFlag": true,
        "parentReference": {
          "id": "idOfParent"
        },
        "royaltyBearingFlag": true,
        "ud_userDefinedStringField": "ud field Value",
        "ud_userDefinedNumberField": 0,
        "ud_userDefinedReference": {
          "id": "exampleID"
        },
        "udLookup_LookupUDField": {
          "udfLookupItems": [
            {
              "amount1Range": "1:3",
              "amount2Range": "2:4",
              "contact1Reference": {
                "id": "exampleID"
              },
              "contact2Reference": {
                "id": "exampleID"
              },
              "contact3Reference": {
                "id": "exampleID"
              },
              "contact4Reference": {
                "id": "exampleID"
              },
              "endActualPeriodReference": {
                "id": "exampleID"
              },
              "endOtherPeriodReference": {
                "id": "exampleID"
              },
              "endPostedPeriodReference": {
                "id": "exampleID"
              },
              "fromDate": "2019-08-24T14:15:22Z",
              "price1Range": "4.21:30.45",
              "price2Range": "5.24:532.21",
              "rate1Range": "2.3:5.2",
              "rate2Range": "8.6:45.2",
              "rate3Range": "10.3:87.0",
              "sortOrderNumber": 1,
              "startActualPeriodReference": {
                "id": "exampleID"
              },
              "startOtherPeriodReference": {
                "id": "exampleID"
              },
              "startPostedPeriodReference": {
                "id": "exampleID"
              },
              "text1": "example text",
              "text2": "example test",
              "toDate": "2019-08-24T14:15:22Z",
              "ud_LookupUDField": "exampleUDFValue",
              "udKeyXHierarchyTypeReference": {
                "id": "exampleID"
              },
              "udKeyXListReference": {
                "description": "exampleDescription"
              },
              "udKeyXReference": {
                "id": "exampleID"
              },
              "unit1Range": "5:200",
              "unit2Range": "5:100"
            }
          ]
        },
        "user1BOMHeaders": [
          {
            "allocationMethodReference": {
              "registeredProdedureName": "NameOfProcedure"
            },
            "allocationUDFReference": {
              "name": "udfName"
            },
            "effectiveFromDate": "2021-08-06T00:00:00",
            "effectiveToDate": "9999-12-31T23:59:59",
            "user1BOMDetails": [
              {
                "allocationPercent": 100,
                "largeSortOrderNumber": 1,
                "quantity": 1,
                "udKey1Reference": {
                  "id": "exampleID"
                }
              }
            ]
          }
        ]
      }
    ]
  },
  "errors": [],
  "warnings": [],
  "hasErrors": false,
  "hasWarnings": false
}
```

--------------------------------

### GET /api/data/emailTypes/{guid}

Source: https://alliant.redoc.ly/8.1/tag/Miscellaneous-Endpoints

Retrieves a single email type by its GUID.

```APIDOC
## GET /api/data/emailTypes/{guid}

### Description
Read the data for a specific EmailType using its unique identifier (GUID).

### Method
GET

### Endpoint
`/api/data/emailTypes/{guid}`

### Parameters
#### Path Parameters
- **guid** (string) - Required - The EmailType's Unique Identity.
```

--------------------------------

### Submit UserX Page for Import Batch (PATCH Request Example)

Source: https://alliant.redoc.ly/8.1/tag/Transaction-Characteristic-Import

This example demonstrates how to submit a page of UserX data for an existing Import UserX Batch using a PATCH request. It requires the 'batchID' in the path and includes query parameters like 'submit' to finalize the batch, 'jobPriority', and 'jobClass' for job configuration.

```http
PATCH /api/import/userXs/batch/{batchID}?submit=1&jobPriority=1&jobClass=Any%20Time%20of%20the%20Day

{
  "pageNumber": 0,
  "items": [
    {
      "userId": "user1",
      "firstName": "John",
      "lastName": "Doe"
    },
    {
      "userId": "user2",
      "firstName": "Jane",
      "lastName": "Smith"
    }
  ]
}
```

--------------------------------

### GET /api/data/addressTypes/{guid}

Source: https://alliant.redoc.ly/8.1/tag/Miscellaneous-Endpoints

Retrieves a single address type by its GUID.

```APIDOC
## GET /api/data/addressTypes/{guid}

### Description
Reads the data for a specific AddressType using its unique identifier (GUID).

### Method
GET

### Endpoint
`/api/data/addressTypes/{guid}`

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identity (GUID) of the AddressType.

### Request Example
```
GET /api/data/addressTypes/a1b2c3d4-e5f6-7890-1234-567890abcdef
```

### Response
#### Success Response (200)
Returns the AddressType object matching the provided GUID. The structure is similar to the items within the `items` array in the `GET /api/data/addressTypes` response.

#### Response Example
```json
{
  "_type": "dataItemType",
  "displayName": "Residential",
  "guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "comment": "For residential addresses.",
  "description": "Residential address type.",
  "id": "RES",
  "modifiedByUserReference": {
    "_type": "dataItemType",
    "displayName": "Admin User",
    "guid": "b2c3d4e5-f6a7-8901-2345-67890abcdef1",
    "sid": 1
  },
  "modifiedDatetime": "2023-10-27T10:00:00Z",
  "sid": 1,
  "systemModifiedDatetime": "2023-10-27T10:00:00Z"
}
```

#### Error Responses
- **400** Bad Request
- **403** Forbidden
- **404** Not Found
- **405** Method Not Allowed
- **500** Internal Server Error
```

--------------------------------

### GET /api/data/transferTypes/{guid}

Source: https://alliant.redoc.ly/8.1/tag/Miscellaneous-Endpoints

Retrieves a single Transfer Type item by its GUID.

```APIDOC
## GET /api/data/transferTypes/{guid}

### Description
Read the data for a single Transfer Type Item using its unique identifier (GUID).

### Method
GET

### Endpoint
`/api/data/transferTypes/{guid}`

### Parameters

#### Path Parameters

- **`guid`** (string) - Required - The unique identifier for the Transfer Type.

### Request Example
```json
{
  "guid": "508e47b8-98d2-4c1e-8529-8e1da48b97e1"
}
```

### Response

#### Success Response (200)
- **`_type`** (string) - The type of the item.
- **`authorizationScope`** (string) - Authorization scope, or null.
- **`authorizationURL`** (string) - Authorization URL, or null.
- **`comment`** (string) - Comment about the transfer type, or null.
- **`description`** (string) - Description of the transfer type.
- **`displayName`** (string) - Display name of the transfer type.
- **`guid`** (string) - Unique identifier for the transfer type.
- **`id`** (string) - ID of the transfer type.
- **`sid`** (integer) - SID of the transfer type.
- **`sortOrderNumber`** (integer) - Sort order number.
- **`systemModifiedDatetime`** (string) - The date and time the item was last modified.
- **`tokenURL`** (string) - Token URL, or null.

#### Response Example (200)
```json
{
  "_type": "transferType",
  "authorizationScope": null,
  "authorizationURL": null,
  "comment": null,
  "description": "Amazon S3",
  "displayName": "Amazon S3",
  "guid": "508e47b8-98d2-4c1e-8529-8e1da48b97e1",
  "id": "S3",
  "sid": 3,
  "sortOrderNumber": 4,
  "systemModifiedDatetime": "2022-10-05T11:37:24",
  "tokenURL": null
}
```

#### Error Responses
- **400** Bad Request
- **403** Forbidden
- **404** Not Found
- **405** Method Not Allowed
- **500** Internal Server Error
```

--------------------------------

### Import Contract Batch Creation Response Example (JSON)

Source: https://alliant.redoc.ly/8.1/tag/Contract-Import

This example shows a successful response (HTTP 201 OK) after creating an import contract batch. It returns a batch ID and a job queue GUID for further operations.

```json
{
  "result": {
    "batchId": 1,
    "jobQueueGuid": "e29a07ac-4391-4846-9cf6-492fbba5b2dc"
  },
  "errors": [],
  "warnings": [],
  "hasErrors": false,
  "hasWarnings": false
}
```

--------------------------------

### GET /api/data/addressFormats/{guid}

Source: https://alliant.redoc.ly/8.1/tag/Miscellaneous-Endpoints

Reads the data for a specific AddressFormat using its GUID.

```APIDOC
## GET /api/data/addressFormats/{guid}

### Description
Reads the data for a specific AddressFormat using its GUID.

### Method
GET

### Endpoint
/api/data/addressFormats/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier for the AddressFormat.

### Request Example
```
GET /api/data/addressFormats/6c556cd8-ac27-4167-844c-f00ddb170b3f
```

### Response
#### Success Response (200)
Returns the AddressFormat object matching the provided GUID. The structure is similar to the items within the `items` array in the `GET /api/data/addressFormats` response.

#### Response Example
```json
{
  "_type": "dataItemType",
  "displayName": "US Address",
  "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
  "cityLabel": "City",
  "cityRequiredFlag": true,
  "cityUsedFlag": true,
  "comment": "Standard US address format.",
  "description": "str-US-Address",
  "id": "USADR",
  "modifiedByUserReference": {
    "_type": "dataItemType",
    "displayName": "Admin User",
    "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
    "sid": 1
  },
  "modifiedDatetime": "2019-08-24T14:15:22Z",
  "sid": 1,
  "stateLabel": "State",
  "stateRequiredFlag": true,
  "stateUsedFlag": true,
  "systemModifiedDatetime": "2019-08-24T14:15:22Z",
  "zipCodeLabel": "Zip Code",
  "zipCodeRequiredFlag": true,
  "zipCodeUsedFlag": true
}
```

#### Error Responses
- **400** Bad Request
- **403** Forbidden
- **404** Not Found
- **405** Method Not Allowed
- **500** Internal Server Error
```

--------------------------------

### Create Import Contract Batch Request Body Example (JSON)

Source: https://alliant.redoc.ly/8.1/tag/Contract-Import

This example demonstrates the structure of the JSON request body required to create an import contract batch. It includes essential fields like import file name, description, page size, and total items.

```json
{
  "importFileName": "APIContracts",
  "description": "Contract Import from Alliant API",
  "pageSize": 2,
  "totalItems": 2
}
```

--------------------------------

### GET /api/data/accessLevels/{guid}

Source: https://alliant.redoc.ly/8.1/tag/Miscellaneous-Endpoints

Retrieves a single Access Level item by its GUID.

```APIDOC
## GET /api/data/accessLevels/{guid}

### Description
Read the data for a single Access Level Item. Alliant Access Levels define the level of access an Alliant User has to certain data (for example, **Normal** or **Supervisor**).

### Method
GET

### Endpoint
/api/data/accessLevels/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - Access Level Unique Identity

### Request Example
```
GET /api/data/accessLevels/8d2eca39-3578-4f8d-b1fa-4efde6a9aad3
```

### Response
#### Success Response (200)
- **_type** (string) - The type of the item (e.g., 'accessLevel').
- **description** (string) - Description of the access level.
- **displayName** (string) - Display name of the access level.
- **guid** (string) - Unique identifier for the access level.
- **id** (string) - The ID of the access level.
- **smallSID** (integer) - Small System Identifier for the access level.
- **systemModifiedDatetime** (string) - The date and time the access level was last modified.

#### Response Example (200 OK)
```json
{
  "_type": "accessLevel",
  "description": "Confidential",
  "displayName": "Confidential",
  "guid": "8d2eca39-3578-4f8d-b1fa-4efde6a9aad3",
  "id": "Confidential",
  "smallSID": 2,
  "systemModifiedDatetime": "2013-01-07T07:47:50.14"
}
```

#### Error Responses
- **400** Bad Request
- **403** Forbidden
- **404** Not Found
- **405** Method Not Allowed
- **500** Internal Server Error
```

--------------------------------

### Submit Import Contract Batch for Processing (PATCH Request Example)

Source: https://alliant.redoc.ly/8.1/tag/Contract-Import

This example shows how to submit an import contract batch for processing without sending additional contract data. This is typically done after all pages have been submitted, using the 'submit' parameter.

```http
PATCH /api/import/contracts/batch/{batchID}?submit=1

---

Request Body Example (no data, only submit parameter):
(Empty Body)
```

--------------------------------

### Create Import Contact Batch Request Body Example (JSON)

Source: https://alliant.redoc.ly/8.1/tag/Contact-Import

This example demonstrates the structure of the JSON request body required to create a new Import Contact Batch. It includes essential fields like the import file name, a description, page size, and the total number of items.

```json
{
  "importFileName": "APIContacts",
  "description": "Contact Import from Alliant API",
  "pageSize": 2,
  "totalItems": 2
}
```

--------------------------------

### Get WebServiceLog by GUID

Source: https://alliant.redoc.ly/8.1/tag/Miscellaneous-Endpoints

Retrieves the data for a specific WebServiceLog using its unique GUID.

```APIDOC
## GET /websites/alliant_redoc_ly/webservice_logs/{guid}

### Description
Read the data for a specific WebServiceLog.

### Method
GET

### Endpoint
/websites/alliant_redoc_ly/webservice_logs/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - WebServiceLog Unique Identity

### Request Example
(No request body for GET request)

### Response
#### Success Response (200)
- **(Response fields depend on the WebServiceLog structure)**

#### Response Example
```json
{
  "example": "WebServiceLog data"
}
```
```