{ "openapi": "3.0.1", "info": { "version": "v1", "title": "erecruit.WebApi" }, "servers": [ { "url": "https://erecruit.nelsonstaffing.com/WebApi" } ], "paths": { "/Address/{Id}": { "get": { "tags": [ "Address" ], "summary": "Get the Address for the Id Provided.", "description": "Retrieves the address for the supplied Id.", "operationId": "Address_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of an Address", "required": true, "schema": { "type": "integer", "format": "int64" } } ] }, "put": { "tags": [ "Address" ], "summary": "Update an Existing Address", "description": "Update and Modify the address with the Id provided. For this operation to complete successfully, the address must exist.\r\n StateId and RegionId can be NULL, but CountryId is required. All fields except for AddressId and AboutType can be changed.", "operationId": "Address_UpdateAddress", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Address to Update", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The Changes to be made to the Address", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } } }, "x-name": "request" } }, "delete": { "tags": [ "Address" ], "summary": "Delete an Address, and Unlink it from all Records that Reference it", "description": "Delete an Address and and remove all references to it. If any Records reference this Address as their default, the reference will be removed\r\n and using the same rules as when calling Unlink, a new default may be set if applicable, or the default will be set to null. A 204 (No Content)\r\n should be returned upon successful completion of a request to this endpoint.", "operationId": "Address_DeleteAddress", "consumes": [], "produces": [], "responses": { "204": { "description": "No Content" } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Address to Delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Address/{AboutType}/{Id}": { "get": { "tags": [ "Address" ], "summary": "Get All Addresses Linked to the Record", "description": "Get a list of all Addresses that are linked to the record of the supplied AboutType with the supplied Id.\r\n Only the following AboutTypes are supported by this endpoint:\r\n Candidate, CandidateApplication, Company, Contact, Position, and Match.", "operationId": "Address_GetAddressesForRecord", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The Type of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "post": { "tags": [ "Address" ], "summary": "Create a new Address for a Record", "description": "Add an Address to Specified Record. If the address does not currently have a default address, the record being created will become its default.\r\n If the Record already has a default, but the Address being created should be its new default, the makeDefault flag should be set to true.\r\n RegionId and StateId can be null, but CountryId is required.", "operationId": "Address_CreateAddressFor", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The Type of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "makeDefault", "in": "query", "description": "If true, will set the Default Address of the Record to be the Address that was Created", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "description": "Data Describing the new Address", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressRequest" } } }, "x-name": "request" } } }, "/Address": { "post": { "tags": [ "Address" ], "summary": "Create a new Address", "description": "Name, StateID, CountryID and TypeID required.", "operationId": "Address_CreateAddress", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } } } } }, "deprecated": false, "requestBody": { "description": "Data Describing the new Address", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressRequest" } } }, "x-name": "request" } } }, "/Address/Link/{Id}": { "patch": { "tags": [ "Address" ], "summary": "Link an Address to One or Many Records", "description": "Links the Address with the supplied Id to all of the Records referenced in the request.\r\n If the any record contains a null value, it will be skipped, and the operation will still return successfully.\r\n If a record is already linked to the Address, the record will be skipped.", "operationId": "Address_LinkAddressToRecord", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Address you want to link to each record.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The records to link to the Address for the Id provided", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressLinkRequest" } } }, "x-name": "request" } } }, "/Address/UnLink/{Id}": { "patch": { "tags": [ "Address" ], "summary": "Unlink an Address from the record Described in the Request", "description": "Unlink the specified Record from the Address with the supplied Id. If the Record has other addresses, and supports defaults,\r\n the first address with the lowest TypeId will be made the Default. If there isn't another Address to make the default for the record,\r\n the default address for the record will become null. If after unlinking the this Record from Address there are no longer any references\r\n to the Address, the Address will be deleted. If the Address is deleted, the Response to this request will have 'Deleted' marked as the response,\r\n and if the Address still exists, but is no longer linked to the Record, then 'Unlinked' will be in the response.", "operationId": "Address_UnLinkAddressToRecord", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PatchResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PatchResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PatchResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Address", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Information describing the Record to Unlink", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordReference" } } }, "x-name": "request" } } }, "/Address/{AboutType}/{Id}/Default/{AddressId}": { "patch": { "tags": [ "Address" ], "summary": "Set the Default Address for a Record", "description": "Set the Default Address for the Record with the supplied Id and of the supplied type.\r\n Only the following AboutTypes are supported by this endpoint:\r\n Candidate, CandidateApplication, Company, Contact, Position, and Match.\r\n For this operation to complete successfully, the Address and the Record must both exist.", "operationId": "Address_SetDefaultAddressForRecord", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The About Type of the Record to set the Default Address For", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record to set the Default Address For", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "AddressId", "in": "path", "description": "The Id of the Address to be set as the Default for the Record", "required": true, "schema": { "type": "integer", "format": "int64" } } ] } }, "/Address/{AboutType}/{Id}/Default": { "get": { "tags": [ "Address" ], "summary": "Get the Default Address for a Record", "description": "Get the default address for the Record. Only the following AboutTypes are supported by this endpoint:\r\n Candidate, CandidateApplication, Company, Contact, Position, and Match.\r\n For the request to execute successfully, the record must have a default address.", "operationId": "Address_GetAddressDefaultForRecord", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The Type of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "put": { "tags": [ "Address" ], "summary": "Update the Default Address for the a Record", "description": "Update and Modify the Default Address for the a record. For this operation to complete successfully, the record must have\r\n a default address. StateId and RegionId can be NULL, but CountryId is required. All fields except for AddressId and AboutType can be changed.", "operationId": "Address_UpdateDefaultAddressForRecord", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AddressResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The type of the Record to Update", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record to Update", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The set of changes to be made to the default address of the Record", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } } }, "x-name": "request" } } }, "/Address/Country": { "get": { "tags": [ "Address" ], "summary": "Get a List of Valid Countries", "description": "Retrieve a list of valid Country Names and Ids.", "operationId": "Address_GetCounties", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Address/State": { "get": { "tags": [ "Address" ], "summary": "Get a List of Valid States", "description": "Retrieve a list of valid State Names and Ids", "operationId": "Address_GetStates", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Address/Region": { "get": { "tags": [ "Address" ], "summary": "Get a List of Valid Regions", "description": "Retrieve a list of valid Region Names and Ids", "operationId": "Address_GetRegions", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Address/Type": { "get": { "tags": [ "Address" ], "summary": "Get a List of Valid Address Types", "description": "Retrieve a list of valid Address Type Names and Ids", "operationId": "Address_GetTypes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Address/Country/{Id}": { "get": { "tags": [ "Address" ], "summary": "Get the Country for the Id Provided", "description": "Get the country for the provided Id.", "operationId": "Address_GetCounty", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of a Country", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Address/Region/{Id}": { "get": { "tags": [ "Address" ], "summary": "Get the Region for the Id Provided", "description": "Get the Region for the provided Id", "operationId": "Address_GetRegion", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of a Region", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Address/State/{Id}": { "get": { "tags": [ "Address" ], "summary": "Get the Id for the State Provided", "description": "Get the State for the provided Id", "operationId": "Address_GetState", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of a State", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/AdSource/{aboutType}": { "get": { "tags": [ "AdSource" ], "summary": "Get a List of AdSources", "description": "Retrieves a list of AdSources. If aboutType is NULL or 'NOTHING', all about types will be returned. However,\r\n if it is set to a specific AboutType, only AdSources that can be applied to that about type will be returned.", "operationId": "AdSource_GetAdSources", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdSourceValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdSourceValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdSourceValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdSourceValue" } } } } } }, "deprecated": false, "parameters": [ { "name": "aboutType", "in": "path", "description": "The about type to filter AdSources by, can be Null or 'Nothing' if a filter isn't desired.", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } } ] } }, "/AdSource/{AboutType}/{Id}": { "get": { "tags": [ "AdSource" ], "summary": "Get the Advertising Source that furnished this Record, and view its additional Info.", "description": "Information about the Advertising Source of the Record for the Id and Type Provided. The Following record types\r\n support Advertising Sources: Candidates, Contacts, Positions, Companies, Opportunities, Recruiters, CandidateApplications, \r\n and Seeds.", "operationId": "AdSource_GetAdSource", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdSourceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdSourceResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AdSourceResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AdSourceResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The Type of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record to Get the Adsource of.", "required": true, "schema": { "type": "integer", "format": "int64" } } ] }, "put": { "tags": [ "AdSource" ], "summary": "Allows for the Editing of a Record AdSource and AdSource AdditionalInfo", "description": "Provides the ability to change the AdSource of a Record, and alter the Additional Information associated with that AdSource.\r\n If the Destination AdSource requires Additional Info, and Additional Info is not supplied, then the request will only succeed if the\r\n Additional Info of this Record was already a non-null, and non-whitespace value.\r\n The Following record types support Advertising Sources: Candidates, Contacts, Positions, Companies, Opportunities,\r\n CandidateApplications, Recruiters, and Seeds.", "operationId": "AdSource_SetAdSource", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdSourceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdSourceResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AdSourceResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AdSourceResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Candidate to Modify or Add Source Information About", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "AboutType", "in": "path", "description": "", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } } ], "requestBody": { "description": "The Additional Info to add to the Candidate", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdSourceRequest" } } }, "x-name": "request" } } }, "/Attachment/{AboutType}/{Id}": { "get": { "tags": [ "Attachment" ], "summary": "Get all Attachments for a Given Record", "description": "Get all Attachments for a given Record that the current User has permission to View.\r\n Only the newest version of each Attachment will be returned. The Url Field can be used as the URL\r\n a GET request to get the actual Attachment, however the '~' must be replaced with the URL of the base\r\n Erecruit Site URL.", "operationId": "Attachment_GetAttachments", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The AboutType of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int64" } } ] } }, "/Attachment/{Id}": { "get": { "tags": [ "Attachment" ], "summary": "Get an Attachment by its Id", "description": "Get an Attachment by its Id. The current User must have access to view the Attachment in order for\r\n this call to be successful. Also, the Attachment must exist. The Url Field can be used as the URL\r\n a GET request to get the actual Attachment, however the '~' must be replaced with the URL of the base\r\n Erecruit Site URL.", "operationId": "Attachment_GetAttachment", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttachmentResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AttachmentResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AttachmentResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Guid Id of an Attachment", "required": true, "schema": { "type": "string" } } ] } }, "/Attachment/Content/{id}": { "get": { "tags": [ "Attachment" ], "summary": "Get an Attachment Content by its Id", "description": "Get an Attachment Content by its Attachment Id. The current User must have access to view the Attachment \r\n in order for this call to be successful.", "operationId": "Attachment_GetAttachmentContent", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Object" } } } } }, "deprecated": false, "parameters": [ { "name": "id", "in": "path", "description": "The Guid Id of an Attachment", "required": true, "schema": { "type": "string" } } ] } }, "/Attachment": { "post": { "tags": [ "Attachment" ], "summary": "Upload a file and bind it as an attachment to a specific record", "description": "Parameters:\r\n AboutType - type of record the attachment is added for;\r\n ReferenceID - ID of record the attachment is added for;\r\n AttachmentTypeID - Attachment type of uploaded attachment;\r\n Name - Name of uploaded attachment;\r\n ExpirationDate - Expiration date of uploaded attachment;\r\n Note - Note for uploaded attachment;", "operationId": "Attachment_Upload", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Object" } } } } }, "deprecated": false, "parameters": [ { "name": "request.aboutType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "request.referenceID", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "request.attachmentTypeID", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "Resume", "Agreement", "Invoice", "ReferenceCheck", "ProfilePicture", "InvoicePDF", "Other" ] } }, { "name": "request.name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "request.expirationDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "request.note", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/Attachment/UploadFromHTML": { "post": { "tags": [ "Attachment" ], "summary": "Create an attachment from supplied HTML and bind it to a specific record", "description": "Creates a .doc file from specified htmlAsBase64 supplied content and uploads it to the specified record\r\n Parameters:\r\n AboutType - type of record the attachment is added for;\r\n ReferenceID - ID of record the attachment is added for;\r\n AttachmentTypeID - Attachment type of uploaded attachment;\r\n Name - Name of uploaded attachment;\r\n ExpirationDate - Expiration date of uploaded attachment;\r\n Note - Note for uploaded attachment;\r\n HtmlAsBase64 - HTML string", "operationId": "Attachment_UploadFromHTML", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Object" } } } } }, "deprecated": false, "requestBody": { "description": "Information about the attachment", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentUploadFromHTMLRequest" } } }, "x-name": "request" } } }, "/Attachment/Type": { "get": { "tags": [ "Attachment" ], "summary": "Get attachment types", "operationId": "Attachment_GetAttachmentTypes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentTypeResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentTypeResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentTypeResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentTypeResponse" } } } } } }, "deprecated": false } }, "/Candidate/{id}": { "get": { "tags": [ "Candidate" ], "summary": "Get a single Candidate", "description": "Get a candidate with the provided Id", "operationId": "Candidate_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "id", "in": "path", "description": "The Candidates Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "put": { "tags": [ "Candidate" ], "summary": "Update a Candidate from the Fields Provided", "description": "Only fields that are included and not null will be updated. Fields marked readonly will not be changed.", "operationId": "Candidate_Put", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "id", "in": "path", "description": "the Id of the Candidate", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "the requested changes", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateUpdateRequest" } } }, "x-name": "request" } } }, "/Candidate/Duplicate": { "post": { "tags": [ "Candidate" ], "summary": "Get a List of Duplicate Candidates Based on the Fields Provided", "description": "Get a list of Candidates who match the Candidate described in the request. This endpoint will use the Duplicate Checking \r\n strategy from Client Settings.", "operationId": "Candidate_CheckForDuplicate", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateResponse" } } } } } }, "deprecated": false, "requestBody": { "description": "The Set of Fields that Describe a Candidate", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateDuplicateCheckRequest" } } }, "x-name": "request" } } }, "/Candidate/{Id}/Provision": { "post": { "tags": [ "Candidate" ], "summary": "Provision a User Account for a Candidate that Already Exists", "description": "Create a new User Account for a Candidate. For this operation to be successful, the Candidate\r\n cannot already have a User account (UserId should be 'null' when retrieved from this API). Also,\r\n the password supplied in the request must meet the system-wide password requirements. Lastly, the \r\n the Candidate must already exist.", "operationId": "Candidate_ProvisionUser", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/UserResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/UserResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Candidate", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Fields describing how the User should be Created", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateProvisionRequest" } } }, "x-name": "request" } } }, "/Candidate/{Id}/SSN": { "get": { "tags": [ "Candidate" ], "summary": "Get Candidates Social Security Number", "description": "By default this endpoint gets the last four digits of a Candidate Social Security Number. \r\n If you want to get entire SSN use getFullSSN property which should be set to true.\r\n \r\n For this operation to complete successfully, the Candidate must both exist, and have a Social\r\n Security Number on file. Also, the Consumer of this endpoint must have the Required Permission\r\n in erecruit.\r\n \r\n Required Permission: 'ViewSocialSecurityNumber'", "operationId": "Candidate_GetSSN", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValueResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValueResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ValueResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ValueResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "getFullSSN", "in": "query", "description": "Default value is false and it returns only last 4 digits", "required": false, "schema": { "type": "boolean" } } ] } }, "/Candidate/List": { "get": { "tags": [ "Candidate" ], "summary": "Get All Candidates by Vendor Company ID, Candidate Status and OwnerID", "description": "Gets candidates according to the preselected filters and shows records which are \r\n visible in the UI only for the provisioned entity of the API user.\r\n \r\n Important - \r\n VendorID filter works only for vendor companies which are shared with used entity\r\n and in erecruit these vendors show up in the Vendor dropdown on Tax tab. For any other vendor company \r\n or internal entity this endpoint won't return anything.\r\n \r\n Permissions which control candidate visibility: \r\n 'Search Shared Vendor Candidate Records', 'Search Candidates from Internal Entities', 'Search Vendor Owned Candidates'\r\n Without these permissions only candidates from the same entity will show up.", "operationId": "Candidate_List", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "VendorID", "in": "query", "description": "Vendor Company ID filter", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "StatusIDs", "in": "query", "description": "Candidate Status IDs filter", "required": false, "items": { "type": "integer", "format": "int32" }, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "OwnerID", "in": "query", "description": "Owner ID filter", "required": false, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Candidate/ByName": { "get": { "tags": [ "Candidate" ], "summary": "Query Candidates by Name", "description": "The resulting query will be built only from non-blank values.", "operationId": "Candidate_ByName", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "First", "in": "query", "description": "First Name", "required": true, "schema": { "type": "string" } }, { "name": "Last", "in": "query", "description": "Last Name", "required": true, "schema": { "type": "string" } }, { "name": "Middle", "in": "query", "description": "Middle Name", "required": true, "schema": { "type": "string" } } ] } }, "/Candidate/Resume/File": { "post": { "tags": [ "Candidate" ], "summary": "Upload a Resume to use as a base for the creation of a Candidate", "description": "The Candidate will be created using data extracted from the attached resume. The following information will be saved:\r\n First Name, Last Name, Middle Name, Phone Numbers, Addresses, Email Addresses, Education History, Employment History,\r\n and Skills from your Resume.\r\n The Candidate created can be further altered by leveraging other endpoints in this API.", "operationId": "Candidate_UploadResume", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AdSourceId", "in": "query", "description": "The Id of the Advertising Source that referred this Candidate", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "FolderGroupId", "in": "query", "description": "The Folder Group Id to Place this Candidate into", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "AdSourceAdditionalInfo", "in": "query", "description": "Additional Info for the AdSource", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Form data parameters", "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Candidate Resume": { "type": "string", "format": "binary", "description": "A Resume to be Uploaded to this Endpoint" } }, "required": [ "Candidate Resume" ] } } } } } }, "/Candidate/{Id}/Resume/File": { "put": { "tags": [ "Candidate" ], "summary": "Update an existing Candidate from an uploaded Resume", "description": "This endpoint provides the ability to update an existing Candidate from an attached resume.\r\n By Default, no changes will be made to the Candidate, you MUST set the flags to 'true' for the sections that you would\r\n like to have replaced from the new Resume. First, Last, and Middle names will not altered. Sections will only be replaced if\r\n there is data in the new resume to replace it. So if the updated resume does not contain an address, we will not erase the address\r\n that we have on file from a previously uploaded resume.\r\n For e.g.\r\n {WebURL}/WebAPI/Candidate/{Id}/Resume/File?replaceContactInfo=true", "operationId": "Candidate_UpdateFromUploadedResume", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the existing Candidate", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "replaceContactInfo", "in": "query", "description": "[Defaults to False] - If True, Email Addresses and Phone Numbers will be replaced\r\n with values from the new resume", "required": false, "schema": { "type": "boolean" } }, { "name": "updateEducation", "in": "query", "description": "[Defaults to Update] - Determines the update action for education history.", "required": false, "schema": { "type": "string", "enum": [ "NoUpdate", "Update", "UpdateAndReplace" ] } }, { "name": "updateEmployment", "in": "query", "description": "[Defaults to Update] - Determines the update action for employment history.", "required": false, "schema": { "type": "string", "enum": [ "NoUpdate", "Update", "UpdateAndReplace" ] } }, { "name": "updateSkills", "in": "query", "description": "[Defaults to Update] - Determines the update action for skills.", "required": false, "schema": { "type": "string", "enum": [ "NoUpdate", "Update", "UpdateAndReplace" ] } } ], "requestBody": { "description": "Form data parameters", "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "Candidate Resume": { "type": "string", "format": "binary", "description": "A Resume to be Uploaded to this Endpoint" } }, "required": [ "Candidate Resume" ] } } } } } }, "/Candidate/{Id}/Resume/Attachment/{AttachmentID}": { "put": { "tags": [ "Candidate" ], "summary": "Update an existing Candidate from an already assigned attachment", "description": "This endpoint provides the ability to update an existing Candidate from an attached resume.\r\n By Default, no changes will be made to the Candidate, you MUST set the flags to 'true' for the sections that you would\r\n like to have replaced from the new Resume. First, Last, and Middle names will not altered. Sections will only be replaced if\r\n there is data in the new resume to replace it. So if the updated resume does not contain an address, we will not erase the address\r\n that we have on file from a previously uploaded resume.", "operationId": "Candidate_UpdateFromAttachment", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the existing Candidate", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "AttachmentID", "in": "path", "description": "Attachment ID that represents the resume from which the candidate should be updated", "required": true, "schema": { "type": "string" } }, { "name": "replaceContactInfo", "in": "query", "description": "[Defaults to False] - If True, Email Addresses and Phone Numbers will be replaced\r\n with values from the new resume", "required": false, "schema": { "type": "boolean" } }, { "name": "updateEducation", "in": "query", "description": "[Defaults to Update] - Determines the update action for education history.", "required": false, "schema": { "type": "string", "enum": [ "NoUpdate", "Update", "UpdateAndReplace" ] } }, { "name": "updateEmployment", "in": "query", "description": "[Defaults to Update] - Determines the update action for employment history.", "required": false, "schema": { "type": "string", "enum": [ "NoUpdate", "Update", "UpdateAndReplace" ] } }, { "name": "updateSkills", "in": "query", "description": "[Defaults to Update] - Determines the update action for skills.", "required": false, "schema": { "type": "string", "enum": [ "NoUpdate", "Update", "UpdateAndReplace" ] } } ] } }, "/Candidate/Resume/Text": { "post": { "tags": [ "Candidate" ], "summary": "Submit the contents of a Resume to use as a base for the creation of a Candidate", "description": "The Candidate will be created using data extracted from the resume contents. The following information will be saved:\r\n First Name, Last Name, Middle Name, Phone Numbers, Addresses, Email Addresses, Education History, Employment History,\r\n and Skills from your Resume.\r\n The Candidate created can be further altered by leveraging other endpoints in this API.", "operationId": "Candidate_UploadTextResume", "consumes": [ "text/plain" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AdSourceId", "in": "query", "description": "The Id of the Advertising Source that referred this Candidate", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "FolderGroupId", "in": "query", "description": "The Folder Group Id to Place this Candidate into", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "AdSourceAdditionalInfo", "in": "query", "description": "Additional Info for the AdSource", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "The contents of resume", "required": true, "content": { "application/json": { "schema": { "type": "string" } } }, "x-name": "Resume Contents" } } }, "/Candidate/{Id}/Resume/Text": { "put": { "tags": [ "Candidate" ], "summary": "Update an existing Candidate from the contents of Resume", "description": "This endpoint provides the ability to update an existing Candidate from the contents of a resume.\r\n By Default, no changes will be made to the Candidate, you MUST set the flags to 'true' for the sections that you would\r\n like to have replaced from the new Resume. First, Last, and Middle names will not altered.", "operationId": "Candidate_UpdateFromTextResume", "consumes": [ "text/plain" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the existing Candidate", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "replaceContactInfo", "in": "query", "description": "[Defaults to False] - If True, Email Addresses and Phone Numbers will be replaced\r\n with values from the new resume", "required": false, "schema": { "type": "boolean" } }, { "name": "updateEducation", "in": "query", "description": "[Defaults to Update] - Determines the update action for education history.", "required": false, "schema": { "type": "string", "enum": [ "NoUpdate", "Update", "UpdateAndReplace" ] } }, { "name": "updateEmployment", "in": "query", "description": "[Defaults to Update] - Determines the update action for employment history.", "required": false, "schema": { "type": "string", "enum": [ "NoUpdate", "Update", "UpdateAndReplace" ] } }, { "name": "updateSkills", "in": "query", "description": "[Defaults to Update] - Determines the update action for skills.", "required": false, "schema": { "type": "string", "enum": [ "NoUpdate", "Update", "UpdateAndReplace" ] } } ], "requestBody": { "description": "The contents of resume.", "required": true, "content": { "application/json": { "schema": { "type": "string" } } }, "x-name": "Resume Contents" } } }, "/Candidate": { "post": { "tags": [ "Candidate" ], "summary": "Create a new Candidate.", "description": "This endpoint does not check for duplicates. Please use the POST /Candidate/Duplicate endpoint to identify candidates according to the agency's chosen duplicate check strategy.", "operationId": "Candidate_CreateCandidate", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CandidateResponse" } } } } }, "deprecated": false, "requestBody": { "description": "The information to create a Candidate From", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateRequest" } } }, "x-name": "request" } } }, "/Candidate/{Id}/Summary": { "get": { "tags": [ "Candidate" ], "summary": "Get the Current Summary of a Candidate", "description": "Get the summary for the Candidate with the Id supplied.\r\n Summary returned could be null.", "operationId": "Candidate_GetSummary", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateSummaryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CandidateSummaryResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CandidateSummaryResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CandidateSummaryResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Candidate to get the Summary of.", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "post": { "tags": [ "Candidate" ], "summary": "Add or Update the summary of a Candidate", "operationId": "Candidate_SetSummary", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateSummaryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CandidateSummaryResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CandidateSummaryResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CandidateSummaryResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Candidate to Update", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The information to replace the Candidate's current Summary with", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateSummaryRequest" } } }, "x-name": "request" } } }, "/Candidate/Rating": { "get": { "tags": [ "Candidate" ], "summary": "Get a List of Valid Candidate Ratings", "description": "Get all Candidate Ratings that the current user has access to. Some Ratings have associated permissions, and in order to set\r\n a Rating, you must have that Permission. To ensure that you have access, just use the `withAccess` (with the value `true` flag to ensure that the only Ratings returned\r\n accessible.", "operationId": "Candidate_GetRatings", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false, "parameters": [ { "name": "withAccess", "in": "query", "required": false, "schema": { "type": "boolean" } } ] } }, "/Candidate/Rating/{Id}": { "get": { "tags": [ "Candidate" ], "summary": "Get a Single Candidate Rating By Id", "description": "Get a Candidate Rating By Id. The Rating Must exist for this request to complete successfully.", "operationId": "Candidate_GetRating", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Candidate/{Id}/CommunicationPreferences": { "get": { "tags": [ "Candidate" ], "summary": "Get communication preferences of a Candidate", "operationId": "Candidate_GetCommunicationPreferences", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationPreferencesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommunicationPreferencesResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommunicationPreferencesResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommunicationPreferencesResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Candidate to get the communication preferences of", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "post": { "tags": [ "Candidate" ], "summary": "Add or Update communication preferences of a Candidate", "operationId": "Candidate_SetCommunicationPreferences", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationPreferencesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommunicationPreferencesResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommunicationPreferencesResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommunicationPreferencesResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Candidate to Update", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationPreferencesResponse" } } }, "x-name": "communicationPreferences" } } }, "/CandidateApplication": { "post": { "tags": [ "CandidateApplication" ], "summary": "Create a new Candidate Application", "operationId": "CandidateApplication_Post", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateApplicationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CandidateApplicationResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CandidateApplicationResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CandidateApplicationResponse" } } } } }, "deprecated": false, "requestBody": { "description": "Information about the Candidate Application", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateApplicationRequest" } } }, "x-name": "request" } } }, "/CandidateApplication/{Id}": { "get": { "tags": [ "CandidateApplication" ], "summary": "Get a Candidate Application by it Id", "operationId": "CandidateApplication_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateApplicationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CandidateApplicationResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CandidateApplicationResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CandidateApplicationResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "A Candidate Application's Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/CandidateApplication/Candidate/{Id}": { "get": { "tags": [ "CandidateApplication" ], "summary": "Get all Candidate Application for the supplied Candidate Id", "operationId": "CandidateApplication_GetByCandidateId", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateApplicationResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateApplicationResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateApplicationResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateApplicationResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of a Candidate", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/CandidateApplication/Position/{Id}": { "get": { "tags": [ "CandidateApplication" ], "summary": "Get all Candidate Application for the supplied Position Id", "operationId": "CandidateApplication_GetByPositionId", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateApplicationResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateApplicationResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateApplicationResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateApplicationResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of a Position", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/CandidateReference/{Id}": { "get": { "tags": [ "CandidateReference" ], "summary": "Get All Candidate Reference For a Candidate", "description": "Get a List of All References that are associated with the Candidate with the supplied Id.\r\n An Empty List will be returned if non can be found, or if the Candidate does not exist.", "operationId": "CandidateReference_GetCandidateReference", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateReferenceResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateReferenceResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateReferenceResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateReferenceResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Candidate", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/CandidateReference": { "post": { "tags": [ "CandidateReference" ], "summary": "Create a new Reference for a Candidate", "description": "Create a new Candidate Reference for the Candidate specified by the CandidateId field in the request.\r\n The Candidate must exist for this request to complete successfully. The Rating field must be valid. Valid Candidate Rating values can be retrieved\r\n from the Candidate Endpoint Collection.", "operationId": "CandidateReference_CreateReference", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateReferenceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CandidateReferenceResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CandidateReferenceResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CandidateReferenceResponse" } } } } }, "deprecated": false, "requestBody": { "description": "The set of Fields to Create the CandidateReference from", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateReferenceRequest" } } }, "x-name": "request" } } }, "/CandidateReference/{Id}/Text": { "get": { "tags": [ "CandidateReference" ], "summary": "Get the Reference Text of a CandidateReference", "description": "Get the CandidateReference Text. A CandidateReference must exist for the provided Id for this request to complete successfully.", "operationId": "CandidateReference_GetReferenceText", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the CandidateReference to get the Reference Text For", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Communication/ByAboutId/{Type}/{refId}": { "get": { "tags": [ "Communication" ], "summary": "Get Communications for a Type with a given Id", "description": "Get all Communications for the an entity of the Type type, and with the Id refId", "operationId": "Communication_ByAboutId", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "Type", "in": "path", "description": "The Type of entity that the Id references", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "refId", "in": "path", "description": "The Id of the Entity", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Communication/{Id}": { "get": { "tags": [ "Communication" ], "summary": "Get a Communication by its Id", "description": "Get a communication with the provided Id", "operationId": "Communication_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommunicationResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommunicationResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommunicationResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Communication", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "put": { "tags": [ "Communication" ], "summary": "Update a Communication", "description": "Only fields that are included and not null will be updated. Fields marked readonly will not be changed.", "operationId": "Communication_Put", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommunicationResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommunicationResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommunicationResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The ID of the Communication to Update", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The changes that you want to make to the Communication", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationResponse" } } }, "x-name": "model" } }, "delete": { "tags": [ "Communication" ], "summary": "Delete a Communication", "description": "Delete a communication. The Communication must exist in order for this operation\r\n to Complete successfully. Upon success, a 202 (No-Content) will be returned.", "operationId": "Communication_DeleteCommunicationMethod", "consumes": [], "produces": [], "responses": { "204": { "description": "No Content" } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Communication to Delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Communication/{AboutType}/{Id}": { "post": { "tags": [ "Communication" ], "summary": "Create a new Communication", "description": "Create a communication from the provided data", "operationId": "Communication_CreateCommunicationFor", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CommunicationResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CommunicationResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CommunicationResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "Type of the record for which to create the new Communication.", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "Type ID the record for which to create the new Communication.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The data to create the new Communication with", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommicationRequestModel" } } }, "x-name": "model" } } }, "/Communication": { "get": { "tags": [ "Communication" ], "summary": "Get a list of Valid Communication Types.", "description": "Retrieves a list of Valid Communication Types. This list will include both built-in Communication Types and Custom.", "operationId": "Communication_GetCommunicationTypes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Communication/Category": { "get": { "tags": [ "Communication" ], "summary": "Get a list of Communication Categories.", "description": "Retrieves a list of Communication Categories.", "operationId": "Communication_GetCommunicationCategories", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Company/Filter": { "post": { "tags": [ "Company" ], "summary": "Get a list of Companies that satisfy given filter parameters", "description": "When filtering by radius either (longitude, latitude, distance) or (zipcode, distance) need to be set. \r\n If both are set (longitude, latitude, distsance) is used.", "operationId": "Company_Filter", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedCompanyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedCompanyResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PagedCompanyResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PagedCompanyResponse" } } } } }, "deprecated": false, "requestBody": { "description": "Parameters used to filter the company list", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyFilterRequest" } } }, "x-name": "args" } } }, "/Company/{id}": { "get": { "tags": [ "Company" ], "summary": "Get a single Company", "description": "Get a Company with the provided Id", "operationId": "Company_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "id", "in": "path", "description": "The Id of the Company", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "put": { "tags": [ "Company" ], "summary": "Update a Company", "description": "Update the information about a Company. Only non-null fields will be updated.\r\n The Following fields can be modified: Name, HomePage.", "operationId": "Company_Put", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "id", "in": "path", "description": "The Id of the Company to Update", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The Object containing changes", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } } }, "x-name": "model" } } }, "/Company": { "post": { "tags": [ "Company" ], "summary": "Create a new Company from the Data provided", "description": "Create a new Company with the Data provided.", "operationId": "Company_Post", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } } } } }, "deprecated": false, "requestBody": { "description": "The Data to create a new Company from", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRequestModel" } } }, "x-name": "model" } } }, "/Company/Status": { "get": { "tags": [ "Company" ], "summary": "Get a list of Valid Company Statuses", "description": "Get all valid Company Statuses that can be used when creating a Company.", "operationId": "Company_GetStatusesForCurrentEntity", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Company/Status/{Id}": { "get": { "tags": [ "Company" ], "summary": "Get information about a Company Status", "description": "Get information about the CompanyStatusId provided.", "operationId": "Company_GetStatus", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Status Id of a Company", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Company/CompanyDepartment/{Id}": { "get": { "tags": [ "Company" ], "summary": "Get information about Company Department", "operationId": "Company_GetCompanyDepartment", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDepartmentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyDepartmentResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CompanyDepartmentResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CompanyDepartmentResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of a Company Department", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Company/CompanyDepartments": { "get": { "tags": [ "Company" ], "summary": "Get information about Company Departments for provided Company", "operationId": "Company_GetCompanyDepartments", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyDepartmentMultipleResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyDepartmentMultipleResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyDepartmentMultipleResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyDepartmentMultipleResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "CompanyIds", "in": "query", "description": "The array of Ids of a Company whose Company Departments we should return", "required": true, "items": { "type": "integer", "format": "int32" }, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ] } }, "/Company/Division/{CompanyId}": { "get": { "tags": [ "Company" ], "summary": "Get information about a Company's Division", "operationId": "Company_GetDivisionInfo", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDivisionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyDivisionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CompanyDivisionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CompanyDivisionDto" } } } } }, "deprecated": false, "parameters": [ { "name": "CompanyId", "in": "path", "description": "Id of a Company", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Contact/{id}": { "get": { "tags": [ "Contact" ], "summary": "Get a Single Contact", "description": "Get a single contact with the supplied Id", "operationId": "Contact_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContactResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContactResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "id", "in": "path", "description": "The Id of the Contact to get", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "put": { "tags": [ "Contact" ], "summary": "Update a Contact", "description": "All non-null fields will be updated. Fields marked readonly will not be changed.", "operationId": "Contact_Put", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContactResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContactResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "id", "in": "path", "description": "The Id of the Contact to Update", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The Fields to update on the Contact", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResponse" } } }, "x-name": "model" } } }, "/Contact": { "post": { "tags": [ "Contact" ], "summary": "Create a New Contact", "description": "Create a new Contacts from the Data prodided.", "operationId": "Contact_Post", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContactResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContactResponse" } } } } }, "deprecated": false, "requestBody": { "description": "The data to create a new Contact from", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequestModel" } } }, "x-name": "model" } } }, "/Contact/Status": { "get": { "tags": [ "Contact" ], "summary": "Get a List of Valid Contact Statuses", "description": "Get a list of valid Contact Statuses that can be used when creating and updating a Contact", "operationId": "Contact_GetStatuses", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Contact/InvoiceMode": { "get": { "tags": [ "Contact" ], "summary": "Get a List of Valid Invoice Modes", "description": "Get a list of valid Invoice Modes that can be used when creating and updating a Contact", "operationId": "Contact_GetInvoiceModes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Contact/Role": { "get": { "tags": [ "Contact" ], "summary": "Get a List of Valid Contact Roles", "description": "Get a list of valid Contact Roles that can be used when creating and updating a Contact", "operationId": "Contact_GetContactRoles", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Contact/Type": { "get": { "tags": [ "Contact" ], "summary": "Get a List of Valid Contact Types", "description": "Get a list of valid Contact Types that can be used when creating and updating a Contact", "operationId": "Contact_GetContactTypes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Contact/Status/{Id}": { "get": { "tags": [ "Contact" ], "summary": "Get the Status for the Status Id Provided", "description": "Get the Contact Status for the provided Id.", "operationId": "Contact_GetStatus", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of a Contact Status", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Contact/Filter": { "post": { "tags": [ "Contact" ], "summary": "Get a list of Contacts that satisfy given filter parameters", "description": "When filtering by custom fields, both CustomFieldId and CustomFieldValue are required", "operationId": "Contact_Filter", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedContactResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedContactResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PagedContactResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PagedContactResponse" } } } } }, "deprecated": false, "requestBody": { "description": "Parameters used to filter the contacts list", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactFilterRequest" } } }, "x-name": "args" } } }, "/CredentialingRequest/Status/{CredentialingRequestId}": { "get": { "tags": [ "CredentialingRequest" ], "summary": "Get Approval Status by Credentialing Request Id", "operationId": "CredentialingRequest_Status", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialingRequestStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CredentialingRequestStatusResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CredentialingRequestStatusResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CredentialingRequestStatusResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "CredentialingRequestId", "in": "path", "description": "The Id of Credentialing Request", "required": true, "schema": { "type": "integer", "format": "int64" } } ] } }, "/CredentialingRequest/Owner/{CredentialingRequestId}": { "get": { "tags": [ "CredentialingRequest" ], "summary": "Get Credentialing Request Owner by Credentialing Request Id", "operationId": "CredentialingRequest_Owner", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "CredentialingRequestId", "in": "path", "description": "The Id of Credentialing Request", "required": true, "schema": { "type": "integer", "format": "int64" } } ] } }, "/CredentialingRequest/CandidateOwner/{CredentialingRequestId}": { "get": { "tags": [ "CredentialingRequest" ], "summary": "Get Credentialing Request Candidate Owner by Credentialing Request Id", "operationId": "CredentialingRequest_CandidateOwner", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "CredentialingRequestId", "in": "path", "description": "The Id of Credentialing Request", "required": true, "schema": { "type": "integer", "format": "int64" } } ] } }, "/CredentialingRequest/CredentialRequestRejectionReason": { "get": { "tags": [ "CredentialingRequest" ], "summary": "Gets list of credentialing request rejection reasons.", "operationId": "CredentialingRequest_CredentialRequestRejectionReasons", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/CredentialingRequest/List": { "get": { "tags": [ "CredentialingRequest" ], "summary": "Gets list of credentialing requests based on filters sent in request", "operationId": "CredentialingRequest_List", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialingRequestResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialingRequestResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialingRequestResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialingRequestResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "candidateID", "in": "query", "description": "Candidate filter", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "credentialingRequestID", "in": "query", "description": "Credentialing Request filter", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "statusID", "in": "query", "description": "Approval Status filter", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "companyID", "in": "query", "description": "Company filter", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "folderGroupID", "in": "query", "description": "Folder Group filter", "required": false, "schema": { "type": "integer", "format": "int32" } } ] } }, "/CredentialingRequest/Filter": { "post": { "tags": [ "CredentialingRequest" ], "summary": "Get a list of Credentialing Requests that satisfy given filter parameters", "operationId": "CredentialingRequest_Filter", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedCredentialingRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedCredentialingRequestResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PagedCredentialingRequestResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PagedCredentialingRequestResponse" } } } } }, "deprecated": false, "requestBody": { "description": "Parameters used to filter the credentialing request list", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialingRequestFilterRequest" } } }, "x-name": "args" } } }, "/CredentialingRequest/Progress/{CredentialingRequestId}": { "get": { "tags": [ "CredentialingRequest" ], "summary": "Gets list of requirements progress for requested credentialing request", "operationId": "CredentialingRequest_Progress", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialingRequestRequirementsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CredentialingRequestRequirementsResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CredentialingRequestRequirementsResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CredentialingRequestRequirementsResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "CredentialingRequestId", "in": "path", "description": "The Id of Credentialing Request", "required": true, "schema": { "type": "integer", "format": "int64" } } ] } }, "/CredentialingRequest/Requirements/{CredentialingRequestId}": { "get": { "tags": [ "CredentialingRequest" ], "summary": "Gets list of all requirements for requested credentialing request", "operationId": "CredentialingRequest_Requirements", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleRequirementResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleRequirementResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleRequirementResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleRequirementResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "CredentialingRequestId", "in": "path", "description": "The Id of Credentialing Request", "required": true, "schema": { "type": "integer", "format": "int64" } } ] } }, "/CredentialingRequest": { "post": { "tags": [ "CredentialingRequest" ], "summary": "Creates new credentialing request", "operationId": "CredentialingRequest_Create", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialingRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CredentialingRequestResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CredentialingRequestResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CredentialingRequestResponse" } } } } }, "deprecated": false, "requestBody": { "description": "Data used for creating a new credentialing request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialingRequestCreateRequest" } } }, "x-name": "request" } } }, "/CredentialingRequest/Reject/{id}": { "put": { "tags": [ "CredentialingRequest" ], "summary": "Reject a credentialing request.", "operationId": "CredentialingRequest_Reject", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialingRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CredentialingRequestResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CredentialingRequestResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CredentialingRequestResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "id", "in": "path", "description": "Credentialing Request ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "query", "description": "UserId is a Guid of user who is approving the request (by default it's current WebAPI user)", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Data to reject", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialingRequestRejectRequest" } } }, "x-name": "request" } } }, "/CredentialingRequest/Approve/{id}": { "put": { "tags": [ "CredentialingRequest" ], "summary": "Approve Credentialing Request", "operationId": "CredentialingRequest_Approve", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialingRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CredentialingRequestResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CredentialingRequestResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CredentialingRequestResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "query", "description": "UserId is a Guid of user who is approving the request (by default it's current WebAPI user)", "required": false, "schema": { "type": "string" } } ] } }, "/CredentialingRequest/ApproveAll": { "put": { "tags": [ "CredentialingRequest" ], "summary": "Approve Multiple Credentialing Requests", "operationId": "CredentialingRequest_ApproveAll", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialingRequestResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialingRequestResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialingRequestResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialingRequestResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "userId", "in": "query", "description": "UserId is a Guid of user who is approving the request (by default it's current WebAPI user)", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Ids of multiple credentialing requests to be approved", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "format": "int64", "type": "integer" } } } }, "x-name": "credentialingRequestIds" } } }, "/CustomField/{AboutType}": { "get": { "tags": [ "CustomField" ], "summary": "Get all Custom Fields Descriptors for a Record Type", "description": "Get descriptions all Custom Fields for the AboutType. The Type of the Custom Field is important to how\r\n the Custom Field should be worked with. List Type fields should be set to a single string value.\r\n CheckboxLists can be set to a comma-separated string of multiple values. Boolean fields, can either be True,\r\n or False. For List and CheckboxLists, a list of possible values will be populated. For Remote Lists, the URL to the\r\n remote list will be returned, and the Consumer of the API is expected to process the Json from that remote data source\r\n themselves.", "operationId": "CustomField_GetCustomFieldsForAboutType", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The Type of Record to Get the Custom Field of", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } } ] } }, "/CustomField/{AboutType}/{Id}": { "get": { "tags": [ "CustomField" ], "summary": "Get all Custom Fields for a Record that have been Set", "description": "Get all Custom Fields for this Record that have been set.", "operationId": "CustomField_GetCustomFieldsForRecord", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The About Type of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "put": { "tags": [ "CustomField" ], "summary": "Change Multiple Custom Fields on a Single Record", "description": "Edit the values of multiple Custom Fields at once. All Custom fields for the record do not need to\r\n be included, only the ones that should be changed. Remote List Values should be stored by their numeric Id,\r\n not their string value. List Type fields should be set to a single string value.\r\n CheckboxLists can be set to a comma-separated string of multiple values.", "operationId": "CustomField_UpdateAll", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The Record Type", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The Set of Changes to make to the Custom Fields of the Record", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" } } } }, "x-name": "fields" } } }, "/CustomField/{AboutType}/{Id}/{CustomFieldId}": { "get": { "tags": [ "CustomField" ], "summary": "Get the Value of a Single Custom Field for a Single Record", "description": "Get the value of a single Custom Field for a Record.", "operationId": "CustomField_GetCustomFieldValueOfRecord", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomFieldValueResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomFieldValueResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The Record Type", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomFieldId", "in": "path", "description": "The Id of the Custom Field", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "put": { "tags": [ "CustomField" ], "summary": "Set the Value of a Single Custom Field for a Single Record", "description": "Set the value of a single Custom Field for a Record. Only the Value field in the request will be evaluated at this endpoint.\r\n Remote List Values should be stored by their numeric Id, not their string value. List Type fields should be set to a single string value.\r\n CheckboxLists can be set to a comma-separated string of multiple values.", "operationId": "CustomField_SetCustomFieldValueOfRecord", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomFieldValueResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomFieldValueResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The Type of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "CustomFieldId", "in": "path", "description": "The Id of the Custom Field", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The Value to Change the Custom Field To", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueResponse" } } }, "x-name": "request" } } }, "/CustomField/{AboutType}/{Id}/Reset": { "patch": { "tags": [ "CustomField" ], "summary": "Reset all Fields on a Record Back to the the Default Value", "description": "Set all Custom Fields on a Record back to their defaults, when applicable. Custom Fields \r\n that do not have Default Values will not be changed.", "operationId": "CustomField_ClearToDefault", "consumes": [], "produces": [], "responses": { "204": { "description": "No Content" } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The Record Type", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int64" } } ] } }, "/Department": { "get": { "tags": [ "Department" ], "summary": "Get a All Departments", "description": "Get all Departments for the current Entity.", "operationId": "Department_GetDepartments", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentResponse" } } } } } }, "deprecated": false } }, "/Department/{Id}": { "get": { "tags": [ "Department" ], "summary": "Get a Single Deparment by Id", "description": "Get a Single Department by its Id.", "operationId": "Department_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepartmentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DepartmentResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DepartmentResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DepartmentResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ] } }, "/Education/{Id}": { "get": { "tags": [ "Education" ], "summary": "Get the Education History for the Id Provided", "description": "Get the Education History for the Provided Id.", "operationId": "Education_GetEducationHistory", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EducationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EducationResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EducationResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EducationResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Education History", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "put": { "tags": [ "Education" ], "summary": "Update the the Education History for the Id Provided", "description": "Update the Education History for the provided Id.\r\n Only non-null fields will be updated. Following fields cannot be updated:\r\n Id, ReferenceType, ReferenceId, and AboutType. If the record being altered does\r\n not exist, an error will be returned.", "operationId": "Education_Update", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EducationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EducationResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EducationResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EducationResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Record to Alter", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The Set of Changes to make to the Record", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EducationResponse" } } }, "x-name": "request" } }, "delete": { "tags": [ "Education" ], "summary": "Delete the Education History for the Id Provided", "description": "Delete the Education History for the provided Id. If record being deleted\r\n does not exist, an error will be returned. Upon success, a 204 (No Content)\r\n will be returned.", "operationId": "Education_Delete", "consumes": [], "produces": [], "responses": { "204": { "description": "No Content" } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Education/{AboutType}/{Id}": { "get": { "tags": [ "Education" ], "summary": "Get all Education History Records For the Record Referenced", "description": "Get all Education History Records for the Record of type, AboutType, with Id, Id. \r\n If the Record does not exist, an empty collection will be returned, but an error will not be\r\n returned.", "operationId": "Education_GetEducationHistoryFor", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EducationResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EducationResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EducationResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EducationResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The Type of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "post": { "tags": [ "Education" ], "summary": "Create a new Education History Entry for the Specified Record", "description": "Create a new Education History entry for the record specified. The record must exist for\r\n this operation to be successful.", "operationId": "Education_CreateEducationHistoryFor", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EducationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EducationResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EducationResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EducationResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The AboutType of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The Set of Fields to be Used to Create the new Education History Entry", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EducationRequest" } } }, "x-name": "request" } } }, "/Education/EducationLevel/{Id}": { "get": { "tags": [ "Education" ], "summary": "Get the Education Level for the Id Provided", "description": "Get the Name and Description for the Education Level associate with the provided Id.", "operationId": "Education_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EducationLevelResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EducationLevelResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EducationLevelResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EducationLevelResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Eduction Level Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/EEOC/Candidate/{Id}": { "get": { "tags": [ "EEOC" ], "summary": "Get Supplementary Equal Employment Information about the Selected Candidate", "description": "Get additional info about the candidate specific to Equal Employment Opportunities.\r\n Information includes DisabilityStatus, Ethnicity, Gender, and VeteranStatus", "operationId": "EEOC_GetSupplement", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EEOCSupplement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EEOCSupplement" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EEOCSupplement" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EEOCSupplement" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Candidate to get the Supplement for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "put": { "tags": [ "EEOC" ], "summary": "Update Equal Emploment Information for the Selected Candidate", "description": "Update information about the candidate specific to Equal Employment Opportunties.\r\n Fields left Null in the supplement will be ignored.", "operationId": "EEOC_PutSupplement", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EEOCSupplement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EEOCSupplement" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EEOCSupplement" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EEOCSupplement" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Candidate to Update the EEOC information of.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The set of Changes to be made to the Candidate", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EEOCSupplement" } } }, "x-name": "supplement" } } }, "/EEOC/VeteranStatus": { "get": { "tags": [ "EEOC" ], "summary": "Get a List of Valid Veteran Statuses", "operationId": "EEOC_GetVeteranStatuses", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EEOCListElement" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EEOCListElement" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EEOCListElement" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EEOCListElement" } } } } } }, "deprecated": false } }, "/EEOC/Ethnicity": { "get": { "tags": [ "EEOC" ], "summary": "Get a List of Valid Ethnicity Categories.", "operationId": "EEOC_GetEthnicity", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EEOCListElement" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EEOCListElement" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EEOCListElement" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EEOCListElement" } } } } } }, "deprecated": false } }, "/EEOC/DisabilityStatus": { "get": { "tags": [ "EEOC" ], "summary": "Get a List of Valid Disibility Statuses", "operationId": "EEOC_GetDisabilityStatuses", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EEOCListElement" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EEOCListElement" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EEOCListElement" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EEOCListElement" } } } } } }, "deprecated": false } }, "/EEOC/Candidate/{Id}/DOB": { "get": { "tags": [ "EEOC" ], "operationId": "EEOC_GetDateOfBirth", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateOfBirthResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateOfBirthResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DateOfBirthResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DateOfBirthResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "put": { "tags": [ "EEOC" ], "summary": "Update Date of Birth for the Selected Candidate", "operationId": "EEOC_PutDateOfBirth", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateOfBirthResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DateOfBirthResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DateOfBirthResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DateOfBirthResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Candidate to Update the EEOC information of.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The set of Changes to be made to the Candidate", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateOfBirthResponse" } } }, "x-name": "request" } } }, "/FolderGroup": { "get": { "tags": [ "FolderGroup" ], "summary": "Get All Folder Groups, or All Within a Given Category", "description": "Get all valid Folder Groups. If a CategoryId is supplied in the query,\r\n only Folder Groups in that Category will be returned. If a SubcategoryId is Provided,\r\n only Folder Groups in that SubCategory will be returned.", "operationId": "FolderGroup_GetFolderGroups", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderGroupResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderGroupResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderGroupResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderGroupResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "CategoryId", "in": "query", "description": "The Category to Limit the Results by, if Provided", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "SubcategoryId", "in": "query", "description": "The Subcategory to Limit the Results by, if Provided", "required": false, "schema": { "type": "integer", "format": "int32" } } ] } }, "/FolderGroup/{AboutType}/{Id}": { "get": { "tags": [ "FolderGroup" ], "summary": "Get all FolderGroups associated with this Record.", "operationId": "FolderGroup_GetFolderGroupsFors", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordFolderGroupResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordFolderGroupResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordFolderGroupResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordFolderGroupResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/FolderGroup/{Id}": { "get": { "tags": [ "FolderGroup" ], "summary": "Get the Folder Group for the Provided Id", "description": "Get the FolderGroup for the Id provided.", "operationId": "FolderGroup_GetFolderGroup", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of a FolderGroup", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/FolderGroup/Subcategory/{Id}": { "get": { "tags": [ "FolderGroup" ], "summary": "Get Information About the Specified Folder Group Category", "description": "Get a information about a specific Folder Group Category.", "operationId": "FolderGroup_GetSubcategory", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderGroupSubCategoryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderGroupSubCategoryResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FolderGroupSubCategoryResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FolderGroupSubCategoryResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Folder Group Category Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/FolderGroup/{AboutType}/{Id}/Default": { "get": { "tags": [ "FolderGroup" ], "summary": "Get the Default Folder Group for a Record", "description": "Get the default Folder Group for a Record. Only the following RecordTypes have default Folder Groups,\r\n Candidate, Contact, Company, Position. If the record does not have a default Folder Group defined, null\r\n will be returned. Default Folder Groups do not support Statuses.", "operationId": "FolderGroup_GetDefault", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The About Type of the Record to Get the Default Folder Group of", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record to Get the Default Folder Group of", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/FolderGroup/{AboutType}/{Id}/Default/{FolderGroupId}": { "patch": { "tags": [ "FolderGroup" ], "summary": "Set the Default Folder Group of a Record", "description": "Set the default Folder Group for the Record as described by the AboutType and Id Provided to the\r\n FolderGroup which has the Id FolderGroupId. Only the following RecordTypes have default Folder Groups,\r\n Candidate, Contact, Company, Position. If the default Folder Group of the Record is already the FolderGroup\r\n specified in by the request, no changes will be made. Default Folder Groups do not support Statuses.", "operationId": "FolderGroup_SetDefault", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The About Type of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record to Set the Default Folder Group of", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "FolderGroupId", "in": "path", "description": "The Id of the Folder Group to set as the Record's Default", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/FolderGroup/SubCategory": { "get": { "tags": [ "FolderGroup" ], "summary": "Get All Folder Group Categories", "description": "Get a list of all valid Folder Group Categories.", "operationId": "FolderGroup_GetSubcategories", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderGroupSubCategoryResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderGroupSubCategoryResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderGroupSubCategoryResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderGroupSubCategoryResponse" } } } } } }, "deprecated": false } }, "/FolderGroup/Add/{Id}": { "patch": { "tags": [ "FolderGroup" ], "summary": "Add a Record to a Folder Group", "description": "Add a Record to the Folder Group with the given Id. If the Record supports default Folder Groups,\r\n and the Record does not have a default FolderGroup, the default Folder Group will be set to Folder Group\r\n referenced in this Request. The following RecordTypes have default Folder Groups, Candidate, Contact, Company, Position.\r\n If a StatusId is included the Record, will be placed into the FolderGroup with the Status that is associated with the Id\r\n provided. If the StatusId is invalid, it will be ignored, and NULL will be returned in the corresponding response field \r\n upon success.", "operationId": "FolderGroup_AddRecordToFolderGroup", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FolderGroupResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Folder Group to Add the Record to", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "StatusId", "in": "query", "description": "The Id of the Status that best represents the Record in the Folder Group, optional", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "A Reference to the Record to Add to the Folder Group", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordReference" } } }, "x-name": "Record" } } }, "/FolderGroup/Remove/{Id}": { "patch": { "tags": [ "FolderGroup" ], "summary": "Remove a Record from a Folder Group", "description": "Remove a Record from the specified Folder Group. If successful, a 204 (No-Content) will be returned.\r\n If the Record supports default Folder Groups, and the Folder Group being removed is the Default, \r\n then the new Default of that record will become one of the other Folder Groups associated with this record.\r\n If the record is not a member of any other Folder Group, then the defualt Folder Group for the record will\r\n become null. For this reason, it is highly recommended that you check the default Folder Group of a Record before\r\n you remove it from a Folder Group, to see if the default is going to be removed.The following RecordTypes have default\r\n Folder Groups, Candidate, Contact, Company, Position.", "operationId": "FolderGroup_RemoveRecordFromFolderGroup", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [], "responses": { "204": { "description": "No Content" } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Folder Group to Remove the Record from", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "A Reference to the Record to Remove from the Folder Group", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordReference" } } }, "x-name": "Record" } } }, "/FolderGroup/Category": { "get": { "tags": [ "FolderGroup" ], "summary": "Get a List of Valid Folder Group Categories.", "description": "Get a all valid Category Group Categories.", "operationId": "FolderGroup_GetCategories", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/FolderGroup/Category/{Id}": { "get": { "tags": [ "FolderGroup" ], "summary": "Get the Folder Group Category for the Specified Id", "description": "Get the Folder Group Category for the Id Provided.", "operationId": "FolderGroup_GetCategory", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of a Folder Group Category", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/FolderGroup/Status": { "get": { "tags": [ "FolderGroup" ], "summary": "Get all Valid Statuses", "description": "Get a list of valid Folder Group Statuses. If an AboutType is included in the request,\r\n only Folder Group Statuses that can be applied to that AboutType will be returned.", "operationId": "FolderGroup_GetStatuses", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderGroupStatusResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderGroupStatusResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderGroupStatusResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderGroupStatusResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "aboutType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } } ] } }, "/FolderGroup/Status/{Id}": { "get": { "tags": [ "FolderGroup" ], "summary": "Get the Folder Group Status for the Id Specified", "description": "Get the Folder Group Status associated with the Id provided.", "operationId": "FolderGroup_GetStatus", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderGroupStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderGroupStatusResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FolderGroupStatusResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FolderGroupStatusResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of a Folder Group", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Industry": { "get": { "tags": [ "Industry" ], "operationId": "Industry_GetIndustries", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Industry/{Id}": { "get": { "tags": [ "Industry" ], "operationId": "Industry_GetIndustry", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Match/{Id}": { "get": { "tags": [ "Match" ], "summary": "Get a Match By Id", "description": "Get a Match by Id. The Match must exist in order for this operation to complete successfully.", "operationId": "Match_GetById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MatchResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/MatchResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/MatchResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Match", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Match/Candidate/{Id}": { "get": { "tags": [ "Match" ], "summary": "Get All Match for a Candidate", "description": "Get all Matches for a single Candidate. If the Candidate has not been placed into any Matches, none will be returned.", "operationId": "Match_GetByCandidateId", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MatchResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MatchResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MatchResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MatchResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Candidate", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Match/{Id}/Credits": { "get": { "tags": [ "Match" ], "summary": "Get The Credit Distribution for a Match", "description": "Get the way that credit will be distributed if this Match is successful.", "operationId": "Match_GetMatchCredits", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MatchCreditsResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MatchCreditsResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MatchCreditsResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MatchCreditsResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Match to get the Credit Distribution for", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Note/{AboutType}/{Id}": { "get": { "tags": [ "Note" ], "summary": "Get All Notes of the Record of the Supplied AboutType with the Supplied Id", "description": "Gets all of the notes associated with the record or the supplied about type, that has the supplied Id.", "operationId": "Note_GetNotes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NoteResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NoteResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NoteResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NoteResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The about type of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int64" } } ] } }, "/Note": { "post": { "tags": [ "Note" ], "summary": "Create a new Note", "description": "Create a new Note. If list Records has values, the Note will be bound to that record.\r\n However, if the list of records is null, or contrains null values, the Note will still be created with the body provided, and can then\r\n be linked to one, or many records using the Link endpoint.", "operationId": "Note_PostNote", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NoteResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NoteResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NoteResponse" } } } } }, "deprecated": false, "requestBody": { "description": "The newly created Note.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteRequest" } } }, "x-name": "request" } } }, "/Note/{Id}": { "get": { "tags": [ "Note" ], "summary": "Get the a Note with the Provided Id", "description": "Get a note by its Id.", "operationId": "Note_GetNote", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NoteResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NoteResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NoteResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Note to Retrieved.", "required": true, "schema": { "type": "integer", "format": "int64" } } ] }, "patch": { "tags": [ "Note" ], "summary": "Link a Note to One or Many Other Records.", "description": "The note with whose Id is referenced in the request will be added as a reference for each of the Records supplied in the request.\r\n Any Records with null values will be ignored, and not return an error response.", "operationId": "Note_LinkNote", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NoteResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NoteResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NoteResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the note to Link to other Records", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Contains the Note your would like to add as a reference to each of the included records.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteLinkRequest" } } }, "x-name": "request" } } }, "/Onboarding/{aboutType}/{referenceID}": { "get": { "tags": [ "Onboarding" ], "summary": "Gets onboardings by aboutType and referenceId", "operationId": "Onboarding_GetOnboardings", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnboardingResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnboardingResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnboardingResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnboardingResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "aboutType", "in": "path", "description": "aboutType filter", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "referenceID", "in": "path", "description": "referenceId filter", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Onboarding/Initiate/{aboutType}/{referenceID}": { "post": { "tags": [ "Onboarding" ], "summary": "Initiates onboarding for match or candidate", "operationId": "Onboarding_InitiateOnboarding", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OnboardingResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OnboardingResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OnboardingResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "aboutType", "in": "path", "description": "aboutType of match or candidate", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "referenceID", "in": "path", "description": "id of match or candidate", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ownerType", "in": "query", "description": "Onboarding owner type - Vendor, Candidate or None (default from settings)", "required": false, "schema": { "type": "string", "enum": [ "None", "Candidate", "Vendor" ] } } ] } }, "/Onboarding/Progress/{onboardingId}": { "get": { "tags": [ "Onboarding" ], "summary": "Gets onboarding progress counts by onboardingId", "operationId": "Onboarding_Progress", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardingProgressResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OnboardingProgressResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OnboardingProgressResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OnboardingProgressResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "onboardingId", "in": "path", "description": "ID of a Onboarding", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Opportunity": { "post": { "tags": [ "Opportunity" ], "summary": "Create a New Opportunity", "description": "Create a new Opportunity from the information provided. TypeId and AdSourceId must be valid in order for the\r\n Opportunity to be created successfully. If any of the other '*Id' fields are invalid, they will be ignored, and the\r\n corresponding value returned will be NULL. I.E. If CompanyId is '11' but there isn't a Company with an Id of\r\n '11' then the Opportunity will not be linked to any Company, a NULL will be returned in the CompanyId field\r\n of the Response, and the Opportunity will be created.", "operationId": "Opportunity_Post", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpportunityResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpportunityResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpportunityResponse" } } } } }, "deprecated": false, "requestBody": { "description": "The Opportunity to Create", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityRequest" } } }, "x-name": "request" } } }, "/Opportunity/{Id}": { "get": { "tags": [ "Opportunity" ], "summary": "Get the Opportunity for the Id Provided", "description": "Get the Opportunty for the provided Id.", "operationId": "Opportunity_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpportunityResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpportunityResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpportunityResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of an Opportunity", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Opportunity/Type": { "get": { "tags": [ "Opportunity" ], "summary": "Get a List of all Valid Opportunity Types", "description": "Get all valid types of Opportunities.", "operationId": "Opportunity_GetTypes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Opportunity/Type/{Id}": { "get": { "tags": [ "Opportunity" ], "summary": "Get the Opportunity Type for the Specified Id", "description": "Get the Opportunity Type for the Id provided.", "operationId": "Opportunity_GetType", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of an Opportunity Type", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Opportunity/Type/{Id}/CloseReason": { "get": { "tags": [ "Opportunity" ], "summary": "Get All Valid Close Reasons for the Opportunity Type Specified", "description": "Get a list of valid close reasons for the Opportunity Type that is associated with the Id provided.\r\n You cannot set the Close Reason of an Opportunity to a Close Reason that is not enumerated at this endpoint.", "operationId": "Opportunity_GetCloseReasons", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of Opportunity Type", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Opportunity/Rating": { "get": { "tags": [ "Opportunity" ], "summary": "Get the List of Valid Opportunity Ratings.", "description": "Returns the list of ratings that can be used to describe the quality of an Opportunity.", "operationId": "Opportunity_GetRatings", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Opportunity/Rating/{Id}": { "get": { "tags": [ "Opportunity" ], "summary": "Get the Opportunity Rating for the Specified Id", "description": "Get the Name of the Opportunity associated with the Id provided.", "operationId": "Opportunity_GetRating", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Opportunity Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Opportunity/CloseReason/{Id}": { "get": { "tags": [ "Opportunity" ], "summary": "Get the Close Reason for the Id Specified", "description": "Get the Close Reason for the Id provided.", "operationId": "Opportunity_GetCloseReason", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Close Reason", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Owner/{AboutType}/{Id}": { "get": { "tags": [ "Owner" ], "summary": "Get All Owners for the Record Specified", "description": "Get all Owners for a Record. Each record should have at least a Primary Owner, however this is not guaranteed.\r\n The determination of Primary Owner is predicated upon RecruiterId, so it is possible for there to be multiple Ownership entries returned\r\n from the endpoint that are marked as Primary, however each of them will have the same RecruiterId.\r\n The following AboutTypes are supported at this endpoint, Candidate, Position, Match, Company, Company.\r\n AdditionalOwnerRecordID and AdditionalOwnerType will be set only for additional owners.", "operationId": "Owner_GetAll", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OwnerResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OwnerResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OwnerResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OwnerResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The AboutType Of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int64" } } ] }, "post": { "tags": [ "Owner" ], "summary": "Add a new Owner to a Record", "description": "Add a new Owner to a Record. If the Record does not have a Primary Owner, the Primary Owner will be set to the Recruiter specified\r\n in the request. For this Request to Complete Successfully, the Record must exist, and the Recruiter must exist aswell. The following AboutTypes are supported at this endpoint,\r\n Candidate, Position, Match, Company, Company.", "operationId": "Owner_AddOwner", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnerResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OwnerResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OwnerResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OwnerResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The AboutType of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "A Set of Fields Describing how the Owner Should be Created", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnerRequest" } } }, "x-name": "request" } }, "patch": { "tags": [ "Owner" ], "summary": "Set the Primary Owner of an Existing Record", "description": "Set the Primary Owner of an existing Record to the Recruiter whose Id is listed in\r\n the request. Optionally, you can choose to demote the Current Primary Owner into an Additional Owner (non-primary).\r\n If DemoteCurrentPrimary is true, then this endpoint will set the new Primary as expected, and also create a new Additional Owner\r\n for this record with the AdditionalOwnerType specified in the request, if any. If the Record does not have a Primary Owner, and\r\n DemoteCurrentPrimary is true, this operation will complete succesfully, without any AdditionalOwners being created.\r\n If DemoteCurrentPrimary is left out of the request, it will default to 'false'. The following AboutTypes are supported at this endpoint,\r\n Candidate, Position, Match, Company, Company.", "operationId": "Owner_SetPrimaryOwner", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnerResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OwnerResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OwnerResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OwnerResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The AboutType of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Fields Describing how to Handle the Change", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnerPatchRequest" } } }, "x-name": "request" } } }, "/Owner/{Id}": { "delete": { "tags": [ "Owner" ], "summary": "Delete an Additional Owner", "description": "Remove an Additional Owner by its Id. The Additional Owner Record\r\n must exist for this operation to complete successfully. Note that Ownership Entries\r\n that are marked as Primary may have a 'null' for their Id, this indicates that there is not an\r\n additional Owner Entry affiliated with that Owner. In order to deassociate a record from a PrimaryOwner\r\n that does not have a an AdditionalOwner, you must change the PrimaryOwner (See PATCH endpoint).", "operationId": "Owner_DeleteAdditionalOwner", "consumes": [], "produces": [], "responses": { "204": { "description": "No Content" } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Additional Owner Entry", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Owner/OwnerTypes": { "get": { "tags": [ "Owner" ], "summary": "Get all Valid OwnerTypes", "description": "Get a List of Valid Additional Owner Types.", "operationId": "Owner_GetTypes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Owner/{Id}/DimensionValue": { "get": { "tags": [ "Owner" ], "summary": "Get the Dimension for a Record", "description": "Get the Dimension Name and Value for an Ownership Record. For this operation to\r\n complete successfully, the Ownership Record must exist. This endpoint will simply return 'null'\r\n in the event that there is not a Dimension for the Ownership Record.", "operationId": "Owner_GetDimensionValueForEntry", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DimensionValueResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DimensionValueResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DimensionValueResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DimensionValueResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of an Ownership Record.", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Position": { "post": { "tags": [ "Position" ], "summary": "Create a New Position", "description": "Create a new Position from the fields Provided. \r\n For VMS position:\r\n IsVMS flag should be set to true. The CompanyId provided must be of a Company mapped to in VMS settings\r\n to accept Positions. If a valid ContactId is not provided, contact will be extracted from the VMS mapping, and if not found there, the default Contact for\r\n the CompanyId supplied will be used. If a Contact cannot be found by any of those means, the VMS Position will not be created.\r\n For non VMS position:\r\n Is VMS flag should be set to false. CompanyId, ContactId, PositionStatusId, PositionTypeId, Adsource and FoldergroupId fields are required. \r\n The ContactId must belong to the CompanyId passed.\r\n For any position record to be created successfully, AdSourceId and FolderGroupId must be valid.\r\n DefaultAddressId and UseCompanyAddress fields define address of position record. If position should have company's address, set UseCompanyAddress flag to true.\r\n For setting different address than one from company, set UseCompanyAddress to false and provide valid DefaultAddressId of existing address.", "operationId": "Position_CreatePosition", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PositionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PositionResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PositionResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PositionResponse" } } } } }, "deprecated": false, "requestBody": { "description": "The Data to Make the New Position From", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PositionRequest" } } }, "x-name": "request" } } }, "/Position/{Id}": { "get": { "tags": [ "Position" ], "summary": "Get a Single Position", "description": "Get the Position referenced by the Id provided.", "operationId": "Position_GetPosition", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PositionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PositionResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PositionResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PositionResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The id of the Position", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "put": { "tags": [ "Position" ], "summary": "Modify a Specific Position", "description": "The following fields can be changed: \r\n Title, NumberOfPositions, MinBillRate, MaxBillRate, MinPayRate, MaxPayRate, DefaultVendorRateMarkupPercentage,\r\n StartDate, EndDate, StartTime, and EndTime.", "operationId": "Position_EditPosition", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PositionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PositionResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PositionResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PositionResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Postion to Modify", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The Position with altered fields", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PositionResponse" } } }, "x-name": "request" } } }, "/Position/{Id}/Description": { "get": { "tags": [ "Position" ], "summary": "Edit the Description of a Position", "description": "Get the Description of a Position.", "operationId": "Position_GetDescription", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Position to Get the Description for", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "put": { "tags": [ "Position" ], "summary": "Edit the Description of a Position", "description": "Modify the Description of the Position.", "operationId": "Position_EditDescription", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Position to Edit the Description for", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The Modified Position Description", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } } }, "x-name": "request" } } }, "/Position/{Id}/Comments": { "get": { "tags": [ "Position" ], "summary": "Edit the Comments of a Position", "description": "Get the Comments of a Position.", "operationId": "Position_GetComments", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Position to Get the Comments for", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "put": { "tags": [ "Position" ], "summary": "Edit the Comments of a Position", "description": "Modify the Comments of the Position.", "operationId": "Position_EditComments", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Position to Edit the Comments for", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The Modified Position Comments", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } } }, "x-name": "request" } } }, "/Position/Status": { "get": { "tags": [ "Position" ], "summary": "Get a List of Valid Position Statuses", "description": "Get a list of valid Position Statuses.", "operationId": "Position_GetStatuses", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Position/Status/{Id}": { "get": { "tags": [ "Position" ], "summary": "Get a the Status for the Id Provided", "description": "Get Position Status for the Id Provided.", "operationId": "Position_GetStatus", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of Status", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Position/Type": { "get": { "tags": [ "Position" ], "summary": "Get a List of Valid Position Types", "description": "Get a list of valid Position Types.", "operationId": "Position_GetTypes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Position/Type/{Id}": { "get": { "tags": [ "Position" ], "summary": "Get a the Status for the Id Type", "description": "Get Position Status for the Id Type.", "operationId": "Position_GetType", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of Type", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Position/InternallyPosted": { "get": { "tags": [ "Position" ], "summary": "Get Internally Posted Positions.", "description": "The returned Positions will be limited to the Entity the User accessing this endpoint.\r\n Only Unexpired postings with a status of `Sent`, `Active`, `Extended` or `Posted` will be returned. This endpoint should be called once and cached, it should not be called multiple times\r\n if at all avoidable.", "operationId": "Position_GetInternallyPosted", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PostedPositionResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PostedPositionResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PostedPositionResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PostedPositionResponse" } } } } } }, "deprecated": false } }, "/Position/PositionTemplates": { "get": { "tags": [ "Position" ], "summary": "Get Position Templates.", "description": "If companyID is supplied it will return list of templates containing\r\n description, folder groups of position templates, position template IDs, position title,\r\n worker's comp rate, position type, effective date and general comments.\r\n In case companyID is null, the response will be list of global templates.", "operationId": "Position_GetPositionTemplates", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PositionTemplateResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PositionTemplateResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PositionTemplateResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PositionTemplateResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "companyID", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Recruiter/{Id}": { "get": { "tags": [ "Recruiter" ], "summary": "Get a Recruiter by Recruiter Id", "description": "Get the Recruiter who has the Id provided. Note, the Recruiter Id is a number, not a Guid.\r\n If the Id you have is a Guid, it is likely a User Id, and should be used with the 'Recruiter/ByUser' endpoint.", "operationId": "Recruiter_GetRecruiterById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecruiterResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecruiterResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecruiterResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RecruiterResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Recuiter", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Recruiter/ByUser/{UserId}": { "get": { "tags": [ "Recruiter" ], "summary": "Get a Recruiter by User Id", "description": "Get the Recruiter who has the User Id provided.\r\n Note, the User Id is a Guid, not a number. If the Id you have is a number, please use the 'Recruiter/{Id}' endpoint.", "operationId": "Recruiter_GetRecruiterByUserId", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecruiterResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecruiterResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecruiterResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RecruiterResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "UserId", "in": "path", "description": "The Id of the Number", "required": true, "schema": { "type": "string" } } ] } }, "/Recruiter/ByEmail": { "get": { "tags": [ "Recruiter" ], "summary": "Get a Recruiter by Email", "description": "Get a Recruiter by the Email address associated with the Recruiter. This lookup is not case-sensitive.\r\n Note, Email is a query string parameter, not a Path Argument. The '.com' extension on emails forces this to be the case.", "operationId": "Recruiter_GetRecruiterByEmail", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecruiterResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecruiterResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RecruiterResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RecruiterResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Email", "in": "query", "description": "The Email Address of the Recruiter", "required": true, "schema": { "type": "string" } } ] } }, "/Relationship": { "get": { "tags": [ "Relationship" ], "summary": "Get a list of Valid Relatorionship Types.", "description": "Retrieves a list of Valid Relatorionship Types.", "operationId": "Relationship_GetRelationshipTypes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRelationshipType" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRelationshipType" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRelationshipType" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRelationshipType" } } } } } }, "deprecated": false }, "post": { "tags": [ "Relationship" ], "summary": "Creates a new Relationship", "description": "Creates a new relationship", "operationId": "Relationship_CreateRelationship", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationshipResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RelationshipResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RelationshipResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RelationshipResponse" } } } } }, "deprecated": false, "requestBody": { "description": "List of params to create a new Relationship", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationshipRequest" } } }, "x-name": "request" } } }, "/Relationship/{recordId}/Relationships": { "get": { "tags": [ "Relationship" ], "summary": "Get the Relationships", "description": "Retrieves the relationship for the supplied AboutType and parent or child recordId.", "operationId": "Relationship_GetRelationships", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RelationshipResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RelationshipResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RelationshipResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RelationshipResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "recordId", "in": "path", "description": "ID reference for parent or child relationship", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "AboutType", "in": "query", "description": "AboutType from parent or child to be returned", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } } ] } }, "/Relationship/{ID}": { "delete": { "tags": [ "Relationship" ], "summary": "Delete a relationship", "description": "should be returned upon successful completion of a request to this endpoint.", "operationId": "Relationship_DeleteRelationship", "consumes": [], "produces": [], "responses": { "204": { "description": "No Content" } }, "deprecated": false, "parameters": [ { "name": "ID", "in": "path", "description": "The Id of the Relationship to Delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Requirement/{AboutType}/{Id}": { "get": { "tags": [ "Requirement" ], "summary": "Get All Requirements for a Record", "operationId": "Requirement_ByRecord", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The Type of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int64" } } ] } }, "/Requirement/Status/{Id}": { "get": { "tags": [ "Requirement" ], "summary": "Get a Requirement Status by Id", "description": "Get a Requirement Status by Id.", "operationId": "Requirement_StatusById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRequirementStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ObjectRequirementStatusResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ObjectRequirementStatusResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ObjectRequirementStatusResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Status", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Requirement/Status": { "get": { "tags": [ "Requirement" ], "summary": "Get all Requirement Statuses", "description": "Get a list of all Requirement Statuses.", "operationId": "Requirement_Statuses", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementStatusResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementStatusResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementStatusResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementStatusResponse" } } } } } }, "deprecated": false } }, "/Requirement/Priority/{Id}": { "get": { "tags": [ "Requirement" ], "summary": "Get a Requirement Priority By ID", "description": "Get a Requirement Priority level by ID.", "operationId": "Requirement_PriorityById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementPriorityResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RequirementPriorityResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RequirementPriorityResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RequirementPriorityResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Priority", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Requirement/Priority": { "get": { "tags": [ "Requirement" ], "summary": "Get all Requirement Priorities", "description": "Get a list of Requirement Priority Levels.", "operationId": "Requirement_Priorities", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementPriorityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementPriorityResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementPriorityResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementPriorityResponse" } } } } } }, "deprecated": false } }, "/Requirement/Definitions": { "get": { "tags": [ "Requirement" ], "summary": "Get All Requirement Definitions", "operationId": "Requirement_Definitions", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "requirementID", "in": "query", "description": "RequirementID filter", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "query", "description": "Name filter", "required": false, "schema": { "type": "string" } }, { "name": "targetAboutType", "in": "query", "description": "TargetAboutType filter", "required": false, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } } ] } }, "/Requirement/Definition/{id}": { "get": { "tags": [ "Requirement" ], "summary": "Get Requirement Definition", "operationId": "Requirement_Definition", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RequirementResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RequirementResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RequirementResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "id", "in": "path", "description": "ID of requirement definition", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Requirement/List": { "get": { "tags": [ "Requirement" ], "summary": "Get All Object Requirements by Requirement ID and Requirement Status", "operationId": "Requirement_List", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "requirementID", "in": "query", "description": "RequirementID filter", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "statusIDs", "in": "query", "description": "Status IDs filter", "required": false, "items": { "type": "integer", "format": "int32" }, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ] } }, "/Requirement/Filter": { "post": { "tags": [ "Requirement" ], "summary": "Get a list of Object Requirements that satisfy given filter parameters", "description": "CandidateVendorCompanyID filter works only for vendor companies which are shared with used entity\r\n and in erecruit these vendors show up in the Vendor dropdown on Candidate's Tax tab. \r\n For any other vendor company or internal entity this endpoint won't return anything.", "operationId": "Requirement_Filter", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } } } } }, "deprecated": false, "requestBody": { "description": "Parameters used to filter the object requirements list", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRequirementFilterRequest" } } }, "x-name": "args" } } }, "/Requirement/{id}": { "get": { "tags": [ "Requirement" ], "summary": "Get Object Requirement by ID", "operationId": "Requirement_Single", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRequirementResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ObjectRequirementResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ObjectRequirementResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "id", "in": "path", "description": "Object Requirement ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "put": { "tags": [ "Requirement" ], "summary": "Update an Existing Requirement by ID", "description": "UserID parameter is required. For many of the properties with name X, there is additional property named IsXSet. If that property exists and you want to update it, set IsXSet to true or otherwise, it won't be updated", "operationId": "Requirement_Update", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRequirementResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ObjectRequirementResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ObjectRequirementResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "id", "in": "path", "description": "Object Requirement ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Data to update", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRequirementUpdateRequest" } } }, "x-name": "request" } } }, "/Requirement": { "post": { "tags": [ "Requirement" ], "summary": "Create a new Object Requirement", "operationId": "Requirement_Create", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRequirementResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ObjectRequirementResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ObjectRequirementResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } } } }, "deprecated": false, "requestBody": { "description": "Creation data", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRequirementCreateRequest" } } }, "x-name": "request" } } }, "/Requirement/Integration/Status/{requirementID}": { "get": { "tags": [ "Requirement" ], "summary": "Get Integration Status Definitions by Requirement ID", "operationId": "Requirement_IntegrationStatuses", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationStatusResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IntegrationStatusResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/IntegrationStatusResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "requirementID", "in": "path", "description": "ID of (control panel) requirement", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Requirement/Integration/List/{PartnerId}": { "get": { "tags": [ "Requirement" ], "summary": "Get All Object Requirements with Processing Status by Integration Partner", "operationId": "Requirement_IntegrationList", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRequirementResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "PartnerId", "in": "path", "description": "ID of integration partner", "required": true, "schema": { "type": "string" } } ] } }, "/Requirement/Integration/Partner/{Id}": { "get": { "tags": [ "Requirement" ], "summary": "Get Integration Partner by Id", "operationId": "Requirement_IntegrationPartnerById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationPartnerResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationPartnerResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IntegrationPartnerResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/IntegrationPartnerResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "Id of Integration Partner", "required": true, "schema": { "type": "string" } } ] } }, "/Requirement/Integration/Provider/{PartnerId}/{Id}": { "get": { "tags": [ "Requirement" ], "summary": "Get Integration Provider by Id", "operationId": "Requirement_IntegrationProviderById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationProviderResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationProviderResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IntegrationProviderResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/IntegrationProviderResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "PartnerId", "in": "path", "description": "Id of Integration Partner", "required": true, "schema": { "type": "string" } }, { "name": "Id", "in": "path", "description": "Id of Integration Provider", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Requirement/Integration/Package/{PartnerId}/{Id}": { "get": { "tags": [ "Requirement" ], "summary": "Get Integration Package by Id", "operationId": "Requirement_IntegrationPackageById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationPackageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationPackageResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IntegrationPackageResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/IntegrationPackageResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "PartnerId", "in": "path", "description": "Id of Integration Partner", "required": true, "schema": { "type": "string" } }, { "name": "Id", "in": "path", "description": "Id of Integration Package", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Requirement/Integration/Service/{PartnerId}/{Id}": { "get": { "tags": [ "Requirement" ], "summary": "Get Integration Service by Id", "operationId": "Requirement_IntegrationServiceById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationServiceResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IntegrationServiceResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/IntegrationServiceResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "PartnerId", "in": "path", "description": "Id of Integration Partner", "required": true, "schema": { "type": "string" } }, { "name": "Id", "in": "path", "description": "Id of Integration Service", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/ScheduledItem": { "post": { "tags": [ "ScheduledItem" ], "operationId": "ScheduledItem_CreateScheduledItem", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledItemResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScheduledItemResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ScheduledItemResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ScheduledItemResponse" } } } } }, "deprecated": false, "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledItemRequest" } } }, "x-name": "request" } } }, "/Seed/{Id}": { "get": { "tags": [ "Seed" ], "summary": "Get the Seed for the Id Provided", "description": "Get the Seed for the provided Id.", "operationId": "Seed_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SeedResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SeedResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SeedResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of a Seed", "required": true, "schema": { "type": "integer", "format": "int64" } } ] }, "put": { "tags": [ "Seed" ], "summary": "Modify a Seed", "description": "Modify the values of a Seed. The following fields cannot be altered,\r\n Status, Type, AdSource, Id, and AboutType. If you would like to reset\r\n Gender to NULL, you should provide an empty string for that field.", "operationId": "Seed_Edit", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SeedResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SeedResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SeedResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Seed to Modify", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The Set of Fields to Alter", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeedResponse" } } }, "x-name": "request" } } }, "/Seed": { "post": { "tags": [ "Seed" ], "summary": "Create a new Seed", "description": "Create a new seed from the provided fields. TypeId must be valid for the Seed to be created successfully.\r\n The AdSource selected must be valid for Seeds, and if the AdSource required additional info, then \r\n AdSourceAdditionalInfo must have a value. If AssignTo is NULL or invalid, the Seed will be assigned to the User who\r\n is currently using the API, otherwise, it will be asigned to the User who has the Id provided.", "operationId": "Seed_Create", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SeedResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SeedResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SeedResponse" } } } } }, "deprecated": false, "requestBody": { "description": "The set of Fields to make the Seed from", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeedRequest" } } }, "x-name": "request" } } }, "/Seed/{Id}/AssignTo/{UserId}": { "patch": { "tags": [ "Seed" ], "summary": "Reassign a Seed to another User", "description": "Reassigned the Seed from the its current assignee to another User. Upon success, a 204\r\n (No Content) will be returned.", "operationId": "Seed_ReAssign", "consumes": [], "produces": [], "responses": { "204": { "description": "No Content" } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Seed", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "UserId", "in": "path", "description": "The Id of the User to Assign the Seed to", "required": true, "schema": { "type": "string" } } ] } }, "/Seed/{Id}/Biography": { "get": { "tags": [ "Seed" ], "summary": "Get the Biography Section of this Seed", "description": "Get the Biography Section of this Seed.", "operationId": "Seed_GetBio", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Seed", "required": true, "schema": { "type": "integer", "format": "int64" } } ] } }, "/Seed/{Id}/Notes": { "get": { "tags": [ "Seed" ], "summary": "Get the Notes Section of this Seed", "description": "Get the Notes Section of this Seed. This is not the same as Notes\r\n that may be attached to this record.", "operationId": "Seed_GetNotes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Seed", "required": true, "schema": { "type": "integer", "format": "int64" } } ] } }, "/Seed/{Id}/Resume": { "get": { "tags": [ "Seed" ], "summary": "Get the Resume Text of this Seed", "description": "Get the Resume Text of this Seed.", "operationId": "Seed_GetResume", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/TextResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Seed", "required": true, "schema": { "type": "integer", "format": "int64" } } ] } }, "/Seed/Type": { "get": { "tags": [ "Seed" ], "summary": "Get all Valid Seed Types", "description": "Get a list of all Valid Seed Types.", "operationId": "Seed_GetTypes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Shift/{aboutType}/{referenceID}": { "get": { "tags": [ "Shift" ], "summary": "Get all Shifts for a given AboutType", "description": "Retrieves a list of Shifts for a given AboutType. Possible values of AboutType are Company, Position, Match, Candidate or FacilityDepartment.\r\n If a different AboutType is specified, the Shifts for a Position identified by a referenceID will be returned.", "operationId": "Shift_GetShifts", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "aboutType", "in": "path", "description": "The type of the record (Company, Position, Match, Candidate or FacilityDepartment)", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "referenceID", "in": "path", "description": "ID associated with the About Type", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "assigned", "in": "query", "description": "Specify whether to return only shifts that are assigned to a candidate, optional", "required": false, "schema": { "type": "boolean" } }, { "name": "status", "in": "query", "description": "Status of the shifts, optional", "required": false, "schema": { "type": "string", "enum": [ "Open", "Closed", "Cancelled" ] } } ] } }, "/Shift": { "post": { "tags": [ "Shift" ], "summary": "Create new Shifts", "description": "Create new Shifts from the information provided. Accepted AboutTypes for which Shifts will be created are Position and Opportunity.\r\n Provided FacilityDepartmentId must be associated with the given AboutType and provided FolderGroupId must be associated with the Position or\r\n the Opportunity identified by ReferenceId parameter. In case of a failing validation, a HTTP Status Code 400 (Bad Request) will be returned.", "operationId": "Shift_CreateShifts", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Object" } } } } }, "deprecated": false, "requestBody": { "description": "Data describing the Shifts that will be created", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftRequest" } } }, "x-name": "req" } } }, "/Shift/Update": { "put": { "tags": [ "Shift" ], "summary": "Update an existing Shift", "description": "Only fields that are included and not null will be updated.", "operationId": "Shift_UpdateShift", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Object" } } } } }, "deprecated": false, "requestBody": { "description": "Data describing the parameters of a Shift that will be updated", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftUpdateRequest" } } }, "x-name": "req" } } }, "/Shift/Cancel": { "put": { "tags": [ "Shift" ], "summary": "Cancel a Shift", "description": "Create a cancellation for a Shift with a specified reason and attributed data.\r\n If specified reason does not exist, an HTTP Status Code 400 (Bad Request) will be returned.", "operationId": "Shift_CancelShift", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Object" } } } } }, "deprecated": false, "requestBody": { "description": "Data describing the Shift that will be Cancelled, along with the reason for cancellation", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftCancellationRequest" } } }, "x-name": "req" } } }, "/Shift/Types": { "get": { "tags": [ "Shift" ], "summary": "Get a list of possible Shift Types", "description": "Retrieves a list of global or company specific Shift types.\r\n If a CompanyId parameter is not specified, the list of global shift types will be returned.\r\n If a CompanyId parameter is specified, a list of global and company specific shift types will be returned.", "operationId": "Shift_GetShiftTypes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftTypeResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftTypeResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftTypeResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftTypeResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "companyId", "in": "query", "description": "ID of a company for which specific types are being requested, optional", "required": false, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Shift/Status": { "get": { "tags": [ "Shift" ], "summary": "Get a list of possible Shift Statuses", "description": "Retrieves a list of possible Shift Status values to which a Shift can be updated.", "operationId": "Shift_GetShiftStatuses", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftStatusResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftStatusResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftStatusResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftStatusResponse" } } } } } }, "deprecated": false } }, "/Tags/{aboutType}/{recordId}": { "get": { "tags": [ "Tag" ], "operationId": "Tag_GetTags", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "aboutType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ] }, "post": { "tags": [ "Tag" ], "operationId": "Tag_PostTag", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } } }, "deprecated": false, "parameters": [ { "name": "aboutType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRequest" } } }, "x-name": "tagRequest" } } }, "/Tags/{aboutType}": { "get": { "tags": [ "Tag" ], "operationId": "Tag_GetTagsForAboutType", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleTagResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleTagResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleTagResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleTagResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "aboutType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } } ] } }, "/Tags/{aboutType}/{recordId}/{tagAssignmentId}": { "delete": { "tags": [ "Tag" ], "operationId": "Tag_Delete", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } }, "application/xml": { "schema": { "type": "boolean" } }, "text/xml": { "schema": { "type": "boolean" } } } } }, "deprecated": false, "parameters": [ { "name": "aboutType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "tagAssignmentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Timesheet/Candidate/{Id}": { "get": { "tags": [ "Timesheet" ], "summary": "Get a Candidate's Timesheets.", "description": "Retrieve all Timesheets for the Candidate with the Id provided.\r\n If the Candidate does not exist, zero Timesheets will be returned.", "operationId": "Timesheet_GetTimesheetforCandidate", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimesheetResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimesheetResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimesheetResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimesheetResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Candidate", "required": true, "schema": { "type": "integer", "format": "int64" } } ] } }, "/Timesheet/Reason": { "get": { "tags": [ "Timesheet" ], "summary": "Get all Possible Timesheet Rejection Reasons", "description": "Get a list of Possible Rejection Reasons", "operationId": "Timesheet_GetCloseReasons", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/Timesheet/Reason/{Id}": { "get": { "tags": [ "Timesheet" ], "summary": "Get a Timesheet Rejection Reason by Id", "description": "Get a Timesheet Rejection Reason by Id.", "operationId": "Timesheet_GetCloseReason", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Rejection Reason", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/User/ChangePassword": { "post": { "tags": [ "User" ], "summary": "Used when changing password if user knows old password", "operationId": "User_ChangePassword", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } } }, "deprecated": false, "requestBody": { "description": "Data needed to change the password", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } } }, "x-name": "request" } } }, "/User/ChangeUserName": { "post": { "tags": [ "User" ], "summary": "Used when changing username if user knows both current username and password", "description": "This endpoint returns the ID of the user whose username was changed", "operationId": "User_ChangeUserName", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } } }, "deprecated": false, "requestBody": { "description": "Data needed to change the username", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeUsernameRequest" } } }, "x-name": "request" } } }, "/User/ChangePasswordByToken": { "post": { "tags": [ "User" ], "summary": "Used when changing password with password reset token", "operationId": "User_ChangePasswordByToken", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } } }, "deprecated": false, "requestBody": { "description": "Data needed to change the password", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordByTokenRequest" } } }, "x-name": "request" } } }, "/User/SendPasswordResetToken": { "post": { "tags": [ "User" ], "summary": "Sends password reset token to user using the specified email template", "operationId": "User_SendPasswordResetToken", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } } }, "deprecated": false, "requestBody": { "description": "Data related to sending password reset token", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordResetTokenRequest" } } }, "x-name": "request" } } }, "/User/ValidateCredentials": { "post": { "tags": [ "User" ], "summary": "Validates credentials and returns appropriate ID based on a user type", "description": "This method cannot be used to validate federated users' credentials", "operationId": "User_ValidateCredentials", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateCredentialsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateCredentialsResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ValidateCredentialsResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ValidateCredentialsResponse" } } } } }, "deprecated": false, "requestBody": { "description": "Credentials to validate", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateCredentialsRequest" } } }, "x-name": "request" } } }, "/Vendor": { "get": { "tags": [ "Vendor" ], "summary": "Get a list of vendor companies.", "description": "Get a list of vendor companies.", "operationId": "Vendor_GetVendors", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorResponse" } } } } } }, "deprecated": false } }, "/Vendor/{vendorID}/Contacts": { "get": { "tags": [ "Vendor" ], "summary": "Get a list of recruiters for a given vendor company", "description": "Get a list of recruiters for a given vendor company.", "operationId": "Vendor_GetVendorContacts", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorContactResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorContactResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorContactResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendorContactResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "vendorID", "in": "path", "description": "The id of the Vendor Company", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Vendor/VendorOwnership/{vendorId}/{candidateId}": { "patch": { "tags": [ "Vendor" ], "summary": "Update Vendor Ownership of Candidate", "operationId": "Vendor_SetVendorOwnership", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorOwnershipResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VendorOwnershipResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VendorOwnershipResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VendorOwnershipResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "candidateId", "in": "path", "description": "The Id of the Candidate to update the vendor ownership of.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "vendorId", "in": "path", "description": "The Id of the Vendor", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Vendor/VendorOwnership/{candidateId}": { "get": { "tags": [ "Vendor" ], "summary": "Get the vendor owner of the Candidate.", "operationId": "Vendor_GetVendorOwnership", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VendorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VendorResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VendorResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "candidateId", "in": "path", "description": "The Id of the Candidate to update the vendor ownership of.", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Vendor/VendorContact/{vendorContactId}": { "get": { "tags": [ "Vendor" ], "summary": "Get the vendor contact info of the vendor contact.", "operationId": "Vendor_GetVendorContact", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorContactResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VendorContactResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VendorContactResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VendorContactResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "vendorContactId", "in": "path", "description": "The Id of the Vendor Contact.", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/Vendor/ShareCandidate/{candidateId}/{share}": { "put": { "tags": [ "Vendor" ], "summary": "Share a Candidate with the Logged in Entity", "description": "Share a candidate with the entity of the authenticated API user. Only vendor candidates can be shared. Sharing relationships are only allowed if the vendor company has granted share access for their candidates.", "operationId": "Vendor_ShareCandidate", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VendorCandidateShareResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VendorCandidateShareResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VendorCandidateShareResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VendorCandidateShareResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "candidateId", "in": "path", "description": "The Id of the Candidate to update the vendor ownership of.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "share", "in": "path", "description": "Flag to share/unshare candidate", "required": true, "schema": { "type": "boolean" } } ] } }, "/WorkHistory/{Id}": { "get": { "tags": [ "WorkHistory" ], "summary": "Get a Work History By Id", "description": "Get a Work History by Id. A 404 (Not-Found) will be returned if it cannot be found.\r\n Note, CompanyName and CompanyId, if both populated, may or may not be related to one another.\r\n CompanyName allows for Companies outside of erecruit to be referenced while, CompanyId is of course\r\n for the referencing of Companies that erecruit already knows about.", "operationId": "WorkHistory_GetWorkHistory", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkHistoryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkHistoryResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/WorkHistoryResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/WorkHistoryResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the WorkHistory Entry", "required": true, "schema": { "type": "integer", "format": "int32" } } ] }, "put": { "tags": [ "WorkHistory" ], "summary": "Update the Fields of a Work History Entry", "description": "All Fields will be Updated to the value supplied. This does include the Description,\r\n if Description is left 'null' or empty, the field will be saved as a 'null' in our System.\r\n Note, the CompanyName and CompanyId field should usually not both by used. CompanyName is provided\r\n so that a Company that isn't in erecruit can still be referenced. Whereas CompanyId is specifically for\r\n referencing a Company that does exist in erecruit.", "operationId": "WorkHistory_UpdateWorkHistory", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkHistoryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkHistoryResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/WorkHistoryResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/WorkHistoryResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Work History Entry to Update", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The Fields to Overwrite the Existing Work History Entry's Fields with", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkHistoryRequest" } } }, "x-name": "response" } }, "delete": { "tags": [ "WorkHistory" ], "summary": "Delete a Work History Entry by Id", "description": "Delete a Work History Entry by Id. The Work History must exist for this operation to succeed.", "operationId": "WorkHistory_Delete", "consumes": [], "produces": [], "responses": { "204": { "description": "No Content" } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Work History Entry to Delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/WorkHistory/{AboutType}/{Id}": { "get": { "tags": [ "WorkHistory" ], "summary": "Get All Work Histories for a Record", "description": "Get all Work History entries for a single record as described by its AboutType and Id. An empty\r\n set will be returned if there aren't any Work History entries associated with the record.\r\n Note, CompanyName and CompanyId, if both populated, may or may not be related to one another.\r\n CompanyName allows for Companies outside of erecruit to be referenced while, CompanyId is of course\r\n for the referencing of Companies that erecruit already knows about.", "operationId": "WorkHistory_GetWorkHistoryFor", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkHistoryResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkHistoryResponse" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkHistoryResponse" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkHistoryResponse" } } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The AboutType of the Record to get Work History Entries for", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record to get Work History Entries for", "required": true, "schema": { "type": "integer", "format": "int64" } } ] }, "post": { "tags": [ "WorkHistory" ], "summary": "Create a new Work History Entry for the Specified Record", "description": "Create a new Work History entry for the record specified. The record must exist for\r\n this operation to be successful. If a Company Id is specified, but it is invalid, this operation\r\n will be successful, however the Company will not be associated with this record, and CompanyId will be 'null'.\r\n If the Company does not exist in erecruit, then you can still list its name in the CompanyName field.", "operationId": "WorkHistory_CreateWorkHistoryFor", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkHistoryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkHistoryResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/WorkHistoryResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/WorkHistoryResponse" } } } } }, "deprecated": false, "parameters": [ { "name": "AboutType", "in": "path", "description": "The AboutType of the Record", "required": true, "schema": { "type": "string", "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ] } }, { "name": "Id", "in": "path", "description": "The Id of the Record", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The Set of Fields to be Used to Create the new Work History Entry", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkHistoryRequest" } } }, "x-name": "request" } } }, "/WorkHistory/Reason": { "get": { "tags": [ "WorkHistory" ], "summary": "Get All Possible Reasons for Leaving a Position", "description": "Get a List of all possible Reasons for Leaving a previous employer.", "operationId": "WorkHistory_GetReasons", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/WorkHistory/CompensationType": { "get": { "tags": [ "WorkHistory" ], "summary": "Get All Possible Compensation Types", "description": "Get a List of all possible Compensation Types.", "operationId": "WorkHistory_GetCompensationTypes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } } } }, "deprecated": false } }, "/WorkHistory/Reason/{Id}": { "get": { "tags": [ "WorkHistory" ], "summary": "Get a Reason for Leaving by its Id", "description": "Get the Reason for Leaving by Id. The Reason must exist for this operation to succeed.", "operationId": "WorkHistory_GetReasonByID", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NamedValue" } } } } }, "deprecated": false, "parameters": [ { "name": "Id", "in": "path", "description": "The Id of the Reason for Leaving", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } }, "/WorkHistory/Description/{ID}": { "get": { "tags": [ "WorkHistory" ], "summary": "Get Description for given Work History ID", "description": "Get Work History Description by Working History ID.", "operationId": "WorkHistory_GetDescription", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } } } }, "deprecated": false, "parameters": [ { "name": "ID", "in": "path", "description": "The ID of the Working History", "required": true, "schema": { "type": "integer", "format": "int32" } } ] } } }, "components": { "schemas": { "AddressResponse": { "required": [ "AboutType", "AddressID", "StateID", "CountryID", "TypeID" ], "type": "object", "properties": { "AboutType": { "type": "string", "readOnly": true }, "Name": { "type": "string" }, "AddressID": { "format": "int64", "type": "integer" }, "AddressLine1": { "type": "string" }, "AddressLine2": { "type": "string" }, "City": { "type": "string" }, "PostalCode": { "type": "string" }, "State": { "type": "string" }, "Country": { "type": "string" }, "Region": { "type": "string" }, "StateID": { "format": "int64", "type": "integer" }, "CountryID": { "format": "int64", "type": "integer" }, "RegionID": { "format": "int64", "type": "integer" }, "StateCode": { "type": "string" }, "CountryCode": { "type": "string" }, "TypeID": { "format": "int32", "type": "integer" }, "Latitude": { "format": "double", "type": "number" }, "Longitude": { "format": "double", "type": "number" } } }, "AddressRequest": { "required": [ "Name", "StateID", "CountryID", "TypeID" ], "type": "object", "properties": { "Name": { "type": "string" }, "AddressLine1": { "type": "string" }, "AddressLine2": { "type": "string" }, "City": { "type": "string" }, "PostalCode": { "type": "string" }, "StateID": { "format": "int32", "type": "integer" }, "RegionID": { "format": "int32", "type": "integer" }, "CountryID": { "format": "int32", "type": "integer" }, "TypeID": { "format": "int32", "type": "integer" } } }, "AddressLinkRequest": { "type": "object", "properties": { "Records": { "type": "array", "items": { "$ref": "#/components/schemas/RecordReference" } } } }, "RecordReference": { "required": [ "Type", "ID" ], "type": "object", "properties": { "Type": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" }, "ID": { "format": "int64", "type": "integer" } } }, "PatchResponse": { "type": "object", "properties": { "Result": { "enum": [ "Deleted", "Unlinked" ], "type": "string" } } }, "NamedValue": { "type": "object", "properties": { "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" } } }, "AdSourceValue": { "type": "object", "properties": { "RequiresAdditionalInfo": { "type": "boolean" }, "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" } } }, "AdSourceResponse": { "type": "object", "properties": { "AdSourceID": { "format": "int32", "type": "integer" }, "SourceName": { "type": "string" }, "RequiredAdditionalInfo": { "type": "boolean" }, "AdditionalInfo": { "type": "string" } } }, "AdSourceRequest": { "required": [ "AdSourceID" ], "type": "object", "properties": { "AdditionalInfo": { "type": "string" }, "AdSourceID": { "format": "int32", "type": "integer" } } }, "AttachmentResponse": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Version": { "format": "int32", "type": "integer" }, "TypeID": { "format": "int32", "type": "integer" }, "Type": { "type": "string" }, "ExternalStatus": { "type": "string" }, "Extension": { "type": "string" }, "IsNewestVersion": { "type": "boolean" }, "DateAdded": { "format": "date-time", "type": "string" }, "AddedByID": { "type": "string" }, "AboutType": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" }, "ReferenceID": { "format": "int64", "type": "integer" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "Description": { "type": "string" }, "Meta": { "$ref": "#/components/schemas/OnboardingDocumentMeta" }, "DocumentType": { "enum": [ "Attachment", "OnboardingDefinition", "OnboardingDocument" ], "type": "string" }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "AttachmentContent" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/Attachment/Content/{id}", "rel": "AttachmentContent" } ] } } }, "OnboardingDocumentMeta": { "type": "object", "properties": { "OnboardingId": { "type": "string" }, "DateAccepted": { "format": "date-time", "type": "string" }, "DateCertified": { "format": "date-time", "type": "string" }, "CertifiedByID": { "type": "string" }, "OnboardingDocumentDefinitionID": { "type": "string" }, "OnboardingDocumentDefinitionName": { "type": "string" }, "OnboardingDocumentExternalStatus": { "type": "string" } } }, "LinkedField": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "Addresses", "Communications", "FolderGroups", "CustomFields", "Statuses", "CompleteRequirements", "IncompleteRequirements", "Owners", "DefaultAddress", "AdSource", "Source", "Industry", "Summary", "Comments", "Description", "Bio", "Notes", "Resume", "Text", "Status", "Type", "Category", "SubCategory", "Reference", "EducationLevel", "Reason", "Rating", "PaymentType", "CreatedBy", "WorkHistory", "EducationHistory", "AttachmentContent", "CommunicationPreferences", "Match", "Candidate", "Contact", "Company", "Position", "DimensionValue", "Credit", "DateOfBirth", "User", "Recruiter", "Department", "Priority", "Attachment", "CompanyDepartment", "FolderGroup", "Requirements", "IntegrationPartner", "IntegrationProvider", "IntegrationPackage", "IntegrationService", "Owner", "CandidateOwner", "Vendor", "DivisionInfo", "AffiliatedCompanies" ], "type": "string" } } }, "Object": { "type": "object", "properties": {} }, "AttachmentRequest": { "required": [ "AboutType", "ReferenceID", "AttachmentTypeID", "Name" ], "type": "object", "properties": { "AboutType": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" }, "ReferenceID": { "format": "int32", "type": "integer" }, "AttachmentTypeID": { "enum": [ "Resume", "Agreement", "Invoice", "ReferenceCheck", "ProfilePicture", "InvoicePDF", "Other" ], "type": "string" }, "Name": { "type": "string" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "Note": { "type": "string" } } }, "AttachmentUploadFromHTMLRequest": { "required": [ "HtmlAsBase64", "AboutType", "ReferenceID", "AttachmentTypeID", "Name" ], "type": "object", "properties": { "HtmlAsBase64": { "type": "string" }, "AboutType": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" }, "ReferenceID": { "format": "int32", "type": "integer" }, "AttachmentTypeID": { "enum": [ "Resume", "Agreement", "Invoice", "ReferenceCheck", "ProfilePicture", "InvoicePDF", "Other" ], "type": "string" }, "Name": { "type": "string" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "Note": { "type": "string" } } }, "AttachmentTypeResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "ApplicableTo": { "type": "array", "items": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" } } } }, "CandidateResponse": { "type": "object", "properties": { "First": { "type": "string" }, "Last": { "type": "string" }, "Middle": { "type": "string" }, "Nickname": { "type": "string" }, "Title": { "type": "string" }, "ID": { "format": "int32", "type": "integer" }, "AboutType": { "type": "string", "readOnly": true }, "AdSource": { "type": "string" }, "IsLookingForContract": { "type": "boolean" }, "IsLookingForContractToPerm": { "type": "boolean" }, "IsLookingForPerm": { "type": "boolean" }, "DefaultAddressID": { "format": "int64", "type": "integer" }, "EducationLeveID": { "format": "int64", "type": "integer" }, "UserID": { "type": "string" }, "RatingID": { "format": "int32", "type": "integer" }, "ContratorTypeID": { "format": "int32", "type": "integer" }, "StatusID": { "format": "int32", "type": "integer" }, "CurrentEmployer": { "type": "string" }, "HireDate": { "format": "date-time", "type": "string" }, "ReHireDate": { "format": "date-time", "type": "string" }, "DateAvailable": { "format": "date-time", "type": "string" }, "EntityName": { "type": "string" }, "EntityID": { "type": "string" }, "_expanded": { "type": "object", "properties": { "DefaultAddress": { "$ref": "#/components/schemas/AddressResponse" }, "EducationLevel": { "$ref": "#/components/schemas/EducationLevelResponse" }, "Summary": { "$ref": "#/components/schemas/CandidateSummaryResponse" }, "Owners": { "$ref": "#/components/schemas/OwnerResponse" }, "CommunicationPreferences": { "$ref": "#/components/schemas/CommunicationPreferencesResponse" }, "Addresses": { "$ref": "#/components/schemas/AddressResponse" }, "Communications": { "$ref": "#/components/schemas/CommunicationResponse" }, "FolderGroups": { "$ref": "#/components/schemas/RecordFolderGroupResponse" } } }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "DateOfBirth", "WorkHistory", "EducationHistory", "AdSource" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/EEOC/Candidate/{Id}/DOB", "rel": "DateOfBirth" }, { "href": "https://erecruit.nelsonstaffing.com/WebApi/WorkHistory/{AboutType}/{Id}", "rel": "WorkHistory" }, { "href": "https://erecruit.nelsonstaffing.com/WebApi/Education/{AboutType}/{Id}", "rel": "EducationHistory" }, { "href": "https://erecruit.nelsonstaffing.com/WebApi/AdSource/{AboutType}/{Id}", "rel": "AdSource" } ] } } }, "EducationLevelResponse": { "type": "object", "properties": { "Description": { "type": "string" }, "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" } } }, "CandidateSummaryResponse": { "type": "object", "properties": { "Summary": { "type": "string" } } }, "OwnerResponse": { "type": "object", "properties": { "RecruiterID": { "format": "int32", "type": "integer" }, "AdditionalOwnerRecordID": { "format": "int32", "type": "integer" }, "IsPrimary": { "type": "boolean" }, "AdditionalOwnerType": { "type": "string" }, "DepartmentID": { "format": "int64", "type": "integer" }, "_expanded": { "type": "object", "properties": { "Recruiter": { "$ref": "#/components/schemas/RecruiterResponse" }, "Department": { "$ref": "#/components/schemas/DepartmentResponse" }, "DimensionValue": { "$ref": "#/components/schemas/DimensionValueResponse" } } } } }, "CommunicationPreferencesResponse": { "required": [ "DoNotEmail", "DoNotCall", "DoNotText" ], "type": "object", "properties": { "DoNotEmail": { "type": "boolean" }, "DoNotCall": { "type": "boolean" }, "DoNotText": { "type": "boolean" } } }, "CommunicationResponse": { "required": [ "ID", "TypeID" ], "type": "object", "properties": { "ID": { "format": "int64", "type": "integer" }, "ReferencedType": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" }, "ReferencedID": { "format": "int32", "type": "integer" }, "TypeID": { "format": "int32", "type": "integer" }, "TypeTEST": { "type": "string" }, "CategoryID": { "format": "int32", "type": "integer" }, "Category": { "type": "string" }, "Value": { "type": "string" }, "IsPrimary": { "type": "boolean" }, "Note": { "type": "string" } } }, "RecordFolderGroupResponse": { "type": "object", "properties": { "StatusID": { "format": "int32", "type": "integer" }, "ID": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "SubcategoryID": { "format": "int32", "type": "integer" }, "CategoryID": { "format": "int32", "type": "integer" }, "_expanded": { "type": "object", "properties": { "Category": { "$ref": "#/components/schemas/NamedValue" }, "SubCategory": { "$ref": "#/components/schemas/FolderGroupSubCategoryResponse" } } }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "Status" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/FolderGroup/Status/{Id}", "rel": "Status" } ] } } }, "RecruiterResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "UserID": { "type": "string" }, "First": { "type": "string" }, "Last": { "type": "string" }, "EmailAddress": { "type": "string" }, "Title": { "type": "string" }, "IsActive": { "type": "boolean" }, "AddressID": { "format": "int64", "type": "integer" }, "AboutType": { "type": "string", "readOnly": true }, "_expanded": { "type": "object", "properties": { "DefaultAddress": { "$ref": "#/components/schemas/AddressResponse" } } }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "AdSource" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/AdSource/{AboutType}/{Id}", "rel": "AdSource" } ] } } }, "DepartmentResponse": { "type": "object", "properties": { "ParentID": { "format": "int64", "type": "integer" }, "DefaultOwner": { "$ref": "#/components/schemas/NamedValue" }, "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" } } }, "DimensionValueResponse": { "type": "object", "properties": { "Value": { "type": "string" }, "LevelID": { "format": "int32", "type": "integer" }, "DimensionName": { "type": "string" } } }, "FolderGroupSubCategoryResponse": { "type": "object", "properties": { "IndustryID": { "format": "int32", "type": "integer" }, "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" } } }, "CandidateUpdateRequest": { "type": "object", "properties": { "First": { "type": "string" }, "Last": { "type": "string" }, "Middle": { "type": "string" }, "Title": { "type": "string" }, "CurrentEmployer": { "type": "string" }, "IsLookingForContract": { "type": "boolean" }, "IsLookingForContractToPerm": { "type": "boolean" }, "IsLookingForPerm": { "type": "boolean" }, "StatusID": { "format": "int32", "type": "integer" }, "SSN": { "type": "string" }, "ContractorTypeID": { "format": "int32", "type": "integer" }, "DateAvailable": { "format": "date-time", "type": "string" } } }, "CandidateDuplicateCheckRequest": { "type": "object", "properties": { "First": { "type": "string" }, "Last": { "type": "string" }, "Middle": { "type": "string" }, "Emails": { "type": "array", "items": { "type": "string" } }, "Phones": { "type": "array", "items": { "type": "string" } } } }, "CandidateProvisionRequest": { "required": [ "Password" ], "type": "object", "properties": { "Password": { "type": "string" }, "EmailConfirmation": { "type": "boolean" }, "WithPermissions": { "type": "boolean" } } }, "UserResponse": { "type": "object", "properties": { "ID": { "type": "string" }, "LastActive": { "format": "date-time", "type": "string" }, "UserName": { "type": "string" }, "ReferencedID": { "format": "int64", "type": "integer" }, "AboutType": { "type": "string" } } }, "ValueResponse": { "type": "object", "properties": { "Value": { "type": "string" } } }, "CandidateRequest": { "required": [ "First", "Last", "FolderGroupID", "AdSourceID" ], "type": "object", "properties": { "First": { "type": "string" }, "Last": { "type": "string" }, "Middle": { "type": "string" }, "AddressID": { "format": "int32", "type": "integer" }, "Title": { "type": "string" }, "FolderGroupID": { "format": "int32", "type": "integer" }, "AdSourceID": { "format": "int32", "type": "integer" }, "AdSourceAdditionalInfo": { "type": "string" }, "Emails": { "type": "array", "items": { "type": "string" } }, "Phones": { "type": "array", "items": { "type": "string" } }, "SSN": { "type": "string" }, "CurrentEmployer": { "type": "string" }, "ContractorTypeID": { "format": "int32", "type": "integer" }, "DateAvailable": { "format": "date-time", "type": "string" } } }, "CandidateSummaryRequest": { "required": [ "Summary" ], "type": "object", "properties": { "Summary": { "type": "string" } } }, "CandidateApplicationRequest": { "required": [ "CandidateID", "PositionID", "ApplicationSourceID" ], "type": "object", "properties": { "CandidateID": { "format": "int32", "type": "integer" }, "PositionID": { "format": "int32", "type": "integer" }, "ApplicationSourceID": { "format": "int32", "type": "integer" }, "ApplicationNote": { "type": "string" } } }, "CandidateApplicationResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Note": { "type": "string" }, "AdSource": { "type": "string" }, "Status": { "type": "string" }, "RejectionReason": { "type": "string" }, "RejectedOn": { "format": "date-time", "type": "string" }, "CreatedOn": { "format": "date-time", "type": "string" }, "PositionID": { "format": "int32", "type": "integer" }, "CandidateID": { "format": "int32", "type": "integer" }, "MatchID": { "format": "int32", "type": "integer" }, "CreatedByID": { "type": "string" }, "AboutType": { "type": "string", "readOnly": true }, "_expanded": { "type": "object", "properties": { "Candidate": { "$ref": "#/components/schemas/CandidateResponse" }, "Position": { "$ref": "#/components/schemas/PositionResponse" } } }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "Match", "CreatedBy", "AdSource" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/Match/{Id}", "rel": "Match" }, { "href": "https://erecruit.nelsonstaffing.com/WebApi/Recruiter/ByUser/{UserId}", "rel": "CreatedBy" }, { "href": "https://erecruit.nelsonstaffing.com/WebApi/AdSource/{AboutType}/{Id}", "rel": "AdSource" } ] } } }, "PositionResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "CompanyID": { "format": "int32", "type": "integer" }, "ContactID": { "format": "int32", "type": "integer" }, "ExternalPositionID": { "type": "string" }, "Title": { "type": "string" }, "NumberOfPositions": { "format": "int32", "type": "integer" }, "AboutType": { "type": "string", "readOnly": true }, "TypeID": { "format": "int32", "type": "integer" }, "StatusID": { "format": "int32", "type": "integer" }, "MinBillRate": { "format": "double", "type": "number" }, "MaxBillRate": { "format": "double", "type": "number" }, "MinPayRate": { "format": "double", "type": "number" }, "MaxPayRate": { "format": "double", "type": "number" }, "DefaultVendorRateMarkupPercentage": { "format": "double", "type": "number" }, "StartDate": { "format": "date-time", "type": "string" }, "EndDate": { "format": "date-time", "type": "string" }, "StartTime": { "type": "string" }, "EndTime": { "type": "string" }, "DefaultAddressID": { "format": "int64", "type": "integer" }, "GuaranteedHours": { "format": "int32", "type": "integer" }, "PrimaryDepartmentID": { "format": "int64", "type": "integer" }, "PrimaryDepartmentName": { "type": "string" }, "_expanded": { "type": "object", "properties": { "DefaultAddress": { "$ref": "#/components/schemas/AddressResponse" }, "Company": { "$ref": "#/components/schemas/CompanyResponse" }, "Contact": { "$ref": "#/components/schemas/ContactResponse" }, "Status": { "$ref": "#/components/schemas/NamedValue" }, "Type": { "$ref": "#/components/schemas/NamedValue" }, "Comments": { "$ref": "#/components/schemas/TextResponse" }, "Description": { "$ref": "#/components/schemas/TextResponse" }, "Owners": { "$ref": "#/components/schemas/OwnerResponse" }, "Addresses": { "$ref": "#/components/schemas/AddressResponse" }, "Communications": { "$ref": "#/components/schemas/CommunicationResponse" }, "FolderGroups": { "$ref": "#/components/schemas/RecordFolderGroupResponse" } } }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "AdSource" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/AdSource/{AboutType}/{Id}", "rel": "AdSource" } ] } } }, "CompanyResponse": { "type": "object", "properties": { "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" }, "HomePage": { "type": "string" }, "AdSource": { "type": "string" }, "Industry": { "type": "string" }, "AboutType": { "type": "string", "readOnly": true }, "CompanyStatusID": { "format": "int32", "type": "integer" }, "CompanyTypeID": { "format": "int32", "type": "integer" }, "Description": { "type": "string" }, "_expanded": { "type": "object", "properties": { "DefaultAddress": { "$ref": "#/components/schemas/AddressResponse" }, "Status": { "$ref": "#/components/schemas/NamedValue" }, "Owners": { "$ref": "#/components/schemas/OwnerResponse" }, "Addresses": { "$ref": "#/components/schemas/AddressResponse" }, "Communications": { "$ref": "#/components/schemas/CommunicationResponse" }, "FolderGroups": { "$ref": "#/components/schemas/RecordFolderGroupResponse" } } }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "AdSource" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/AdSource/{AboutType}/{Id}", "rel": "AdSource" } ] } } }, "ContactResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "First": { "type": "string" }, "Last": { "type": "string" }, "Middle": { "type": "string" }, "StatusID": { "format": "int32", "type": "integer" }, "CompanyID": { "format": "int32", "type": "integer" }, "Title": { "type": "string" }, "DefaultAddressID": { "format": "int64", "type": "integer" }, "RoleID": { "format": "int32", "type": "integer" }, "Role": { "type": "string" }, "TypeID": { "format": "int32", "type": "integer" }, "Type": { "type": "string" }, "AboutType": { "type": "string", "readOnly": true }, "_expanded": { "type": "object", "properties": { "Company": { "$ref": "#/components/schemas/CompanyResponse" }, "DefaultAddress": { "$ref": "#/components/schemas/AddressResponse" }, "Status": { "$ref": "#/components/schemas/NamedValue" }, "Owners": { "$ref": "#/components/schemas/OwnerResponse" }, "Addresses": { "$ref": "#/components/schemas/AddressResponse" }, "Communications": { "$ref": "#/components/schemas/CommunicationResponse" }, "FolderGroups": { "$ref": "#/components/schemas/RecordFolderGroupResponse" }, "AffiliatedCompanies": { "$ref": "#/components/schemas/CompanyResponse" } } }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "AdSource" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/AdSource/{AboutType}/{Id}", "rel": "AdSource" } ] } } }, "TextResponse": { "type": "object", "properties": { "Text": { "type": "string" } } }, "CandidateReferenceResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "CandidateID": { "format": "int32", "type": "integer" }, "ReferenceType": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" }, "ReferenceID": { "format": "int64", "type": "integer" }, "EnteredOn": { "format": "date-time", "type": "string" }, "CheckedOn": { "format": "date-time", "type": "string" }, "Name": { "type": "string" }, "RelationshipStartDate": { "format": "date-time", "type": "string" }, "RelationshipEndDate": { "format": "date-time", "type": "string" }, "Rating": { "format": "int32", "type": "integer" }, "_expanded": { "type": "object", "properties": { "Candidate": { "$ref": "#/components/schemas/CandidateResponse" }, "Text": { "$ref": "#/components/schemas/TextResponse" } } } } }, "CandidateReferenceRequest": { "required": [ "CandidateID", "Rating" ], "type": "object", "properties": { "CandidateID": { "format": "int32", "type": "integer" }, "ReferenceType": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" }, "ReferenceID": { "format": "int64", "type": "integer" }, "ReferenceText": { "type": "string" }, "Name": { "type": "string" }, "RelationshipStartDate": { "format": "date-time", "type": "string" }, "RelationshipEndDate": { "format": "date-time", "type": "string" }, "Rating": { "format": "int32", "type": "integer" } } }, "CommicationRequestModel": { "required": [ "TypeID" ], "type": "object", "properties": { "TypeID": { "format": "int32", "type": "integer" }, "Value": { "type": "string" }, "IsPrimary": { "type": "boolean" }, "Note": { "type": "string" }, "AuditNote": { "type": "string" } } }, "CompanyFilterRequest": { "type": "object", "properties": { "Distance": { "format": "double", "type": "number" }, "Longitude": { "format": "double", "type": "number" }, "Latitude": { "format": "double", "type": "number" }, "ZipCode": { "type": "string" }, "CompanyStatusIds": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "PageSize": { "format": "int32", "type": "integer" }, "Page": { "format": "int32", "type": "integer" } } }, "PagedCompanyResponse": { "type": "object", "properties": { "Companies": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyResponse" } }, "TotalResults": { "format": "int32", "type": "integer" }, "PageNumber": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" } } }, "CompanyRequestModel": { "type": "object", "properties": { "Name": { "type": "string" }, "IndustryID": { "format": "int64", "type": "integer" }, "AdSourceID": { "format": "int64", "type": "integer" }, "AdSourceAdditionalInfo": { "type": "string" }, "CompanyStatusID": { "format": "int32", "type": "integer" } } }, "CompanyDepartmentResponse": { "type": "object", "properties": { "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" } } }, "CompanyDepartmentMultipleResponse": { "type": "object", "properties": { "CompanyID": { "format": "int32", "type": "integer" }, "CompanyDepartments": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyDepartmentResponse" } } } }, "CompanyDivisionDto": { "type": "object", "properties": { "DivisionId": { "format": "int32", "type": "integer" }, "DivisionName": { "type": "string" }, "DivisionMarketId": { "format": "int32", "type": "integer" }, "DivisionMarketName": { "type": "string" } } }, "ContactRequestModel": { "required": [ "CompanyID", "AdSourceID" ], "type": "object", "properties": { "First": { "type": "string" }, "Last": { "type": "string" }, "Middle": { "type": "string" }, "CompanyID": { "format": "int32", "type": "integer" }, "AdSourceID": { "format": "int32", "type": "integer" }, "AdSourceAdditionalInfo": { "type": "string" }, "NamePrefix": { "type": "string" }, "NameSuffix": { "type": "string" }, "Title": { "type": "string" }, "InvoiceModeID": { "format": "int32", "type": "integer" }, "TypeID": { "format": "int32", "type": "integer" }, "RoleID": { "format": "int32", "type": "integer" }, "AddressID": { "format": "int64", "type": "integer" }, "StatusID": { "format": "int32", "type": "integer" } } }, "ContactFilterRequest": { "type": "object", "properties": { "CompanyId": { "format": "int32", "type": "integer" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "StatusIds": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "CustomFieldId": { "format": "int32", "type": "integer" }, "CustomFieldValue": { "type": "string" }, "PageSize": { "format": "int32", "type": "integer" }, "Page": { "format": "int32", "type": "integer" } } }, "PagedContactResponse": { "type": "object", "properties": { "Contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResponse" } }, "TotalResults": { "format": "int32", "type": "integer" }, "PageNumber": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" } } }, "CredentialingRequestStatusResponse": { "type": "object", "properties": { "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" }, "StatusUpdatedDate": { "format": "date-time", "type": "string" } } }, "CredentialingRequestResponse": { "type": "object", "properties": { "AboutType": { "type": "string", "readOnly": true }, "ID": { "format": "int64", "type": "integer" }, "CandidateID": { "format": "int32", "type": "integer" }, "CompanyID": { "format": "int32", "type": "integer" }, "FacilityDepartmentID": { "format": "int32", "type": "integer" }, "TargetStartDate": { "format": "date-time", "type": "string" }, "StatusID": { "format": "int32", "type": "integer" }, "FolderGroupID": { "format": "int32", "type": "integer" }, "RejectionReason": { "type": "string" }, "RejectionNote": { "type": "string" }, "CreatedDate": { "format": "date-time", "type": "string" }, "OwnerID": { "type": "string" }, "_expanded": { "type": "object", "properties": { "Candidate": { "$ref": "#/components/schemas/CandidateResponse" }, "Company": { "$ref": "#/components/schemas/CompanyResponse" }, "CompanyDepartment": { "$ref": "#/components/schemas/CompanyDepartmentResponse" }, "FolderGroup": { "$ref": "#/components/schemas/FolderGroupResponse" }, "Status": { "$ref": "#/components/schemas/CredentialingRequestStatusResponse" }, "Owner": { "$ref": "#/components/schemas/NamedValue" }, "CandidateOwner": { "$ref": "#/components/schemas/NamedValue" }, "DivisionInfo": { "$ref": "#/components/schemas/CompanyDivisionDto" } } }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "Vendor" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/Vendor/VendorOwnership/{candidateId}", "rel": "Vendor" } ] } } }, "FolderGroupResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "SubcategoryID": { "format": "int32", "type": "integer" }, "CategoryID": { "format": "int32", "type": "integer" }, "_expanded": { "type": "object", "properties": { "SubCategory": { "$ref": "#/components/schemas/FolderGroupSubCategoryResponse" } } }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "Category" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/FolderGroup/Category/{Id}", "rel": "Category" } ] } } }, "CredentialingRequestFilterRequest": { "type": "object", "properties": { "CandidateID": { "format": "int32", "type": "integer" }, "CredentialingRequestID": { "format": "int64", "type": "integer" }, "CompanyIDs": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "StatusIDs": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "FolderGroupID": { "format": "int32", "type": "integer" }, "DivisionMarketID": { "format": "int32", "type": "integer" }, "Vendor": { "format": "int32", "type": "integer" }, "CandidateOwner": { "format": "int32", "type": "integer" }, "Owner": { "format": "int32", "type": "integer" }, "PageSize": { "format": "int32", "type": "integer" }, "Page": { "format": "int32", "type": "integer" }, "Order": { "enum": [ "Descending", "Ascending" ], "type": "string" }, "SortBy": { "enum": [ "Id", "CandidateFirstName", "CandidateLastName", "Company", "FolderGroup", "Status", "StatusChangedDate", "DivisionName" ], "type": "string" } } }, "PagedCredentialingRequestResponse": { "type": "object", "properties": { "CredentialingRequests": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialingRequestResponse" } }, "TotalResults": { "format": "int32", "type": "integer" }, "PageNumber": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" } } }, "CredentialingRequestRequirementsResponse": { "type": "object", "properties": { "Complete": { "format": "int32", "type": "integer" }, "ID": { "format": "int64", "type": "integer" }, "Incomplete": { "format": "int32", "type": "integer" }, "OnboardingComplete": { "format": "int32", "type": "integer" }, "OnboardingIncomplete": { "format": "int32", "type": "integer" }, "StatusID": { "format": "int32", "type": "integer" }, "_expanded": { "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/CredentialingRequestStatusResponse" }, "CompleteRequirements": { "$ref": "#/components/schemas/SimpleRequirementResponse" }, "IncompleteRequirements": { "$ref": "#/components/schemas/SimpleIncompleteRequirementResponse" } } } } }, "SimpleRequirementResponse": { "type": "object", "properties": { "Name": { "type": "string" }, "ObjectRequirementID": { "format": "int32", "type": "integer" }, "RequirementID": { "format": "int32", "type": "integer" }, "StatusID": { "format": "int32", "type": "integer" }, "StatusName": { "type": "string" }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "Attachment" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/Attachment/{AboutType}/{Id}", "rel": "Attachment" } ] } } }, "SimpleIncompleteRequirementResponse": { "type": "object", "properties": { "IncompleteReason": { "type": "string" }, "Name": { "type": "string" }, "ObjectRequirementID": { "format": "int32", "type": "integer" }, "RequirementID": { "format": "int32", "type": "integer" }, "StatusID": { "format": "int32", "type": "integer" }, "StatusName": { "type": "string" } } }, "CredentialingRequestCreateRequest": { "required": [ "CandidateID", "FacilityDepartmentID", "FolderGroupID", "UserID", "CredentialingRequestType" ], "type": "object", "properties": { "CandidateID": { "format": "int32", "type": "integer" }, "FacilityDepartmentID": { "format": "int32", "type": "integer" }, "FolderGroupID": { "format": "int32", "type": "integer" }, "UserID": { "type": "string" }, "CredentialingRequestType": { "enum": [ "General" ], "type": "string" }, "PositionTypeId": { "format": "int32", "type": "integer" }, "TargetStartDate": { "format": "date-time", "type": "string" }, "OwnerID": { "type": "string" }, "CompanyID": { "format": "int32", "type": "integer" } } }, "CredentialingRequestRejectRequest": { "type": "object", "properties": { "RejectionReasonID": { "format": "int32", "type": "integer" }, "RejectionReasonNote": { "type": "string" } } }, "CustomFieldResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "AppliesTo": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" }, "FieldType": { "type": "string" }, "PossibleValues": { "type": "array", "items": { "type": "string" } }, "RemoteListUrl": { "type": "string" }, "DefaultValue": { "type": "string" }, "IsRequired": { "type": "boolean" } } }, "CustomFieldValueResponse": { "required": [ "Value" ], "type": "object", "properties": { "Value": { "type": "string" }, "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" } } }, "EducationResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "ReferenceType": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" }, "ReferenceID": { "format": "int64", "type": "integer" }, "SchoolName": { "type": "string" }, "GraduationYear": { "format": "int32", "type": "integer" }, "GPA": { "format": "double", "type": "number" }, "Majors": { "type": "string" }, "Minors": { "type": "string" }, "EducationLevelID": { "format": "int32", "type": "integer" }, "EducationLevel": { "type": "string" }, "AboutType": { "type": "string", "readOnly": true } } }, "EducationRequest": { "type": "object", "properties": { "SchoolName": { "type": "string" }, "GraduationYear": { "format": "int32", "type": "integer" }, "GPA": { "format": "double", "type": "number" }, "Majors": { "type": "string" }, "Minors": { "type": "string" }, "EducationLevelID": { "format": "int32", "type": "integer" } } }, "EEOCSupplement": { "type": "object", "properties": { "EthnicityID": { "format": "int32", "type": "integer" }, "Gender": { "enum": [ "Male", "Female", "Decline", "Other" ], "type": "string" }, "VeteranStatusID": { "format": "int32", "type": "integer" }, "DisabilityStatusID": { "format": "int32", "type": "integer" } } }, "EEOCListElement": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "DateOfBirthResponse": { "type": "object", "properties": { "DateOfBirth": { "format": "date-time", "type": "string" } } }, "FolderGroupStatusResponse": { "type": "object", "properties": { "ValidForAboutTypes": { "type": "array", "items": { "type": "string" } }, "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" } } }, "MatchResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "MatchedDate": { "format": "date-time", "type": "string" }, "DefaultAddressID": { "format": "int64", "type": "integer" }, "CandidateID": { "format": "int32", "type": "integer" }, "PositionID": { "format": "int32", "type": "integer" }, "FacilityCompany": { "format": "int32", "type": "integer" }, "Type": { "type": "string" }, "Status": { "type": "string" }, "StatusID": { "format": "int64", "type": "integer" }, "StatusSince": { "format": "date-time", "type": "string" }, "Grade": { "type": "string" }, "RejectedDate": { "format": "date-time", "type": "string" }, "RejectionReason": { "type": "string" }, "PayType": { "type": "string" }, "AboutType": { "type": "string", "readOnly": true }, "_expanded": { "type": "object", "properties": { "Company": { "$ref": "#/components/schemas/CompanyResponse" }, "Position": { "$ref": "#/components/schemas/PositionResponse" }, "Candidate": { "$ref": "#/components/schemas/CandidateResponse" }, "DefaultAddress": { "$ref": "#/components/schemas/AddressResponse" } } }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "Credit" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/Match/{Id}/Credits", "rel": "Credit" } ] } } }, "MatchCreditsResponse": { "type": "object", "properties": { "ID": { "format": "int64", "type": "integer" }, "MatchID": { "format": "int32", "type": "integer" }, "RecruiterID": { "type": "string" }, "DepartmentID": { "format": "int64", "type": "integer" }, "CreditTypeID": { "format": "int64", "type": "integer" }, "CreditPercentage": { "format": "double", "type": "number" }, "CommissionBase": { "format": "double", "type": "number" }, "CommisionCoefficient": { "format": "double", "type": "number" }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "Department" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/Department/{Id}", "rel": "Department" } ] } } }, "NoteResponse": { "type": "object", "properties": { "NoteID": { "format": "int64", "type": "integer" }, "CreatedOn": { "format": "date-time", "type": "string" }, "Body": { "type": "string" }, "NoteActionID": { "format": "int32", "type": "integer" }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "Reference" ], "type": "string" } } }, "example": [ { "rel": "Reference" } ] } } }, "NoteRequest": { "type": "object", "properties": { "Records": { "type": "array", "items": { "$ref": "#/components/schemas/RecordReference" } }, "NoteBody": { "type": "string" }, "NoteActionID": { "format": "int32", "type": "integer" } } }, "NoteLinkRequest": { "type": "object", "properties": { "Records": { "type": "array", "items": { "$ref": "#/components/schemas/RecordReference" } } } }, "OnboardingResponse": { "type": "object", "properties": { "OnboardingID": { "type": "string" }, "Status": { "type": "string" }, "DateStarted": { "format": "date-time", "type": "string" }, "SyncDate": { "format": "date-time", "type": "string" } } }, "OnboardingProgressResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "CandidateProgressComplete": { "format": "int32", "type": "integer" }, "CandidateProgressIncomplete": { "format": "int32", "type": "integer" }, "HRProgressComplete": { "format": "int32", "type": "integer" }, "HRProgressIncomplete": { "format": "int32", "type": "integer" }, "TotalComplete": { "format": "int32", "type": "integer" }, "TotalIncomplete": { "format": "int32", "type": "integer" }, "StatusID": { "format": "int32", "type": "integer" } } }, "OpportunityRequest": { "required": [ "AdSourceID", "TypeID" ], "type": "object", "properties": { "Name": { "type": "string" }, "Summary": { "type": "string" }, "AdSourceID": { "format": "int32", "type": "integer" }, "AdSourceAdditionalInfo": { "type": "string" }, "CompanyID": { "format": "int32", "type": "integer" }, "ContactID": { "format": "int32", "type": "integer" }, "TempCount": { "format": "int32", "type": "integer" }, "TempToHireCount": { "format": "int32", "type": "integer" }, "DirectHireCount": { "format": "int32", "type": "integer" }, "PayrollCount": { "format": "int32", "type": "integer" }, "HourlyGrossProfit": { "format": "int32", "type": "integer" }, "HoursOnAssignment": { "format": "double", "type": "number" }, "RatingID": { "format": "int32", "type": "integer" }, "TypeID": { "format": "int32", "type": "integer" }, "Currency": { "type": "string" } } }, "OpportunityResponse": { "type": "object", "properties": { "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "CompanyID": { "format": "int32", "type": "integer" }, "ContactID": { "format": "int32", "type": "integer" }, "AdSource": { "type": "string" }, "CreatedOn": { "format": "date-time", "type": "string" }, "TempCount": { "format": "int32", "type": "integer" }, "TempToHireCount": { "format": "int32", "type": "integer" }, "DirectHireCount": { "format": "int32", "type": "integer" }, "PayrollCount": { "format": "int32", "type": "integer" }, "HourlyGrossProfit": { "format": "double", "type": "number" }, "HoursOnAssignment": { "format": "double", "type": "number" }, "DirectHireFee": { "format": "double", "type": "number" }, "CloseReason": { "format": "int32", "type": "integer" }, "RatingID": { "format": "int32", "type": "integer" }, "TypeID": { "format": "int32", "type": "integer" }, "AboutType": { "type": "string", "readOnly": true }, "_expanded": { "type": "object", "properties": { "Company": { "$ref": "#/components/schemas/CompanyResponse" }, "Contact": { "$ref": "#/components/schemas/ContactResponse" }, "Rating": { "$ref": "#/components/schemas/NamedValue" }, "Reason": { "$ref": "#/components/schemas/NamedValue" }, "Type": { "$ref": "#/components/schemas/NamedValue" } } }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "AdSource", "Notes" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/AdSource/{AboutType}/{Id}", "rel": "AdSource" }, { "href": "https://erecruit.nelsonstaffing.com/WebApi/Note/{AboutType}/{Id}", "rel": "Notes" } ] } } }, "OwnerPatchRequest": { "required": [ "RecruiterID" ], "type": "object", "properties": { "RecruiterID": { "format": "int32", "type": "integer" }, "AdditionalOwnerTypeID": { "format": "int32", "type": "integer" }, "DemoteCurrentPrimary": { "type": "boolean" } } }, "OwnerRequest": { "required": [ "RecruiterID", "AdditionalOwnerTypeID" ], "type": "object", "properties": { "RecruiterID": { "format": "int32", "type": "integer" }, "AdditionalOwnerTypeID": { "format": "int32", "type": "integer" } } }, "PositionRequest": { "required": [ "CompanyID", "PositionTypeID", "AdSourceID", "FolderGroupID" ], "type": "object", "properties": { "CompanyID": { "format": "int32", "type": "integer" }, "CompanyName": { "type": "string" }, "ContactID": { "format": "int32", "type": "integer" }, "NumberOfPositions": { "format": "int32", "type": "integer" }, "ExternalPositionID": { "type": "string" }, "PositionStatusID": { "format": "int32", "type": "integer" }, "PositionTypeID": { "format": "int32", "type": "integer" }, "Title": { "type": "string" }, "Description": { "type": "string" }, "GeneralComments": { "type": "string" }, "StartDate": { "format": "date-time", "type": "string" }, "EndDate": { "format": "date-time", "type": "string" }, "MinBillRate": { "format": "double", "type": "number" }, "MaxBillRate": { "format": "double", "type": "number" }, "MinPayRate": { "format": "double", "type": "number" }, "MaxPayRate": { "format": "double", "type": "number" }, "MaxNumberOfSubmittals": { "format": "int32", "type": "integer" }, "StartTime": { "type": "string" }, "EndTime": { "type": "string" }, "IsVMS": { "type": "boolean" }, "DefaultVendorRateMarkupPercentage": { "format": "double", "type": "number" }, "AdSourceID": { "format": "int32", "type": "integer" }, "AdSourceAdditionalInfo": { "type": "string" }, "FolderGroupID": { "format": "int32", "type": "integer" }, "PrimaryDepartmentID": { "format": "int32", "type": "integer" }, "DefaultAddressID": { "format": "int64", "type": "integer" }, "UseCompanyAddress": { "type": "boolean" } } }, "PostedPositionResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "PositionTitle": { "type": "string" }, "PositionType": { "type": "string" }, "FolderGroup": { "$ref": "#/components/schemas/PostedPositionFolderGroup" }, "CompanyName": { "type": "string" }, "CompanyID": { "format": "int64", "type": "integer" }, "DatePosted": { "format": "date-time", "type": "string" }, "DateLastOpened": { "format": "date-time", "type": "string" }, "ReplyToEmail": { "type": "string" }, "HourlyMin": { "format": "double", "type": "number" }, "HourlyMax": { "format": "double", "type": "number" }, "AnnualMin": { "format": "double", "type": "number" }, "AnnualMax": { "format": "double", "type": "number" }, "Citizenship": { "type": "string" }, "YearsExperience": { "type": "string" }, "RecruiterName": { "type": "string" }, "WebPositionTitle": { "type": "string" }, "WebDescription": { "type": "string" }, "WebMin": { "format": "double", "type": "number" }, "WebMax": { "format": "double", "type": "number" }, "PrimaryOwnerID": { "type": "string" }, "Rating": { "format": "int32", "type": "integer" }, "Department": { "$ref": "#/components/schemas/PostedPositionDepartment" }, "CustomFields": { "type": "array", "items": { "$ref": "#/components/schemas/PostedCustomFieldValue" } }, "PrimaryAddress": { "$ref": "#/components/schemas/PostedPositionAddress" } } }, "PostedPositionFolderGroup": { "type": "object", "properties": { "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" }, "CategoryID": { "format": "int32", "type": "integer" }, "CategoryName": { "type": "string" }, "SubCategoryID": { "format": "int32", "type": "integer" }, "SubCategoryName": { "type": "string" } } }, "PostedPositionDepartment": { "type": "object", "properties": { "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" }, "Phone": { "type": "string" }, "Fax": { "type": "string" }, "Address": { "$ref": "#/components/schemas/PostedPositionAddress" } } }, "PostedCustomFieldValue": { "type": "object", "properties": { "Name": { "type": "string" }, "FieldID": { "format": "int32", "type": "integer" }, "TypeID": { "format": "int32", "type": "integer" }, "TypeName": { "type": "string" }, "ID": { "format": "int64", "type": "integer" }, "Value": { "type": "string" } } }, "PostedPositionAddress": { "type": "object", "properties": { "City": { "type": "string" }, "State": { "type": "string" }, "Country": { "type": "string" }, "PostalCode": { "type": "string" }, "Latitude": { "format": "double", "type": "number" }, "Longitude": { "format": "double", "type": "number" }, "Region": { "type": "string" }, "AddressLine1": { "type": "string" }, "AddressLine2": { "type": "string" } } }, "PositionTemplateResponse": { "type": "object", "properties": { "PositionTemplateID": { "format": "int32", "type": "integer" }, "PositionType": { "type": "string" }, "PositionTitle": { "type": "string" }, "PositionDescription": { "type": "string" }, "GeneralComments": { "type": "string" }, "FolderGroup": { "$ref": "#/components/schemas/NamedValue" }, "WorkersComp": { "$ref": "#/components/schemas/WorkersCompResponse" } } }, "WorkersCompResponse": { "type": "object", "properties": { "Rate": { "format": "double", "type": "number" }, "EffectiveDate": { "format": "date-time", "type": "string" } } }, "ObjectRelationshipType": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "IsEnabled": { "type": "boolean" }, "IsDirectional": { "type": "boolean" }, "ParentToChildFormatString": { "type": "string" }, "ChildToParentFormatString": { "type": "string" }, "MaxOccurrenceAsParent": { "format": "int32", "type": "integer" }, "MaxOccurrenceAsChild": { "format": "int32", "type": "integer" } } }, "RelationshipRequest": { "type": "object", "properties": { "TypeID": { "format": "int64", "type": "integer" }, "AboutTypeFrom": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" }, "AboutTypeTo": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" }, "ReferenceIDFrom": { "format": "int64", "type": "integer" }, "ReferenceIDTo": { "format": "int64", "type": "integer" }, "Comments": { "type": "string" }, "CreatedAutomatically": { "type": "boolean" } } }, "RelationshipResponse": { "type": "object", "properties": { "ID": { "format": "int64", "type": "integer" }, "Type": { "$ref": "#/components/schemas/ObjectRelationshipType" }, "AboutTypeFrom": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" }, "ReferenceIDFrom": { "format": "int32", "type": "integer" }, "AboutTypeTo": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" }, "ReferenceIDTo": { "format": "int32", "type": "integer" } } }, "ObjectRequirementResponse": { "type": "object", "properties": { "AboutType": { "type": "string" }, "ReferencedID": { "format": "int64", "type": "integer" }, "ID": { "format": "int32", "type": "integer" }, "StatusID": { "format": "int64", "type": "integer" }, "EffectiveDate": { "format": "date-time", "type": "string" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "Note": { "type": "string" }, "ReferenceNote": { "type": "string" }, "OwnerID": { "type": "string" }, "OwnerUserName": { "type": "string" }, "PriorityID": { "format": "int64", "type": "integer" }, "BurdenPerHour": { "format": "double", "type": "number" }, "BurdenPerTimesheet": { "format": "double", "type": "number" }, "BurdenBilledPercent": { "format": "double", "type": "number" }, "BurdenPaidPercent": { "format": "double", "type": "number" }, "BurdenOneTime": { "format": "double", "type": "number" }, "PassingPercentage": { "format": "double", "type": "number" }, "ExpirationHeadWarningDays": { "format": "int32", "type": "integer" }, "States": { "type": "array", "items": { "$ref": "#/components/schemas/StateInfo" } }, "IsIgnored": { "type": "boolean" }, "RejectReasonID": { "format": "int32", "type": "integer" }, "RejectReasonName": { "type": "string" }, "IssueDate": { "format": "date-time", "type": "string" }, "CompanyId": { "format": "int32", "type": "integer" }, "CompanyName": { "type": "string" }, "_expanded": { "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/ObjectRequirementStatusResponse" }, "Priority": { "$ref": "#/components/schemas/RequirementPriorityResponse" }, "IntegrationPartner": { "$ref": "#/components/schemas/IntegrationPartnerResponse" }, "IntegrationProvider": { "$ref": "#/components/schemas/IntegrationProviderResponse" }, "IntegrationPackage": { "$ref": "#/components/schemas/IntegrationPackageResponse" }, "IntegrationService": { "$ref": "#/components/schemas/IntegrationServiceResponse" }, "Requirements": { "$ref": "#/components/schemas/RequirementResponse" } } }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "Attachment", "CustomFields" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/Attachment/{AboutType}/{Id}", "rel": "Attachment" }, { "href": "https://erecruit.nelsonstaffing.com/WebApi/CustomField/{AboutType}/{Id}", "rel": "CustomFields" } ] } } }, "StateInfo": { "type": "object", "properties": { "State": { "type": "string" }, "StateCode": { "type": "string" }, "Country": { "type": "string" }, "CountryCode": { "type": "string" } } }, "ObjectRequirementStatusResponse": { "type": "object", "properties": { "IsConfirmed": { "type": "boolean" }, "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" } } }, "RequirementPriorityResponse": { "type": "object", "properties": { "IsDefault": { "type": "boolean" }, "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" } } }, "IntegrationPartnerResponse": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" } } }, "IntegrationProviderResponse": { "type": "object", "properties": { "ExternalID": { "type": "string" }, "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" } } }, "IntegrationPackageResponse": { "type": "object", "properties": { "ExternalID": { "type": "string" }, "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" } } }, "IntegrationServiceResponse": { "type": "object", "properties": { "ExternalID": { "type": "string" }, "ID": { "format": "int64", "type": "integer" }, "Name": { "type": "string" } } }, "RequirementResponse": { "type": "object", "properties": { "EntityIDs": { "type": "array", "items": { "type": "string" } }, "ID": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "CompanyID": { "format": "int32", "type": "integer" }, "Type": { "type": "string" }, "MandatoryForFullPlacement": { "type": "boolean" }, "MandatoryForSubmittal": { "type": "boolean" }, "MandatoryForTimesheetSubmission": { "type": "boolean" }, "MandatoryForAgency": { "type": "boolean" }, "Weight": { "format": "int32", "type": "integer" }, "RequiresOffboarding": { "type": "boolean" }, "ExpirationDateRequired": { "type": "boolean" }, "EffectiveDateRequired": { "type": "boolean" }, "StateSpecific": { "type": "boolean" }, "StateRequired": { "type": "boolean" }, "TargetAboutType": { "type": "string" }, "_expanded": { "type": "object", "properties": { "Company": { "$ref": "#/components/schemas/CompanyResponse" }, "Statuses": { "$ref": "#/components/schemas/ObjectRequirementStatusResponse" } } } } }, "ObjectRequirementFilterRequest": { "type": "object", "properties": { "RequirementID": { "format": "int32", "type": "integer" }, "StatusIDs": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "IsExpired": { "type": "boolean" }, "CandidateOwnerID": { "format": "int32", "type": "integer" }, "CandidateStatusID": { "format": "int32", "type": "integer" }, "RequirementTypeID": { "format": "int32", "type": "integer" }, "CandidateVendorCompanyID": { "format": "int32", "type": "integer" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "IsIgnored": { "type": "boolean" } } }, "ObjectRequirementUpdateRequest": { "required": [ "UserID" ], "type": "object", "properties": { "ConfirmedBy": { "type": "string" }, "ConfirmedDate": { "format": "date-time", "type": "string" }, "ExpirationWarningDays": { "format": "int32", "type": "integer" }, "InitiatedBy": { "type": "string" }, "IsBurdenBilledPercentSet": { "type": "boolean" }, "IsBurdenOneTimeSet": { "type": "boolean" }, "IsBurdenPaidPercentSet": { "type": "boolean" }, "IsBurdenPerHourSet": { "type": "boolean" }, "IsBurdenPerTimesheetSet": { "type": "boolean" }, "IsConfirmedBySet": { "type": "boolean" }, "IsConfirmedDateSet": { "type": "boolean" }, "IsEffectiveDateSet": { "type": "boolean" }, "IsExpirationDateSet": { "type": "boolean" }, "IsExpirationWarningDaysSet": { "type": "boolean" }, "IsInitiatedBySet": { "type": "boolean" }, "IsIssueDateSet": { "type": "boolean" }, "IsMarkedIgnoredBySet": { "type": "boolean" }, "IsMarkedIgnoredOnSet": { "type": "boolean" }, "IsNoteSet": { "type": "boolean" }, "IsOwnerIDSet": { "type": "boolean" }, "IsReferenceSet": { "type": "boolean" }, "IsRejectionReasonIDSet": { "type": "boolean" }, "IsRejectionReasonNoteSet": { "type": "boolean" }, "IsRequiredFromSet": { "type": "boolean" }, "IsRequiredToSet": { "type": "boolean" }, "IsRequirementSpecificReferenceNumberSet": { "type": "boolean" }, "IsRequirementSpecificStatusSet": { "type": "boolean" }, "IsStatusReasonSet": { "type": "boolean" }, "IssueDate": { "format": "date-time", "type": "string" }, "IsTierIDSet": { "type": "boolean" }, "MarkedIgnoredBy": { "type": "string" }, "MarkedIgnoredOn": { "format": "date-time", "type": "string" }, "OwnerID": { "type": "string" }, "RejectionReasonID": { "format": "int32", "type": "integer" }, "RejectionReasonNote": { "type": "string" }, "RequirementSpecificReferenceNumber": { "type": "string" }, "RequirementSpecificStatus": { "type": "string" }, "StatusID": { "format": "int32", "type": "integer" }, "StatusReason": { "type": "string" }, "AttachmentID": { "type": "string" }, "BurdenBilledPercent": { "format": "double", "type": "number" }, "BurdenOneTime": { "format": "double", "type": "number" }, "BurdenPaidPercent": { "format": "double", "type": "number" }, "BurdenPerHour": { "format": "double", "type": "number" }, "BurdenPerTimesheet": { "format": "double", "type": "number" }, "CompanyDepartmentIDs": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "EffectiveDate": { "format": "date-time", "type": "string" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "FolderGroupSubcategoryIDs": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "FolderGroupIDs": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "IntegrationPackageId": { "format": "int32", "type": "integer" }, "IntegrationProviderId": { "format": "int32", "type": "integer" }, "IntegrationResultUrl": { "type": "string" }, "IntegrationServiceId": { "format": "int32", "type": "integer" }, "IsIntegrationPackageIdSet": { "type": "boolean" }, "IsIntegrationProviderIdSet": { "type": "boolean" }, "IsIntegrationResultUrlSet": { "type": "boolean" }, "IsIntegrationServiceIdSet": { "type": "boolean" }, "IsMandatoryForAgency": { "type": "boolean" }, "IsMandatoryForFullPlacement": { "type": "boolean" }, "IsMandatoryForSubmittal": { "type": "boolean" }, "IsMandatoryForTimesheetSubmission": { "type": "boolean" }, "IsPassingPercentageSet": { "type": "boolean" }, "IsPercentageSet": { "type": "boolean" }, "IsScoreSet": { "type": "boolean" }, "IsTotalScoreSet": { "type": "boolean" }, "Note": { "type": "string" }, "PassingPercentage": { "format": "double", "type": "number" }, "Percentage": { "format": "double", "type": "number" }, "PriorityID": { "format": "int32", "type": "integer" }, "Reference": { "type": "string" }, "RequiredFrom": { "format": "date-time", "type": "string" }, "RequiredTo": { "format": "date-time", "type": "string" }, "Score": { "format": "int32", "type": "integer" }, "StateIDs": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "TierID": { "format": "int32", "type": "integer" }, "TotalScore": { "format": "int32", "type": "integer" }, "UserID": { "type": "string" }, "UsesStateGroup": { "type": "boolean" } } }, "ObjectRequirementCreateRequest": { "required": [ "AboutTypeID", "ReferenceID", "RequirementID", "UserID" ], "type": "object", "properties": { "AboutTypeID": { "format": "int32", "type": "integer" }, "AddToHierarchy": { "type": "boolean" }, "ReferenceID": { "format": "int64", "type": "integer" }, "RequirementID": { "format": "int32", "type": "integer" }, "TemplateID": { "format": "int32", "type": "integer" }, "AttachmentID": { "type": "string" }, "BurdenBilledPercent": { "format": "double", "type": "number" }, "BurdenOneTime": { "format": "double", "type": "number" }, "BurdenPaidPercent": { "format": "double", "type": "number" }, "BurdenPerHour": { "format": "double", "type": "number" }, "BurdenPerTimesheet": { "format": "double", "type": "number" }, "CompanyDepartmentIDs": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "EffectiveDate": { "format": "date-time", "type": "string" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "FolderGroupSubcategoryIDs": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "FolderGroupIDs": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "IntegrationPackageId": { "format": "int32", "type": "integer" }, "IntegrationProviderId": { "format": "int32", "type": "integer" }, "IntegrationResultUrl": { "type": "string" }, "IntegrationServiceId": { "format": "int32", "type": "integer" }, "IsIntegrationPackageIdSet": { "type": "boolean" }, "IsIntegrationProviderIdSet": { "type": "boolean" }, "IsIntegrationResultUrlSet": { "type": "boolean" }, "IsIntegrationServiceIdSet": { "type": "boolean" }, "IsMandatoryForAgency": { "type": "boolean" }, "IsMandatoryForFullPlacement": { "type": "boolean" }, "IsMandatoryForSubmittal": { "type": "boolean" }, "IsMandatoryForTimesheetSubmission": { "type": "boolean" }, "IsPassingPercentageSet": { "type": "boolean" }, "IsPercentageSet": { "type": "boolean" }, "IsScoreSet": { "type": "boolean" }, "IsTotalScoreSet": { "type": "boolean" }, "Note": { "type": "string" }, "PassingPercentage": { "format": "double", "type": "number" }, "Percentage": { "format": "double", "type": "number" }, "PriorityID": { "format": "int32", "type": "integer" }, "Reference": { "type": "string" }, "RequiredFrom": { "format": "date-time", "type": "string" }, "RequiredTo": { "format": "date-time", "type": "string" }, "Score": { "format": "int32", "type": "integer" }, "StateIDs": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "TierID": { "format": "int32", "type": "integer" }, "TotalScore": { "format": "int32", "type": "integer" }, "UserID": { "type": "string" }, "UsesStateGroup": { "type": "boolean" } } }, "IntegrationStatusResponse": { "type": "object", "properties": { "ErrorStatusId": { "format": "int32", "type": "integer" }, "FailStatusId": { "format": "int32", "type": "integer" }, "InitiatedStatusId": { "format": "int32", "type": "integer" }, "PassStatusId": { "format": "int32", "type": "integer" }, "ProcessingStatusId": { "format": "int32", "type": "integer" }, "ReviewStatusId": { "format": "int32", "type": "integer" }, "InProgressStatusId": { "format": "int32", "type": "integer" } } }, "ScheduledItemRequest": { "type": "object", "properties": { "Records": { "type": "array", "items": { "$ref": "#/components/schemas/RecordReference" } }, "NoteBody": { "type": "string" }, "CreatedBy": { "type": "string" }, "Assignee": { "type": "string" }, "NoteActionID": { "format": "int32", "type": "integer" }, "EndTime": { "format": "date-time", "type": "string" }, "Priority": { "format": "int32", "type": "integer" }, "ScheduledItemTypeID": { "format": "int32", "type": "integer" }, "ScheduledItemCategoryID": { "format": "int32", "type": "integer" }, "StartDate": { "format": "date-time", "type": "string" }, "StatusID": { "format": "int32", "type": "integer" }, "Subject": { "type": "string" }, "DefaultReferenceID": { "format": "int64", "type": "integer" }, "DefaultReferenceAboutType": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" } } }, "ScheduledItemResponse": { "type": "object", "properties": { "ScheduledItemID": { "format": "int64", "type": "integer" }, "NoteBody": { "type": "string" }, "CreatedBy": { "type": "string" }, "Assignee": { "type": "string" }, "NoteActionID": { "format": "int32", "type": "integer" }, "Priority": { "format": "int32", "type": "integer" }, "ScheduledItemTypeID": { "format": "int32", "type": "integer" }, "ScheduledItemCategoryID": { "format": "int32", "type": "integer" }, "StartDate": { "format": "date-time", "type": "string" }, "StatusID": { "format": "int32", "type": "integer" }, "Subject": { "type": "string" }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "Reference" ], "type": "string" } } }, "example": [ { "rel": "Reference" } ] } } }, "SeedResponse": { "type": "object", "properties": { "ID": { "format": "int64", "type": "integer" }, "AboutType": { "type": "string", "readOnly": true }, "ExpectedHarvestType": { "enum": [ "Candidate", "Company", "Contact", "Opportunity", "Position" ], "type": "string" }, "First": { "type": "string" }, "Middle": { "type": "string" }, "Last": { "type": "string" }, "NickName": { "type": "string" }, "Title": { "type": "string" }, "Gender": { "enum": [ "Male", "Female", "Decline", "Other" ], "type": "string" }, "CurrentSalary": { "format": "double", "type": "number" }, "RequestedSalary": { "format": "double", "type": "number" }, "WillingToTravel": { "type": "boolean" }, "WillingToRelocate": { "type": "boolean" }, "DateAvailable": { "format": "date-time", "type": "string" }, "CompanyName": { "type": "string" }, "TotalRevenue": { "format": "double", "type": "number" }, "NumberOfEmployees": { "format": "int32", "type": "integer" }, "YearsEstablished": { "format": "int32", "type": "integer" }, "SourceURL": { "type": "string" }, "HarvestDate": { "format": "date-time", "type": "string" }, "Type": { "type": "string" }, "Status": { "type": "string" }, "AdSource": { "type": "string" }, "_expanded": { "type": "object", "properties": { "Company": { "$ref": "#/components/schemas/CompanyResponse" }, "Bio": { "$ref": "#/components/schemas/TextResponse" }, "Notes": { "$ref": "#/components/schemas/TextResponse" }, "Resume": { "$ref": "#/components/schemas/TextResponse" } } }, "_links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "enum": [ "AdSource" ], "type": "string" } } }, "example": [ { "href": "https://erecruit.nelsonstaffing.com/WebApi/AdSource/{AboutType}/{Id}", "rel": "AdSource" } ] } } }, "SeedRequest": { "required": [ "TypeID", "AdSourceID" ], "type": "object", "properties": { "ExpectedHarvestType": { "enum": [ "Candidate", "Company", "Contact", "Opportunity", "Position" ], "type": "string" }, "First": { "type": "string" }, "Middle": { "type": "string" }, "Last": { "type": "string" }, "NickName": { "type": "string" }, "Title": { "type": "string" }, "Gender": { "enum": [ "Male", "Female", "Decline", "Other" ], "type": "string" }, "CurrentSalary": { "format": "double", "type": "number" }, "RequestedSalary": { "format": "double", "type": "number" }, "WillingToTravel": { "type": "boolean" }, "WillingToRelocate": { "type": "boolean" }, "DateAvailable": { "format": "date-time", "type": "string" }, "CompanyName": { "type": "string" }, "TotalRevenue": { "format": "double", "type": "number" }, "NumberOfEmployees": { "format": "int32", "type": "integer" }, "YearsEstablished": { "format": "int32", "type": "integer" }, "SourceURL": { "type": "string" }, "CompanyID": { "format": "int32", "type": "integer" }, "TypeID": { "format": "int32", "type": "integer" }, "AdSourceID": { "format": "int32", "type": "integer" }, "AdSourceAdditionalInfo": { "type": "string" }, "AssignTo": { "type": "string" } } }, "ShiftResponse": { "required": [ "AboutType", "Id", "Name", "CreatedOn", "Start", "End", "Status", "Company", "FacilityDepartment", "FolderGroup" ], "type": "object", "properties": { "AboutType": { "type": "string", "readOnly": true }, "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "CreatedOn": { "format": "date-time", "type": "string" }, "Start": { "format": "date-time", "type": "string" }, "End": { "format": "date-time", "type": "string" }, "Status": { "$ref": "#/components/schemas/NamedValue" }, "MatchID": { "format": "int64", "type": "integer" }, "MatchStatus": { "type": "string" }, "Candidate": { "$ref": "#/components/schemas/NamedValue" }, "Position": { "$ref": "#/components/schemas/NamedValue" }, "Company": { "$ref": "#/components/schemas/NamedValue" }, "FacilityDepartment": { "$ref": "#/components/schemas/NamedValue" }, "FolderGroup": { "$ref": "#/components/schemas/NamedValue" }, "ShiftType": { "$ref": "#/components/schemas/NamedValue" }, "Cancelations": { "type": "array", "items": { "$ref": "#/components/schemas/NamedValue" } } } }, "ShiftRequest": { "required": [ "FacilityDepartmentId", "FolderGroupId", "AboutType", "ReferenceId" ], "type": "object", "properties": { "FacilityDepartmentId": { "format": "int32", "type": "integer" }, "FolderGroupId": { "format": "int32", "type": "integer" }, "AboutType": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" }, "ReferenceId": { "format": "int32", "type": "integer" }, "Details": { "type": "array", "items": { "type": "object", "description": "ShiftRequestDetails (simplified to prevent deep circular reference)", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "properties": { "type": "object", "additionalProperties": true } } } } } }, "ShiftRequestDetails": { "required": [ "StartDateTime", "EndDateTime", "ShiftTypeId", "Description", "TargetRateId" ], "type": "object", "properties": { "StartDateTime": { "format": "date-time", "type": "string" }, "EndDateTime": { "format": "date-time", "type": "string" }, "ShiftTypeId": { "format": "int32", "type": "integer" }, "Description": { "type": "string" }, "Quantity": { "format": "int32", "type": "integer" }, "TargetRateId": { "format": "int32", "type": "integer" }, "Units": { "format": "int32", "type": "integer" }, "BonusPay": { "format": "double", "type": "number" }, "BonusBill": { "format": "double", "type": "number" }, "Note": { "type": "string" }, "ShiftStatusId": { "format": "int32", "type": "integer" } } }, "ShiftUpdateRequest": { "required": [ "Id", "StartDateTime", "EndDateTime" ], "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "StartDateTime": { "format": "date-time", "type": "string" }, "EndDateTime": { "format": "date-time", "type": "string" }, "ShiftStatusId": { "format": "int32", "type": "integer" }, "ShiftTypeId": { "format": "int32", "type": "integer" }, "BonusPay": { "format": "double", "type": "number" }, "BonusBill": { "format": "double", "type": "number" }, "Description": { "type": "string" } } }, "ShiftCancellationRequest": { "required": [ "Id", "CancellationReasonId" ], "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "CancellationReasonId": { "format": "int32", "type": "integer" }, "CancellationComments": { "type": "string" }, "AttributedAboutType": { "format": "int32", "type": "integer" }, "AttributedReferenceId": { "format": "int32", "type": "integer" } } }, "ShiftTypeResponse": { "required": [ "Id", "Name", "Description", "DefaultStatus", "TargetRate" ], "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "DefaultStatus": { "$ref": "#/components/schemas/NamedValue" }, "DefaultQuantity": { "format": "int32", "type": "integer" }, "DefaultStartTime": { "$ref": "#/components/schemas/Time" }, "DefaultEndTime": { "$ref": "#/components/schemas/Time" }, "TargetRate": { "$ref": "#/components/schemas/TargetRate" }, "DefaultUnits": { "format": "int32", "type": "integer" } } }, "Time": { "required": [ "Hours", "Minutes" ], "type": "object", "properties": { "Hours": { "format": "int32", "type": "integer" }, "Minutes": { "format": "int32", "type": "integer" } } }, "TargetRate": { "required": [ "Required" ], "type": "object", "properties": { "Required": { "type": "boolean" }, "TypeId": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "ShiftStatusResponse": { "required": [ "Id", "Name", "VisibleToContact", "VisibleToCandidate", "IsWorking" ], "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "MinimumMatchStatus": { "$ref": "#/components/schemas/NamedValue" }, "TimesheetLineStatus": { "$ref": "#/components/schemas/NamedValue" }, "UpdateTimesheet": { "type": "boolean" }, "VisibleToContact": { "type": "boolean" }, "VisibleToCandidate": { "type": "boolean" }, "IsWorking": { "type": "boolean" } } }, "TagResponse": { "type": "object", "properties": { "TagAssignmentId": { "format": "int64", "type": "integer" }, "TagId": { "format": "int64", "type": "integer" }, "TagName": { "type": "string" } } }, "TagRequest": { "type": "object", "properties": { "TagId": { "format": "int32", "type": "integer" } } }, "SimpleTagResponse": { "type": "object", "properties": { "TagId": { "format": "int64", "type": "integer" }, "TagName": { "type": "string" } } }, "TimesheetResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "StartDate": { "format": "date-time", "type": "string" }, "EndDate": { "format": "date-time", "type": "string" }, "PayPeriodEndDate": { "format": "date-time", "type": "string" }, "IsAdjustment": { "type": "boolean" }, "MatchID": { "format": "int32", "type": "integer" }, "SubmittedDate": { "format": "date-time", "type": "string" }, "ApprovedDate": { "format": "date-time", "type": "string" }, "RejectReasonID": { "format": "int64", "type": "integer" }, "_expanded": { "type": "object", "properties": { "Reason": { "$ref": "#/components/schemas/NamedValue" }, "Match": { "$ref": "#/components/schemas/MatchResponse" } } } } }, "ChangePasswordRequest": { "required": [ "EntityID", "NewPassword", "OldPassword", "UserName" ], "type": "object", "properties": { "EntityID": { "type": "string" }, "NewPassword": { "type": "string" }, "OldPassword": { "type": "string" }, "UserName": { "type": "string" } } }, "ChangeUsernameRequest": { "required": [ "EntityId", "NewUserName", "OldUserName", "Password" ], "type": "object", "properties": { "EntityId": { "type": "string" }, "NewUserName": { "type": "string" }, "OldUserName": { "type": "string" }, "Password": { "type": "string" } } }, "ChangePasswordByTokenRequest": { "required": [ "NewPassword", "Token", "UserName" ], "type": "object", "properties": { "EntityID": { "type": "string" }, "NewPassword": { "type": "string" }, "Token": { "type": "string" }, "UserName": { "type": "string" } } }, "PasswordResetTokenRequest": { "required": [ "ResetPasswordEmailTemplate", "UserName" ], "type": "object", "properties": { "EntityID": { "type": "string" }, "ResetPasswordEmailTemplate": { "type": "string" }, "UserName": { "type": "string" } } }, "ValidateCredentialsRequest": { "required": [ "Password", "UserName" ], "type": "object", "properties": { "EntityID": { "type": "string" }, "Password": { "type": "string" }, "UserName": { "type": "string" } } }, "ValidateCredentialsResponse": { "type": "object", "properties": { "CandidateID": { "format": "int32", "type": "integer" }, "ContactID": { "format": "int32", "type": "integer" }, "IsValid": { "type": "boolean" }, "RecruiterID": { "format": "int32", "type": "integer" }, "VendorCompanyID": { "format": "int32", "type": "integer" }, "UserId": { "type": "string" } } }, "VendorResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "NotificationEmail": { "type": "string" }, "DefaultAddressID": { "format": "int64", "type": "integer" }, "AboutType": { "type": "string", "readOnly": true }, "_expanded": { "type": "object", "properties": { "DefaultAddress": { "$ref": "#/components/schemas/AddressResponse" } } } } }, "VendorContactResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Title": { "type": "string" }, "DefaultPhoneNumber": { "type": "string" }, "DefaultEmailAddress": { "type": "string" }, "DefaultAddressID": { "format": "int64", "type": "integer" }, "AboutType": { "type": "string", "readOnly": true }, "VendorCompanyID": { "format": "int32", "type": "integer" }, "_expanded": { "type": "object", "properties": { "DefaultAddress": { "$ref": "#/components/schemas/AddressResponse" } } } } }, "VendorOwnershipResponse": { "type": "object", "properties": { "CandidateVendorOwnerId": { "format": "int32", "type": "integer" }, "CandidateVendorOwnerName": { "type": "string" }, "CandidateId": { "format": "int32", "type": "integer" } } }, "VendorCandidateShareResponse": { "type": "object", "properties": { "CandidateId": { "format": "int32", "type": "integer" }, "IsShared": { "type": "boolean" }, "EntityId": { "type": "string" } } }, "WorkHistoryResponse": { "type": "object", "properties": { "ID": { "format": "int32", "type": "integer" }, "ReferencedType": { "enum": [ "NOTHING", "Company", "Contact", "Opportunity", "Position", "Match", "Candidate", "Recruiter", "CandidateApplication", "ScheduledItem", "RecruiterCommissionPlan", "CandidateReference", "Timesheet", "Agreement", "Rate", "Invoice", "Note", "Transaction", "VendorManager", "ClientProject", "ClientProjectMilestone", "Vendor", "VendorContact", "EmailTemplate", "PrintTemplate", "InvoiceTemplate", "SignatureDocumentTemplate", "DocumentSignature", "FolderGroup", "Address", "Department", "CompanyDepartment", "FacilityDepartment", "LegalCase", "Litigation", "MarketingCampaign", "Seed", "HRNetPage", "Communication", "WorkflowAction", "Attachment", "ObjectRequirement", "RequirementDefinition", "Incident", "ScheduledEmail", "Shift", "ShiftCancellation", "WorkHistory", "EducationHistory", "RateGroup", "PositionTemplate", "Division", "DivisionMarket", "TimesheetLineAttribution", "TimesheetLineEntry", "CredentialingRequest", "TimesheetFieldValue", "TimesheetFieldDefinition", "CandidateDirectDeposit", "DirectDepositAccountType", "CandidateStateW4Info", "CandidateTaxUsa", "TimesheetField", "PositionType", "RecruiterDepartment", "ObjectRelationship", "Onboarding", "SavedSearch", "OpportunityType", "VendorProjectsPricing", "CompanyEINMap", "PositionAutoPublishRule", "VMSSyncCompanyMap", "ContactStatus", "CompanyStatus", "PositionStatus", "CandidateStatus", "CustomField", "CandidateApplicationRejectionReason", "InvoiceDetailGridDocument", "NoteAction", "ScheduledItemType", "InvoiceCancelled", "ScheduledItemCategory", "ContactType", "PositionCloseReason", "MatchEndReason", "TagAssignment", "Tag", "CandidateTerminationReason", "ThirdPartyValue", "AdditionalOwner", "ScheduledItemStatus", "PayrollTaxRequest", "SalesTaxThomsonReutersLog", "WorkersCompensation", "CourierMessage", "OnboardingDocumentDefinition", "OnboardingTemplate", "OnboardingDocument", "OnboardingCancellationReason", "CommunicationType", "HelpTip", "FolderGroupStatus", "RequirementRejectionReason", "CandidateRating", "Goal", "CandidateApplicationStatus", "ExceptionLog" ], "type": "string" }, "ReferencedID": { "format": "int64", "type": "integer" }, "CompanyID": { "format": "int32", "type": "integer" }, "Title": { "type": "string" }, "StartDate": { "type": "string" }, "EndDate": { "type": "string" }, "ReasonForLeavingID": { "format": "int32", "type": "integer" }, "CompensationTypeID": { "format": "int32", "type": "integer" }, "Location": { "type": "string" }, "Salary": { "format": "double", "type": "number" }, "Source": { "type": "string" }, "CompanyName": { "type": "string" }, "AboutType": { "type": "string", "readOnly": true }, "_expanded": { "type": "object", "properties": { "Company": { "$ref": "#/components/schemas/CompanyResponse" }, "Type": { "$ref": "#/components/schemas/NamedValue" }, "Reason": { "$ref": "#/components/schemas/NamedValue" }, "Description": { "type": "string" } } } } }, "WorkHistoryRequest": { "type": "object", "properties": { "CompanyID": { "format": "int32", "type": "integer" }, "Title": { "type": "string" }, "StartDate": { "format": "date-time", "type": "string" }, "EndDate": { "format": "date-time", "type": "string" }, "ReasonForLeavingID": { "format": "int32", "type": "integer" }, "CompensationTypeID": { "format": "int32", "type": "integer" }, "Location": { "type": "string" }, "Salary": { "format": "double", "type": "number" }, "Description": { "type": "string" }, "CompanyName": { "type": "string" } } }, "ExceptionModel": { "type": "object", "properties": { "Message": { "type": "string" }, "ExceptionID": { "type": "string" } } } }, "responses": { "400": { "description": "Something is wrong with your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionModel" } } } }, "500": { "description": "Something is wrong with how we processed your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionModel" } } } } } } }