POST /api/.../importprofiles
Create an import profile.
| Name | Type | Required | Description |
|---|---|---|---|
| id | Integer | Yes | The unique id assigned to import profile. |
| Import Profile Data | DtoImportProfileData | Yes | Define this parameter in the request body. |
| Property | Type | Nullable | Description |
|---|---|---|---|
| ProfileName | string | No | The unique name assigned to the import profile. |
| ProfileDescription | string | Yes | The description of the import profile. |
| VendorAccountID | int | Yes | The unique id assigned to a vendor account. |
| Bibliographic Records | |||
| BibRecordSaveOptionID | int | No | The bibliographic record save option.
Accepts: * 1 (do not save) * 2 (save as provisional) * 3 (save as final) |
| BibDisplayInPAC | bool | No | Should the "DisplayInPAC" setting on the bibliographic record be enabled. |
| BibDoNotOverlay | bool | No | Should the "DoNotOverlay" setting on the bibliographic record be enabled. |
| BibRecordOwnerID | int | Yes | The unique id assigned to an organization. |
| BibDeleteMARCTags | bool | No | Should MARC tags be deleted. |
| BibUseSystemDefinedDeletionTags | bool | No | Should system-defined deletion tags be used.
Accepts: * true (system-defined) * false (profile-defined) |
| BibProfileDeleteRules | List of DtoMARCRetentionRule | No | List of MARC tag rules used for deletion defined by the profile. |
| BibMARCValidationOptionID | int | Yes | The MARC validation option.
Accepts: * 1 (no validation) * 2 (save invalid as provisional) * 3 (save invalid as final) |
| BibAuthorityControlOptionID | int | No | The Authority Control option.
Accepts: * 1 (no authority control) * 2 (generate authority record) * 3 (do not generate authority record; save final) * 4 (do not generate authority record; save provisional) |
| BibUseSystemDuplicateDetectionRules | bool | No | Should system-defined duplicate detection rules be used.
Accepts: * true (system-defined) * false (profile-defined) |
| BibProfileDuplicateDetectionRules | List of int | No | List of duplicate detection rule identifiers to link to the profile. |
| BibDuplicateOptionID | int | No | The duplicate detection option.
Accepts: * 1 (no duplicate detection) * 2 (save incoming record as provisional) * 3 (save incoming record as final; do not replace database record) * 4 (save incoming record as final; replace database record) * 5 (save record with highest encoding level) * 6 (reject incoming record; add MARC retention tags to database record) |
| ImportEncodingCheckBibOptionID | int | No | The encoding validation option.
Requires: BibDuplicateOptionID = 5 (save record with highest encoding level) Accepts: * 1 (no encoding check) * 2 (save incoming record as final; replace database record) * 3 (reject incoming record) * 4 (save incoming record as provisional) |
| BibRetentionMARCTags | bool | No | Should the MARC validation be enabled. |
| BibUseSystemDefinedRetentionTags | bool | No | Should system-defined retention tags be used.
Accepts: * true (system-defined) * false (profile-defined) |
| BibProfileRetentionTags | List of DtoMARCRetentionRule | No | List of MARC tag rules used for retention defined by the profile. |
| Item Records | |||
| ImportItemCreationOptionID | int | No | The item creation option.
Accepts: * 1 (using embedded holdings fields only) * 2 (using template/system default values only) * 3 (using both embedded and template/system default values) |
| ImportDuplicateItemBarcodeOptionID | int | No | The duplicate detection option.
Accepts: * 1 (save duplicate record as provisional) * 2 (do not save) |
| ImportNoItemBarcodeOptionID | int | No | The duplicate detection option.
Accepts: * 1 (save incoming record as final) * 2 (save incoming record as provisional) * 3 (do not save) |
| ItemRecordSaveOptionID | int | No | The item record save option.
Requires: BibRecordSaveOptionID = 3 (save as final) Accepts: * 1 (do not save) * 2 (save as provisional) * 3 (save as final) |
| ItemDisplayInPAC | bool | No | Should the item record display in PAC? |
| ItemTemplateID | int | Yes | Item template to use for missing fields. |
| ImportEDIItemUpdateOptionID | int | No | The enriched encoding item update option.
Accepts: * 1 (no edi processing) * 2 (save as provisional) * 3 (do not save) |
| ImportEmbeddedItem | DtoImportEmbeddedItemView | Yes | The embedded holdings field to MARC subfield mapping object. |
| Authority Records | |||
| AuthorityRecordSaveOptionID | int | No | The authority record save option.
Accepts: * 1 (do not save) * 2 (save as provisional) * 3 (save as final) |
| AuthorityMARCValidationOptionID | int | Yes | The MARC validation option.
Accepts: * 1 (no validation) * 2 (save invalid as provisional) * 3 (save invalid as final) |
| AuthorityDuplicateOptionID | int | No | The duplicate detection option.
Accepts: * 1 (no duplicate detection) * 2 (save incoming record as provisional) * 3 (save incoming record as final; do not replace database record) * 4 (save incoming record as final; merge with database record) |
| UseSystemAuthorityDuplicateRules | bool | No | Should system-defined duplicate detection rules be used.
Accepts: * true (system-defined) * false (profile-defined) |
| AuthorityProfileDuplicateDetectionRules | List of int | No | List of duplicate detection rule identifiers to link to the profile. |
| AuthorityDeDupOrgID | int | Yes | The duplicate detection organization identifier. |
| AuthoritySeeAlsoFromOptionID | int | No | The See Also From Reference Linking option.
Accepts: * 1 (no link) * 2 (save incoming record as final; generate link) * 3 (save incoming record as final; do not generate link) * 4 (save incoming record as provisional; do not generate link) |
| RecordSetOptions | List of DtoImportRecordSetOption | Yes | List of record set options to link to the profile. |
| Property | Type | Nullable | Description |
|---|---|---|---|
| TagNumber | int | Yes | The unique id assigned to a vendor account. |
| Description | string | Yes | The description of the rule. |
| IndicatorOneValues | string | Yes | The comma delimited list of indicator one values. |
| IndicatorTwoValues | string | Yes | The comma delimited list of indicator two values. |
| Property | Type | Nullable | Description |
|---|---|---|---|
| DuplicateDetectionRule | string | No | The rule definition. |
| RuleDesc | string | Yes | The description of the rule. |
| Property | Type | Nullable | Description |
|---|---|---|---|
| HoldingsTagNumber | int | No | The tag number used for holdings. |
| AssignedBranch | char | Yes | |
| AssignedCollection | char | Yes | |
| Barcode | char | Yes | |
| CallNumberPrefix | char | Yes | |
| CallNumberSuffix | char | Yes | |
| ClassificationNumber | char | Yes | |
| CopyNumber | char | Yes | |
| CutterNumber | char | Yes | |
| DisplayInPAC | char | Yes | |
| FineCode | char | Yes | |
| FreeTextBlock | char | Yes | |
| FundingSource | char | Yes | |
| Holdable | char | Yes | |
| CircStatus | char | Yes | |
| LoanableOutsideSystem | char | Yes | |
| LoanPeriodCode | char | Yes | |
| LibraryAssignedBlock | char | Yes | |
| MaterialType | char | Yes | |
| NameOfPiece | char | Yes | |
| NonCirculating | char | Yes | |
| NonPublicNote | char | Yes | |
| OwningBranch | char | Yes | |
| PhysicalCondition | char | Yes | |
| POLISegmentID | char | Yes | |
| Price | char | Yes | |
| PublicNote | char | Yes | |
| RenewalLimit | char | Yes | |
| ShelfLocation | char | Yes | |
| ShelvingScheme | char | Yes | |
| StatisticalCode | char | Yes | |
| TemporaryShelfLocation | char | Yes | |
| VolumeNumber | char | Yes |
| Property | Type | Nullable | Description |
|---|---|---|---|
| ImportRecordSetKind | int | No | The kind of record set implementation.
Accepts: * 1 (bibliographic records as final) * 2 (bibliographic records as provisional) * 3 (bibliographic records as deleted) * 4 (authority records as final) * 5 (authority records as provisional) * 6 (authority records as deleted) * 7 (item records as final) * 8 (item records as provisional) |
| New | bool | Yes | Is the record set new? |
| Existing | bool | Yes | Is the record set existing? |
| Name | string | No | The record set name |
| OwnerID | int | Yes | The record set organization owner identifier |
| OwnerName | string | Yes | The record set organization owner name |
| ExistingID | int | Yes | The existing record set identifier |
| AppendOrReplace | bool | Yes | Should the records append or replace the existing record set contents? |
The added ImportProfileID is returned upon success.
11
| Code | Description |
|---|---|
| 200 | OK. Success |
| 403 | Forbidden. Permission(s) not granted. |
| 404 | Import profile not found. |